Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Release Prerequisites
Integrations
Minimum Version
ENGAGE
2.8.7.2
NCS Circ
2025.0.0 (If using Variable Pricing)
2020-6.3 (if not using Variable Pricing)
Subscribe Extracts
Australian Clients - Extract Version 6
Other Clients - Extract Version 5
Sync Jobs
3.17.2
Circ Pro
2023-2.0
DSI (Saxo Circ)
NOT SUPPORTED
Naviga Pay (if using Fluid Pay)
2.2
Key Feature - Variable Pricing
The minor release 3.17.2 introduces the Variable Pricing feature to improve the subscription experience in Subscribe for NCS Circ client users. With this feature enabled, a surcharge can be applied when end users select a credit card as their payment method. Unlike processing fees or activation fees, this surcharge will not appear as a separate line item; instead, it will be included in the total amount displayed to the user. For payments made via Bank Draft or Bank Transfer, users will see a lower total amount for the same offer, as these methods exclude the surcharge. Further, as opposed to the Processing Fee which is applied on the final amount, the Variable Pricing levies surcharge only on the base amount, grace amount & tax amount. Hence, the payments like Donations & Tip are excluded from the surcharge calculation. Additionally, in the case of Variable Pricing, the surcharge is fetched via NCS Circ in real-time & clients do not need to set up the calculations in Subscribe.
Additionally, this release provides support for split transactions through Fluid Pay (formerly Impress Pay) via Naviga Pay, allowing to send the surcharge amount explicitly to payment vendor.
The Variable Pricing feature is not available for payments initiated from SubCon Admin.
Currently, the surcharge is not considered for PayPal payment method.
Variable Pricing is not supported for Day Pass subscriptions.
The 'Processing Fee' and 'Variable Pricing' features cannot be used simultaneously. If both features are enabled for a client, the Processing Fee feature takes priority.
Integration with Fluid Pay (Formerly Impress Pay)
Unlike Processing Fee, Variable Pricing feature requires a split transaction process, both in Subscription Panel and Self Serivce, if the payment vendor is Fluid Pay via Naviga Pay.
1. Variable Pricing Implementation in Subscription Panel
Variable Pricing is a feature that allows clients to apply a surcharge (processing fee) for credit card payments without explicitly displaying it. If the payment method involves a credit card, including but not limited to options such as Google Pay, or Apple Pay, the surcharge will be applied. However, if the payment method is a bank account (ACH) or PayPal, no surcharge will be applied.
When Variable Pricing is enabled (through the CMS component and the MG2 control keys), andthe user selects Credit Card as the payment option, the subscription cost displayed will include the surcharge amount. This surcharge amount will not appear as a separate line item in the list of payment details (such as processing fees, activation fees, etc.).
Note: The surcharge amount is fetched from NCS Circ in real time during the workflow.
Subscription cost including surcharge amount for Credit Card payment
Subscription cost without surcharge amount for PayPal or Bank account payment
CMS- New Property 'Cash Discounting Enable'
A new property ‘Cash Discounting Enable’ has been added to the PaymentMethodsV3 component in CMS Presentation. This property can be toggled ON or OFF.
(Select an appropriate Presentation > Page V3 -> Step V3 -> Payment Methods V3)
If the Payment Method V3 component is not included in the CMS Presentation, the Variable Pricing feature will not retrieve the total amount with a surcharge from NCS Circ.
API Key Settings to incorporate Variable Pricing in SP
A new MG2 Control API Setting key DTI.CashDiscounting has been introduced to control the Variable Pricing feature in consumer applications such as Subscription Panel & Self Service. When this feature is enabled,the API considers the CCSurcharge returned by NCS API to be applied in the end user payment.
Cash Discounting Key: When DTI.CashDiscounting is set to 1 (enabled):
If the PaymentType is Bank Transfer, Cash, PayPal, or Electronic Cheque (ACH payment), no surcharge is added to the TotalAmount.
If the PaymentType is Credit Card or other online options (e.g., Google Pay, or ApplePay or any other non ACH payments except PayPal), a surcharge is added to the TotalAmount.
Error Handling: If no Rate amount is found in NCS Circ for the selected offer, an error message “No RateTerms found” will be displayed.
Implementation Notes:
To enable Variable Pricing feature,
Toggle ON the CMS property ‘Cash Discounting Enable’ in the presentation
Set the value of MG2Control API key DTI.CashDiscounting to 1
Set the value MG2Control API key Billing.CreditCard.ProcessingFee.Enable to 0
For an end-to-end flow of Cash Discounting, respective Business Rules must be set up in NCS Circ.
2. Variable Pricing Implementation in Self Service
Variable Pricing in Self-Service is similar to Processing Fee but with key differences in the calculation of amount to be paid and in its display to subscribers.
When this feature is enabled, if the payment is through Credit card, then a credit card processing fee (surcharge) will be deducted from the subscribers only on the base amount of the subscription, due amount, if any, and taxes, but it will not include Donation and Tip amounts. The surcharge will not be explicitly displayed to the subscriber, and it will be embedded in the Total amount. The surcharge is not applicable to ACH payments such as Bank Draft or transfer (that do not involve a credit card).
When users select ACH mode of payment, they see a lower price applicable to the transaction while making a One-time payment, Autopay signup, or Restart where the ACH payment has a lesser amount compared to the respective Credit Card payment option as below:
Rate Display: When Variable Pricing is enabled, a new "ACH Amount" column appears in the Rate Term grid, displaying discounted rates for ACH payments in all payment pages.
Payment Options:
Credit Card Payment: The CC surcharge (processing fee) is received from NCS, added to the total amount and is displayed, which is then sent to NCS in the API request and further processed by NCS. The CC Surcharge is also applicable to grace amounts in restart flows (if there is a negative previous balance).
ACH Payment: The surcharge is excluded in the total, and the API request is processed without the surcharge.
When Variable Pricing is not enabled, in a regular flow (one-time payment, Autopay signup, or Restart), if a negative balance is returned from NCS, it is added to the current transaction. However, when Variable Pricing is enabled, the negative balance is considered only in the Restart flow for a stopped subscription. In this case, a grace amount (negative balance) surcharge is applied when the payment is made using a credit card.
Defining API responses to incorporate Variable Pricing in Self Service
Self-Service has three payment flows:
One-time payment
Autopay Signup
Restart
The endpoint that returns the Billing options to display them in Self-service for all these payment flows is the endpoint Billing/AutoBill/{subscriptionId} of Billing API.
A new key “SurchargeType“ has been added to this endpoint that acts as a flag or an identifier to differentiate between the Processing fee flow and Variable pricing flow. The SurchargeType will have the value “PF” for Processing Fee flow and “CD” for Variable Pricing flow.
A new parameter “AmountExcludingSurcharge“ has been added in the BillingOptions that holds the value of the Amount excluding surcharge.
If the SurchargeType is "PF", then the flow is Processing fee flow and the AmountExcludingSurcharge will return the value 0 from NCS Circ.
New Parameter in Billing API
In the Billing API (Billing/AutoBill/{SubscriptionId}), a new parameter, CCSurcharge, has been added to the BillingOptions object in the API response.
Regardless of the values in the API setting keys for CashDiscount or ProcessingFee (enabled or disabled), the CCSurcharge parameter will always be included in the Billing API response.
New object added in the DTI API response to support Restart payment flow
The value of GraceCCSurcharge has been added to the request parameter CreditCardCircChargeAmount in Billing option endpoint.
A new object “GraceOwedInfo” has been added in the responses from the below DTI Micro API endpoints.
The new object "GraceOwedInfo" contains parameters such as GraceAmount, GraceTax,GraceTotal, CCSurcharge, etc. and these are available in the Restart flow of stopped subscriptions with a negative balance.
If the stopped subscription has a zero balance, then the “GraceOwedInfo” object will contain null values in the response. For active or in-grace subscriptions, NCS does not send Grace details, so GraceOwedInfo section will not be present in the response.
In case of Restart for PAYMENTCC event (Payment/Circ endpoint) the request parameter CreditCardCircChargeAmount will consist of CCSurcharge value and GraceCCSurcharge value.
In case of Autopay signup or One-time payment, for PAYMENTCC event (Payment/Circ endpoint) the request parameter CreditCardCircChargeAmount will consist of the CCSurcharge value.
Implementation Notes:
Enable the ACH amount on respective CMS content pages:
Set the value of Billing.CreditCard.ProcessingFee.Enable to 0
3. Split Transactions for Fluid Pay via Naviga Pay
When the Variable pricing feature is enabled, if the payment vendor is Fluid Pay (formerly Impress Pay) via NavigaPay, the API sends split payment transaction details (SplitAmount and AdjustmentAmount) in the request of AUTHCC event along with other parameters.
SplitAmount → Tip+Donation, if any
AdjustmentAmount →
CCSurcharge (if payment is through Credit card)
CCSurcharge+GraceCCSurcharge (if payment is through Credit card for Restart with a negative balance (debt))
Whenever Credit card surcharge is applied on the entire Total Amount (base amount + due amount if any + Donation + Tip), the usual practice is that the API sends the full value to payment gateways. However, if Variable Pricing is enabled, then the CCSurcharge is applied only on the Base amount and pending amount if any, and a split transaction along with transaction amount is sent to the payment gateway Fluid Pay via Naviga Pay. Here, the split amount represents the portion of the payment not subject to surcharge.
When SplitAmount and AdjustmentAmount are submitted to NavigaPay Fluid Pay API, the response will return SplitTransactionId, AdjustmentAmount and SplitAmount.
If SplitAmount is 0 or null in the request, then SplitTransactionId will be absent in the API response.
A new field, SplitAmount, has been added to the API request body. This field is passed along with requests for AUTHCC and CCFUNDCAPTURE events to manage split payments under different conditions:
Case 1: Fluid Pay Vendor Setup
When Fluid Pay is the payment vendor, both SplitAmount and AdjustmentAmount (representing CCSurcharge when Variable Pricing is enabled) are included in the request.
Upon successful submission of SplitAmount, a SplitTransactionId is returned in the event response.
Case 2: Other Vendors Setup
For other vendors, neither SplitAmount nor AdjustmentAmount affects the functionality of AUTHCC (Authorization) or CCFUNDCAPTURE (Capture) events, if these fields are omitted.
Note: Currently, Tip and Donation amounts are not applicable in new start flows. Thus, no specific split amount will be present (value passed will be 0), though SplitAmount and AdjustmentAmount parameters are included in the request body.
Submission of Fluid Pay Split transactions to Naviga Pay
When Variable pricing is enabled, once any payment request is submitted, Naviga Pay now returns two transaction IDs: one for the transaction amount (amount excluding the split amount → CCSurcharge+Amount on which CC Surcharge was applied) and the other for split amount. Two separate CCFUNDCAPTURE events will also be generated.
If the payment involves only a Donation amount while user opting for Autopay or if the user paying only a Tip amount (transaction amount is zero in these cases), then a single CCFUNDCAPTURE event will be triggered after the AUTHCC event.
When Variable Pricing is enabled for other payment vendors except Fluid Pay, the transaction amount sent to Naviga Pay for processing includes CCSurcharge + Amount on which surcharge applied + Split Amount. A single CCFUNDCAPTURE event will be generated in this case.
Bug Fix
Donation not included in calculating Processing fee
When the Processing fee feature was enabled, the Donation amount was not considered in calculating the processing fee for the payment done with credit card during Auto pay signup. This issue has been resolved.
For more details about the Variable Pricing payment feature, please refer to the Variable Pricing documentation: .
For details about the Credit card surcharge feature within NCS Circ, please refer to NCS documentation:.
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Welcome to the public documentation platform for Subscribe – a flexible customer engagement and retention solution for media clients!
If you are looking for something in particular, try out our search function in the top right corner. Otherwise, check out the sections we have below
Naviga applications
Within Naviga Subscribe one can find the following client-facing applications:
Solicitor Concierge - an application designed to help you create Offer Groups, sell your Offer Groups, and manage the users who have access to them
One CSR Portal - an application for Customer Service Representatives to manage subscriber accounts and registrations
Landing application - an application that provides easier access to all the client-facing applications from one page
Content Management System or CMS - application to manage content, look and feel of Subscription Panel and Subscriber Concierge site
The following applications are also part of Subscribe, but they are designed for the end-users:
Subscription Panel - an end-user-facing application that allows to view offers and then make a subscription purchase
Subscriber Concierge Site also referred to as Self-Service or Account Management - end-user website that allows subscribers to manage their accounts and subscriptions
Naviga APIs
Subscribe APIs are publicly exposed so clients can utilise them and build their own integrations and front-end solutions based on Subscribe APIs. To get access to API documentation please get in touch with your Project Manager or Naviga Support team.
Circulation systems
Subscribe has integration with several circulation systems like the Newscycle Circulation system of NCS, Matrix, CirculationPro etc.
Some features are supported only for specific circulation systems; some of them are available for all circulation systems or do not depend on the circulation system at all. You can find the required information in the prerequisites of the feature description or in the Release notes.
For a general overview of Naviga pillars and products, please check the introduction video in the section.
To jump straight to the application guides, please check the .
Please check the to find info about the specific feature, its prerequisites, setup and flow.
To find out about the latest releases and the features delivered, please check the section.
Newscycle Circulation system a.k.a. NCS Circ is also a part of Naviga. They are currently working to make their documentation public. You can find their Release Notes . Also, you can find information about in the relevant section.
This page has high-level Release notes for the major 3.17.0 Release
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
IMPORTANT!!
Clients are also requested to validate their OI & Discover loads to avoid any issues following schema changes in the database.
With the 3.17.0 version, Subscribe has been integrated with Naviga Pay, making it easier to add additional payment gateways in the future. In addition, when payment is made with a credit card, the surcharge amounts can now be included. The Active Subscription Check approach has now been enhanced by including more parameters under a new section, Search Criteria. For Matrix clients, Country-Only Starts are now supported, and it is also possible to Restart a subscription at a future date.
This release also comprises a variety of enhancements to the SubCon Site (Self-service), One-CSR Portal, Solicitor Concierge (SolCon), CMS Content, and Subscription Panel modules and introduces a set of new APIs.
Additionally, this release also contains important bug fixes in various modules of the application.
This release has an issue with the Tax amount in the Subscription Panel when a user switches from one payment method to the other, such as from Credit Card to Bank Draft. The fix is part of 3.17.0.3.
Note added on 13 Sep 2024.
Release Prerequisites
Integrations
Minimum Version
ENGAGE
2.8.7
NCS Circ
2020-5.0
Subscribe Extracts
Australian Clients - Extract Version 6
Other Clients - Extract Version 5
Sync Jobs
3.17.0
Matrix Circ
38.00.034.ITSP9
Circ Pro
2023-2.0
DSI (Saxo Circ)
NOT SUPPORTED
Naviga Pay
2.2
This version does not support the DSI (Saxo) Circ System.
Key Features
1. Naviga Pay Integration
From this release, Subscribe has integrated with NavigaPay. NavigaPay is a payments orchestration software which provides a unified software layer (payment orchestration layer) that integrates and manages payments across multiple payment service providers. The Subscribe integration with NavigaPay allows for unified management across multiple payment service providers, ensuring reliability and convenience for Subscribe customers. With the introduction of this new feature, the additional development effort required whenever a new payment vendor has to be integrated with Subscribe will be very minimum.
In this release, Subscribe has successfully integrated with the payment vendor Payway (Edgil) through NavigaPay, where NavigaPay serves as a centralized API layer.
Payway (Edgil) is integrated for One-CSR Portal, Self-Service Portal and Subscription Panel.
Only Credit Card (CC) Integration is supported for Payway via NavigaPay. Currently, Bank Draft (ACH) is not supported via NavigaPay. However, the existing Bank Draft feature through flat files via Circulation systems will continue to work as is.
1.1 General Workflow:
A user can initiate various payments (Restart, One-time payment, Auto-renew (EZpay), or Add Tip) using a Credit card through NavigaPay. Once the user clicks ‘Make a payment’ button, the payment page is loaded.
During the loading of the Payment page, the Subscribe API sends a request called StartPaymentSession to NavigaPay. The payload of this call varies depending on the consumer application. Usually the payload of this call from Self-Service Portal includes SubscriptionId, CustomerRegistrationId, PaymentType, etc. whereas the payload from One-CSR Portal includes SubscriberId, SubscriptionId, PaymentType, AccountNumber, etc.
NavigaPay sends IFrameUrl of the payment provider in response.
Self-Service Portal, One-CSR Portal or Subscription Panel (as applicable) then renders the secure URL received from the StartPaymentSessionresponse within an iFrame of the payment provider. This page will be a hosted page.
The user enters their credit card details on the hosted page (including all sensitive information) and clicks the Submit or the equivalent button as the case may be.
The NavigaPay server then returns the details such as ProfileId (the token), GroupId, and PaymentType with other details to the consumer application (One-CSR Portal, Subscription Panel, or Self-Service Portal). The token received is the authenticated approval token from the payment provider that officially allows the payment transaction with the payment provider. This is called Tokenizing credit card.
Upon receiving the token, consumer application initiates the API request called EndPaymentSession. The payload of this call includes ProfileId, GroupId, PaymentType along with other consumer application-specific data.
1.2 API - NavigaPay
A new endpoint, POST /Authorization, has been developed for creating an authorization request based on the input parameters ProfileId (User ID associated with the transaction), TransactionAmount (amount of the transaction, which should be greater than zero), and PaymentType (type of payment: Credit Card, Bank Account, etc.).
A new endpoint, POST /Capture, has been developed to capture a payment transaction based on the input parameters TransactionID (the transaction ID obtained in the authorization request) and the PaymentType.
A new endpoint, POST /Sale, has been developed for creating a sale transaction, which involves creating an authorization request and capturing the payment transaction based on the input parameters ProfileId, TransactionAmount, and PaymentType.
A new endpoint, GET /Profile, has been developed for retrieving a user's profile details as well as payment information based on the input parameters ProfileId, GroupId (Optional, Group ID of the User associated with the transaction), and PaymentType.
A new endpoint, POST /Session/Start, has been developed to initiate a new session based on the iFrame URL configuration.
A new endpoint, POST /Session/End, has been developed to terminate a session following the verification of the provided input parameters ProfileId, GroupId, and PaymentType.
The NavigaPay API has now been successfully integrated with all the payment gateway-related operations, such as Single payments, New starts, EZPay, Restarts, and Tip, allowing NavigaPay to be utilized as a payment gateway.
Authorization and sale transactions processed using NavigaPay will now send the value defined in the MG2 Control API Internal setting "NavigaPay.StatementDescriptor" in the StatementDescriptor field.
A new MG2 control internal setting, NavigaPay.StatementDescriptor, has been introduced for setting the description of charges or payments that should be displayed on bank statements.
Payway Integration - CMS Configurations
The users can configure the properties for SP Newstarts by going to:
"The 'ErrorOnLoadMessage' property has been removed from the 'NavigaPay Payway V3' component. Although this property is available in the standard Payway integration, it was not included in the Payway NavigaPay component due to its lack of support by NavigaPay. that context. Consequently, the property has been removed from the 'NavigaPay Payway V3' component."
Implementation Notes:
2. Credit Card Processing Fee
Starting from this release, there is a requirement of the integration of credit card processing fee to the payment details, if the payment method selected is credit card. To suffice this, Payment page has been revamped to be a wizard presentation. The new payment wizard can submit all the payment variables in a single iFrame as required. The new payment wizard first collects all payment details and then completes the payment process in three different steps as follows:
Gathering information step
Showing payment details step
Final printable payment summary step.
2.1 Integration of Credit Card Processing Fee
Starting from this release, NCS clients will be able to charge a processing fee over the total amount if the customer makes payment through Credit Card. For other mode of payments, the processing fee is not applicable. The charging of processing fee can be set on or off using the MG2 Control Api setting key Billing.CreditCard.ProcessingFee.Enable.
In this release (Phase 1), if the MG2 control key is enabled, the credit card processing fee will be applicable as follows:
New starts via Subscription Panel
One-time payments
EZpay payments
Restarts via Self-Service Portal
Additionally, it will be possible to define the percentage of processing fee that can be applied on the overall amount using the MG2 control Api key Billing.CreditCard.ProcessingFee.Percentage when a user is transacting via Credit Card.
A tax on processing fee has also been introduced in this release and it will be configurable via MG2 Control Api key Billing.CreditCard.ProcessingFee.Tax.Enable. The percentage value of the tax will also be configurable via MG2 Control Api key Billing.CreditCard.ProcessingFee.Tax.Percentage.
The tax on Processing fee has been implemented from a future perspective. NCS does not support Tax on processing fee as of now.
If the processing fee is enabled via MG2Control for a client, it will be applicable to all offers of the client if the customer chooses to pay via Credit Card.
The processing fee will be calculated on the total amount a customer has to pay (rate + tax i.e. including taxing and any other applicable fee, tip, etc). On top of it, if tax on processing fee is also applicable, it should be calculated on the processing fee.
Credit card processing fee notifications to the user
When a customer selects credit card option for payment, they will be informed with a message on Self-Service Portal below the payment summary, about the processing fee being charged because of their selected payment method. Two CMS contents ProcessingFee.OneTime.Message and ProcessingFee.Recurring.Message have been introduced where the information messages can be configured for one time and recurring payments.
2.2 SS Payment Flows
One-time payment in SS:
In the first step (gathering information step), select a payment option with Term and Amount. Choose the option of leaving a tip and making a donation, opt or not for EZpay, and also select the payment method from Credit card and Bank account options.
In the next step, all payment details will be displayed, including credit card processing fee (if applicable for the client). Payment method details (Credit card details or Account details) will also be collected.
In the final step, the wizard displays the printable payment summary. In One-time payment, the Processing fee notification to the user set up in ProcessingFee.OneTime.Message will be displayed only if Processing Fee > 0.
Restarts in SS:
For Restart payment (on Restart page), the restart date is also collected in step1 along with other details (Payment option, Tip, Donation, & Payment method type). In this flow, step 2 (displaying payment details) can be skipped if the user has nothing to pay. In such cases, if the subscription has a credit balance, it will be deducted from Total resulting in TotalAmount to be paid as 0, indicating nothing to pay. In step 3, the user will be displayed a printable payment details summary including processing fee if the payment method is credit card.
During Restarts, the notification message set up in the ProcessingFee.OneTime.Message will be displayed only if Processing Fee > 0. The ProcessingFee.Recurring.Message will be displayed if the selected Payment Option forces EZPay Sign Up.
EZPay Sign Up:
For EZPay payment (on AutoPay SignUp page) the Processing fee will be calculated only if the subscription has an Outstanding Balance (the subscription has a debt to be paid) and the payment is done through credit card. The processing fee will be calculated over the outstanding balance. In Step 1, AutoPayOption, Tip, Donation, Terms and Conditions, and Payment method type will be collected from the user. The Processing fee and Processing fee tax (if applicable) will be calculated and displayed in Step 2. The final printable payment details including processing fee (if any) will be displayed in step3.
Note that if there is no outstanding balance, processing fee will not be considered for EZPay sign up workflow.
During EZPay sign up, the notification message set up in ProcessingFee.Recurring.Message will be displayed always. The ProcessingFee.OneTime.Message will be displayed only if Processing Fee > 0.
Tip Payments:
For Tips payment (on AddTip page) the Processing fee will be calculated over the Tip amount being paid (only for one-time Tip with Non-EZPay payment) through credit card. In step1, the Tip amount is collected along with the payment method type. If it is credit card, then in the second step, Processing fee and the tax (if any) will also be displayed along with the payment method details. If the payment is recurring (EZpay checkbox is checked), this second step will be skipped. then in the final step, all the payment summary will be displayed including processing fee. If the Tip payment is just one time, then the ProcessingFee.OneTime.Message will be visible only if Processing Fee > 0. If the Tip payment is recurring, then the ProcessingFee.Recurring.Message will be displayed.
During any payment flows, a user can navigate from one step to the next step by clicking the Next or Ok, and to the previous step by clicking Back buttons displayed in the wizard.
Implementation Notes:
New CMS contents Step.Next, Step.Back, ProcessingFeeAmount.LabelText, ProcessingFeeTaxAmount.LabelText, PaymentMethod.CreditCardText, PaymentMethod.BankAccountText, AddTip.TotalAmountText, SelectOptionStep.Title, SelectOptionStep.Description, PaymentInfoStep.Title, PaymentInfoStep.Description, ConfirmStep.Title, ConfirmStep.Description have been created.
New CMS contents ProcessingFee.Recurring.Message and ProcessingFee.OneTime.Message have been introduced for Payment, AutoPaySignUp, SubscriptionRestart and AddTip payement workflows.
Subcon.Configuration: "DisplayPayButton" property has been removed from Payment page. “RenewalOptionsSection” is also deprecated. Both were under the SubcriptionRestart module.
2.3 Subscription Panel Payment Flows
If the processing fee property has been enabled in CMS, SP will now pass on the processing fee amount received from the Subscriptions API, CalculateSubscriptionCost, along with the amount charged, to the Purchase microAPI applicable for the credit card payment method.
The Input Box properties, "Disclaimer.Message" and "Disclaimer.Show", have now been included in the User Information V3 and Payment Methods V3 components.
If the "Disclaimer.Show" property is enabled (set to ON) in CMS, the Disclaimer Message will be displayed on the applicable sections of the Subscription Panel page based on the value defined against the "Disclaimer.Message" property. If the property has been set to OFF, the disclaimer message will not be displayed.
In addition, the disclaimer message, if turned ON, will only be displayed on the payment method screen if the selected payment method is a Credit Card.
This functionality is applicable for Seamless flow as well.
Two new properties, "CreditCard ProcessingFee Show" and "CreditCard ProcessingFee Title," have been added to the StickyNoteV3 and StepV3 components.
If the "CreditCard ProcessingFee Show" feature in CMS has been enabled (set to ON), the Processing Fee will be displayed on the Subscription Panel page when the payment method selected is credit card. The CreditCard ProcessingFee Title property allows users to change the title of the processing fee that appears on the Subscription Panel page. The processing fee will not be displayed if the property has been set to OFF.
In addition, if the ProcessingFee property has been set to ON, it will only be displayed on the payment page if the payment method selected is a Credit Card.
The processing fee for a payment will be calculated using the Billing API, CalculateProcessingFee, and the total payment amount, including the processing fees for the chosen offer and product, will be calculated using the Subscriptions API, CalculateSubscriptionCost.
Note:
If the user wants the processing fee, the "processingFee" property in CMS must be enabled in all StepV3 and StickyNoteV3 components.
If the processing fee is not required, the "processingFee" property should be disabled in CMS for all StepV3 and StickyNoteV3 components to ensure consistency across all of the steps.
Implementation Notes:
In CMS, the Processing Fee property should be set to either ON or OFF.
The user can configure the properties by going to:
The credit card processing fee/tax on processing fee can be explicitly displayed in email payment receipts to the customer.
To achieve this functionality, the fee has to be configured as a parameter (SurchargeAmount) in the Credit Card Payment event type email. (The SurchargeAmount is a column from the Event_log table.)
How to configure the Credit Card Payment event type email?
When a payment is done via Credit Card with Processing Fee settings enabled and the receipt mail successfully configured, the processing fee amount will be reflected in the payment receipt email as shown below:
Note: For Subscription Panel New start, the SurchargeAmount (processing fee) will be captured with event_type_id 3. For transactions conducted through SubConSite, the event_type_id will be 30.
2.5 API Dependencies
Clients have the option to enable the addition of a surcharge or additional fees when a subscriber pays with a credit card, based on the value defined in the MG2 control settings. The Billing API now includes a new endpoint, POST /Billing/CreditCards/ProcessingFee, for calculating the processing fees that will be charged to the user based on the payment amount for a credit card transaction.
The Purchase API endpoint, POST /Purchases, has been modified to add two new input parameters, ProcessingFeeAmount and ProcessingFeeTaxAmount, which allow the credit card surcharge amount to be passed on to the NCS Circ system.
The POST /Payment, POST /Payment/Restart, and POST /Payment/Tip endpoints have been modified to add two new input parameters, ProcessingFeeAmount and ProcessingFeeTaxAmount, to send the surcharge amounts to the NCS Circ.
The surcharge amounts are only applicable for the Payment Type of Credit Card; providing any value for this for any other Payment Type will result in an error.
The POST /Subscriptions/Cost endpoint has been modified as follows:
A new input parameter, PaymentTypeId, has been added to represent the Solcon Payment Type. (1 - CreditCard, 2 - BankAccount, 3 - Cash, 4 - Check, etc.)
If processing fees are applicable or have been enabled in the settings for a credit card payment method type, the output parameters ProcessingFeeAmount and ProcessingFeeTaxAmount will now be included in the response.
If an activation fee has been setup for an offer, the activation fee output parameter will always be included in the response, regardless of the PaymentTypeId in the request.
Implementation Notes:
Four new internal MG2 control settings for calculating processing fees have been introduced.
Billing.CreditCard.ProcessingFee.Enable - Enable (1) or disable (0) the addition of processing fees.
Billing.CreditCard.ProcessingFee.Percentage - The percentage of the transaction amount that will be applied as the processing fee. For example, the client should set the value to "10" for 10% and "10.5" for 10.5%.
Billing.CreditCard.ProcessingFee.Tax.Enable -Enable (1) or disable (0) whether tax should be applied.
Billing.CreditCard.ProcessingFee.Tax.Percentage -Tax percentage to be applied.
Pre-Requisites:
Circ System & Minimum Supported Version: NCS Circ, 2018
3. Country-Only Starts in Matrix
Previously, Subscribe allowed users to create a subscription by validating their addresses using three different options: either providing their delivery address, their billing address, or just entering their zip code. Recently, Subscribe has been updated to allow the creation of digital subscriptions for Matrix clients, with just the Country field as the minimum address requirement.
The Purchase API has been updated to enable Matrix clients to purchase subscriptions by only providing the Country as the address information. In the Matrix ADDADDRESS event, if just the Country has been entered as the address, the Address will have the House number as Null (0), the Country Code will remain as the provided Country Code, and the Street Name will be Country Name.
Note:
Country-only Starts flow for Matrix will also work on Seamless flow.
If a country-only address has been provided for a non-Matrix client, a validation error will be returned, but the flow will continue to be executed for Matrix clients.
Implementation Notes:
The user can configure the property by going to:
CMS > Subscription Panel > Presentation > Choose a valid presentation
To display the Country drop-down in the country-only start flow for Matrix, set the ‘IsInternational’ property in the Presentation Properties V3 component to ON.
In Country only start flow for Matrix, properties related to Country should be ON in Billing component ('AddressLine Show', 'SecondAddressLine Show', 'Zipcode Show', 'State Show', 'PhoneNumber Show', etc. should be kept OFF).
In BillingInformationV3, the below properties should be enabled for country-only start flow for Matrix:
Country.OptionalNextToPlaceholder
Country.OptionalNextToTitle
Country.Placeholder
Country.Show
Country.Title
Country.ValidateOnFocusLost
Country.Validation.Required.Apply
Country.Validation.Required.Message
The following properties in IndependentAddressV3 should be enabled for country-only start flow for Matrix. If these properties do not exist, they must be added using the Management tool script; otherwise, they will break during the environment upgrade.
Country.Placeholder
Country.Show
Country.Title
Prerequisites:
The country-only rule must be set appropriately in the Matrix system for each country where country-only starts are allowed.Currently, the list of countries displayed in SP is not governed by the Matrix Country-Only rule. As a result of this limitation, if the country-only rule has not been enabled for any country in Matrix and the same country has been included in the list of countries displayed in SP, then the subscription will result in an error while it is being processed on the Matrix side, but no error occurs on the SP side during the purchase process.
Circ System & Minimum Supported Version: Matrix, 38.00.034.ITSP6
4. Scheduled Restarts for Matrix clients
Starting from this release it is possible for Matrix clients to select a restart date in the future for restarting a subscription. Previously whenever an eligible user opts for restarting a stopped subscription, Subscribe MicroAPI used to default restarting date to the current date in the client’s time zone. However, with this new enhancement, it is now possible for a user to opt for a future date as well as the current date for restarting the subscription. The user will not be permitted to select a restart date lesser than the current date in this flow.
Note:
The Matrix system may fail to restart a subscription if a certain address is part of more than one delivery route.
When a Matrix user completes the payment for a stopped subscription that is intended to be restarted on a future date, the status of the subscription changes from ‘Stopped’ to ‘Active’ immediately.
This was mainly due to differences in the behavior and functionality of One-CSR Portal compared to the processing system, Matrix. According to Matrix settings, even if the subscription status changes to 'Active' immediately, the subscription will ideally start for the user only on the selected date.
5. New UI changes for Active Sub Check
In Subscribe, whenever a new subscription is created, an Active Subscription Check is performed at the backend if at least oneD of the flags (No existing subscription, subscription stopped recently, No outstanding balance) is set under Subscription Validation section in SolCon. If any of the flag is set, then a new subscription can only be created if the Active Subscription Check is passed. When performing an active subscription check using the PurchaseAPI, the API currently depends on the SolCon Offer flags for Delivery Address and Billing Address (under Address Requirements). If at least one of those flags is turned on, then the API executes the full address Active Sub Check (PakHash, LastName, Phone and Product). Otherwise, it executes the Zip Only Active Sub Check (ZipCode, LastName, Phone, Email and Product).
This approach has now been updated from this release. A new section called Search criteria has been introduced in SolCon (Offer Groups > Additional Options) with some additional flag fields. New validation checks have been implemented in the existing Active sub check to not to depend on just two Address fields, but also include the flags (under Search Criteria) as stated below.
Last Name
Phone
Email
Address
Zipcode
The users can select which flags are to be used for the Active sub check.
Note:
Since the product is always included in the search and cannot be excluded from the search criteria, it isn't displayed in the UI.
The 'Search Criteria' section will be displayed only if any of the checkboxes in the 'Subscription Validation' section are checked (one, or two in any combinations or all three))
If an Offer is not correctly set up in SolCon, the Purchase endpoint will now return a validation error. The following validation checks will be performed:
At least one of the Search Criteria flags must be enabled. If none of the search flags is enabled, then another validation message will be displayed “Please select at least one search parameter”.
Selecting Last Name alone or Zip Code alone is insufficient; any other flag also must also be enabled.
If the user selects either Last Name or Zip Code only, then a validation error message will be displayed, “Please select one more search parameter”.
Zip Code and Address cannot be enabled simultaneously.
If any single Address flag under Address requirements section is checked, then by default, the Address flag under Search Criteria will be enabled. If both Address flags are unchecked, then the Zip Code flag under Search Criteria will be enabled automatically making the Address flag disabled.
If any checkboxes were checked before they became disabled then they are considered as unchecked.
If the Phone is not available at a subscription level, we skip this check
If an existing Subscription with the same characteristics has been found in the database, the purchase endpoint will return a validation error and the purchase will not happen. For example, if the Offer has been set to check Last Name and Email and there already exists a Subscription for John Doe (email: john.doe@gmail.com), another Newstart with the same data will be rejected.
Implementation Notes:
After upgrading to V3.17.0, scripts must be executed to apply the standard Active Subscription Check logic to existing client offers. These scripts will update offers created before the upgrade to include the default search criteria. However, the search criterion "Phone" is exempted from these validations.
6. Adding Tip for non-EZPay Subscriptions
With this release, NCS subscribers with non-EZpay subscriptions can now pay a Tip to the publisher. If the subscription is non-EZPay, the checkbox “I want to leave a recurring tip” will be hidden from the user.
Initially, the Add Tip page was designed exclusively for EZPay subscriptions. However, starting from this release, non-EZPay subscriptions can also process a non-recurrent Tip.
Validation checks have been implemented in the Add Tip Availability API (GET /Billing/{subscriptionId}/AddTipAvailability) to allow only EZPay subscribers to add a Recurrent Tip; however, no checks will be performed for One-time tips. One-time tips will not be acceptable for digital or stopped subscriptions, but will be allowed for Paused and In-Grace subscriptions. For subscriptions without EZPay, the recurring tip is not allowed.
7. Configurable Credit Balance Usage
With the introduction of an MG2 Control API setting key Restart.ApplyCreditBalance (with a default value 0), credit balance adjustments have become configurable for both Self-Service Portal and One-CSR Portal from this release. If the setting is turned on and the subscription has a credit balance (user owes money from the publisher), that balance will be displayed in UI and will be deducted from the TotalAmount to be paid. If the setting is turned off and the subscription has a Credit balance, that balance will NOT be displayed in the UI and the total amount remains the same without any deduction. If the subscription has no balance, or has negative balance (customer owes money to publisher), the debt will be paid in the Restart payment transaction.
While submitting payment request during Restart flow, a new API key Restart.ApplyCreditBalance will be considered in the TotalAmount calculation logic as follows:
If the setting is turned on and the subscription has a Credit balance (positive amount), that balance will be deducted from the TotalAmount.
If the setting is turned off, the Credit balance will not be considered in TotalAmount calculation.
Regardless of the value in the setting key Restart.ApplyCreditBalance, if the customer has a negative balance (i.e if they need to pay the company), the balance amount will be considered for TotalAmount calculation. The balance will be added to the TotalAmount to be paid.
If the total amount to restart a subscription (Restart+Tip+Donation) is less than or equal to available credit balance, then One-CSR Portal will allow a CSR/user to submit the restart request without payment.
In this special case, the payment iFrame will be hidden and other payment buttons such as Pay with credit card (or Bank Account) will be disabled. Only the action buttons Submit Restart and Cancel will be enabled. On clicking Submit Restart, the restart request will be submitted to microAPI and ultimately to the corresponding circulation system. On clicking Cancel, the current transaction will be cancelled as it is now. This special case works only if the MG2 setting Restart.ApplyCreditBalance is turned on.
If a subscription with a positive credit balance has been Permanently Stopped, the remaining balance will either be donated or refunded, and the subscriber has to pay the full amount when restarting the subscription.
This is applicable to NCS and Matrix clients as of now.
Implementation Notes:
New MG2 Control setting key Restart.ApplyCreditBalance has been introduced with default value 0 (FALSE).
8. Enhancements on Household Level Page
8.1 HHL in One-CSR Portal
A new menu option, Household Level (HHL), and a corresponding page, have been introduced in One-CSR Portal to facilitate the management of various Household levels for clients. With this enhancement, CSR Admin/users can now edit the description of a Household level, providing a meaningful explanation to each Household level.
This new page is accessible under the Client Management menu option in the sidebar. The enhancement aims to assist clients in understanding the meaning of each HHL through its Description. Moreover, users have the flexibility to edit the description for added clarity. The description feature has been incorporated in all instances where clients are prompted to select an HHL or where an HHL is displayed, enhancing its significance. Examples include the Subscription search screen, Entitlements screen, etc.
You can filter and search for existing Household levels using either the 'Description' or 'Household level' by selecting the appropriate option in the 'Filter by' drop-down. If you're filtering by 'Description,' enter any word in the 'Contains' field and click 'Search' to list all Household levels with that word in their description. If you're filtering by 'Household level,' enter a numeral in the 'Contains' field and click 'Search' to list all Household levels in the Search result grid that contain the entered numeral in their ID.
A ‘Show only active’ checkbox is also available to further refine the search results.
You can edit the Description of any Household level by clicking the 'Edit' button next to the Household level displayed in the search result grid. The maximum allowed character limit for a description is 50.
Household level description will be now available wherever Household level is displayed in the application.
For example, in One-CSR Portal:
1. Account information tab of the user (Subscription Information > Subscription search > Enter search criteria > Search > Start call)
2. Entitlement details screen (Client management > Entitlements > Entitlement details > Edit > Access section)
If a Household level has no description, the description field of the corresponding HH level will be blank.
In cases where the HH level description is displayed in a drop-down and the description is truncated, the full description will be available in a tooltip when you hover the mouse over it. Also, in a drop-down the description will now be available in the format “HHL ID - Description”.
8.2 HHL in SolCon
With the new enhancement, the HHL description from One-CSR Portal will now be available at the following pages in SL:
Edit Offer group page (Offer Groups > Select an offer > Coding)
Edit Offer page (Offer > Select an offer > Coding)
Changes made to a Household level in One-CSR Portal are immediately reflected in the database. However, these changes will appear in SolCon (in the above mentioned instances) only after the successful completion of the synchronization job. Thus, the HHLs in One-CSR Portal will be available in SL while creating offer groups too.
Implementation Notes:
New claim has been introduced, ‘SA_NewspaperManagement_HouseHoldLevel’ in mg2_control database.
A new row ‘Household level’ has been added to the table adm_main_menu_v2 table in Subsvc database.
8.3 API - Entitlements
The HouseHoldLevels table schema has been updated to include a new property, Description, for the household levels.
HHSubscriptionLevel is HouseHoldLevelId
The HouseHoldLevels table schema previously included HouseHoldLevelId, HouseHoldLevel, Active, and Audit fields. The HouseHoldLevelId and HouseHoldLevel have now been merged into a single column, and a new column, Description, has been added, so that the HouseHoldLevels table schema now has HouseHoldLevelId, Description, Active, and Audit fields.
The Entitlements API endpoints GET /HouseHoldLevels/{houseHoldLevelId} and GET /HouseHoldLevels have now been modified to display the new property, Description, for the respective Household-Level Identifiers in the API response.
Implementation Notes:
The Description should be included while setting up the HouseHoldLevels.
Modified endpoints:
GET /HouseHoldLevels/{houseHoldLevelId}
GET /HouseHoldLevels
8.4 Household Level Removable from One-CSR Portal UI
Prior to this release it was not possible to remove a Household level entry from the Access section of the Entitlement details page. Starting from this release a Delete button has been introduced against each Access level entry for all clients.
Clicking the Delete button will prompt a confirmation message with OK and Cancel options. If you select OK and then hit Save button at the bottom of the page, the deletion process will be completed. Selecting Cancel option will cancel the deletion process.
If you attempt to delete the last Access level record from the Access section, the system will display a warning message stating, ‘At least one record is required in Access levels’.
8.5 Database changes for Sync jobs
The DB changes to implement HHL management are as follows:
Changes in HouseHoldLevels table: HouseHoldLevel column is deprecated, Description column added.
Change in Subscription table: hhSubscriptionLevel renamed to HouseHoldLevelId
9. eBill Availability
A new endpoint eBill availability has been created that executes all the conditions to check whether a subscription is eligible for eBilling. A subscription will be eligible for eBilling if it is not stopped, and it is not on EZPay. As an output model, 2 flag values will be returned to indicate if the user can sign up (SignUpAllowed) or manage eBilling (ManageAllowed). In case the subscription is Stopped or if it is on EZPay, validation errors will be displayed to the user.
If a subscription is already on eBill, the flag value of SignUpAllowed will be false and ManageAllowed will be true. If the subscription is NOT on eBill, the flag value of SignUpAllowed will be true and ManageAllowed will be false.
Self-Service Portal will start using the eBill availability endpoint from this release to evaluate whether a subscription is eligible for eBilling and has enough rights to access the corresponding eBilling page (eBill Sign up page or eBill Manage page).
If a user tries to access the EBillManage page, and not subscribed to EBill (ManageAllowed flag value -> false), the user will be redirected to EBillSignUp page.
If an already subscribed user tries to EBillSignUp page (SignUpAllowed flag value ->false), the user will be redirected to EBillManage page.
If there is a validation error in the API and the error is displayed, then the user gets redirected to the Dashboard page.
10. BPay Integration with Subscribe
Naviga Subscribe has successfully integrated with BPay, an Australian Payment Gateway starting from this release. The BPay generates a unique Customer Registration Number for its customers, and it will be displayed on Self-Service once customers link their account with their subscription.
10.1 API - BPay
A new API, BPay, has been developed to handle the integration between the BPay and Subscribe.
The Post /Bills endpoint creates a new Bill in BPay based on the below input parameters.
billerCode: The code of the biller issuer (the newspaper)
dueAmount: The amount of the bill
customerNumber: The identifier of the newspaper client. (Account number).
includesCheckDigit: If it is a customer number that has previously made a bill, set 'true'; otherwise, set 'false'.
dueDate: The bill's issuance date (dd/mm/yyyy)
generateQRCode: Optional; Set 'true' to add a base64 QR code that represents the bill in the response body.
qrCodeImageType: Optional; The variable that defines the QR code format, e.g., 0: PNG and 1: JPEG.
qrCodeIncludeAmount: Optional; Set 'true' to include the bill amount in the Base64 QR code generated.
The Post /CRNs endpoint creates a new Customer Reference Number (CRN) in BPay based on the below input parameters.
BaseCustomerNumber: The identifier of the newspaper client. (Account number).
TransactionId: A unique identifier for the customer number for which the Check Digit is being calculated. This will be returned in the response and can be used to match up the response and request object elements. As a result, it must be unique for each customer number in this request. (For this reason, a random GUID represents the transaction ID.)
Implementation Notes:
MG2 Control internal settings "BPayUrl.Url", "BPay.ClientId", "BPay.ClientSecret", and "BPay.BillerCode" must be configured in Mg2Control DB for any client that uses BPay services.
10.2 API - Purchase
After creating a new subscription, the Newstart flow now includes a step to generate a Customer Reference Number (CRN) in BPay for Australian clients.
A new MG2 control internal setting, Purchase.GenerateCRN, has been added to define whether the step required for generating a customer reference number (CRN) must be executed. In order to generate a CRN, the value should be set to (1) for the specific client.
The generated CRN will be stored in the Subscription table under the CustomerReferenceNumber column and in the Event Log table under the misc_code1 column.
Implementation Notes:
When the Newstart event is fired (event_type_code = 'STARTSTD'), the field "misc_code1" in Event_log table is populated with the new Customer reference number (CRN).
The setting Purchase.GenerateCRN must be configured as 1 for a specific client to generate a Customer Reference Number (CRN).
10.3 API - Subscriptions
The Get Subscription by ID endpoint, GET /Subscriptions/{subscriptionId}, has been updated to return an additional output parameter, CustomerReferenceNumber, in the Subscription object of the API response.
10.4 Display Customer Reference Number in One-CSR Portal and Self-Service Portal
This functionality is only applicable to BPay.
The Customer Reference Number is now displayed on both One-CSR Portal UI and Self Service portal UI.
With the introduction of a new property in the Subscription object that provides the associated Customer Reference Number, it is now possible to display the Customer Reference Number within the Account Information tab of SA.
Note: If the value in API response is blank, then the field will not be displayed. Also, the value is completely read-only.
Customer Reference Number will be displayed in the Subscription Information box in Update Subscriber page of SS. The field is available only for Australian clients as of now and is configurable from Subcon.Configuration.
Implementation Notes:
The MG2 Control Api setting keys BPayUrl.Url, BPay.ClientId, BPay.ClientSecret, and BPay.BillerCode must be configured in MG2 Control DB for any client that use BPay services.
When the Newstart event is fired (event_type_code = 'STARTSTD'), the field "misc_code1" in Event_log table is populated with the new Customer reference number (CRN).
The setting Purchase.GenerateCRN must be configured as 1 for a specific client to generate a Customer Reference Number (CRN).
New CMS content SubscriptionInfo.CustomerReferenceNumber and new Subcon.Config setting under SubscriberUpdate -> SubscriptionInformationSection: DisplayCustomerReferenceNumber.
The Customer reference number field will be visible only if there is a response for CustomerReferenceNumber in Start Call API (/api/startCall/Subscription/subscriptionId?paperCode=).
11. Auth0 Customized Workflow with Connection Parameter
11.1 Auth0 - Add the possibility of passing a Connection through the Universal Login Page
Auth0 Universal Login Page will now be able to receive a custom connection through Query string for using a different authentication source (by default Auth0 uses Auth0 DB). The connection parameter will be mapped to a MG2 Control Api setting Auth0.App.Connection with default value “Username-Password-Authentication“.
Implementation Notes:
A new MG2 Control Api setting Auth0.App.Connection has been added with “Username-Password-Authentication“ as the default value.
For the client Winnipeg, the Api setting value will be ‘Naviga-SAML-POC’.
If the default value of Api setting is not changed, then there is no impact. If any other valid value is set, then Auth0 will use it to redirect to the right login page.
11.2. Restrict the create user flow based on config flag
This has been done to handle client-specific flow.
Previously, when a user's entered email address in SP wasn't found in the client's database, the input fields to create a new user were displayed.
Changes have been implemented to prevent users from creating new users based on the value defined in the SP config file.
In the SP config.System, a new property called "RestrictCreateUser" has been added.
In CMS, a new property, "Email RestrictCreateUserMessage," has been added to the UserinformationV3 component.
Now, the CreateUser flow will work such that:
If the value of "Config.System.RestrictCreateUser" has been set to True and a message has been entered in the "Email RestrictCreateUserMessage" property under the User Information component in CMS:
If the entered email address already exists in the database, the user will be able to continue with their subscription.
If the entered email address does not exist in the database, the Continue button is disabled, and the message set in the "Email RestrictCreateUserMessage" property will be displayed on the screen.
If the value of "Config.System.RestrictCreateUser" has been set to False, the system will continue the existing flow and display the fields for creating a new user.
Implementation Notes:
Add and set the "RestrictCreateUser" property to "true" in SP config.System.
In CMS, add a message to the "Email RestrictCreateUserMessage" property of the UserInformation component.
The user can configure the properties by going to:
CMS > Subscription Panel > Presentation (Choose a valid presentation) > Page V3 > Step V3 > UserInformationV3
General Enhancements
Self-Service Portal
1. New CMS restriction for Carrier Collect subscriptions
A new CMS Restriction called ‘Carrier Collect’ has been introduced in this release. This restriction can hide/unhide a SS link based on the subscription’s billing method. When a subscription’s billing method is set to Carrier Collect, and a Carrier Collect restriction is configured for the corresponding SS link in CMS, the link will not be visible in the Self-Service Portal page .
For example, if a subscription’s preferred billing method is Carrier Collect, there is no need to display a ‘Make a Payment’ link on the Self-Service portal. This specific SS link can be hidden from CMS by configuring the newly introduced CMS restriction on the ‘Make a Payment’ link.
Implementation Notes: CMS > Navigation > Links/(Choose a valid link)> Hide Link For >Add ‘Carrier Collect’
2. FAQ Page for all clients
From this release, the FAQ page has been made available for all the clients. The contents of FAQ page can be configured from CMS as per your requirement.
Implementation Notes:
Any SS page can be displayed by following two configuration steps in CMS.
Prerequisite:
Navigate to SS and login to the dashboard page. From the URL displayed in the address bar, delete /dashboard and type in /faq to navigate to the newly created FAQ page. Copy the URL of the FAQ page.
Step 1: Generate a hyperlink to the new page from the CMS Links page.
Select the Newspaper on the top menu bar.
Navigate to CMS > Navigation > Links.
Paste the copied URL to the Href field.
Enter data in all the other mandatory fields.
Click Save button to generate the hyperlink.
Clear Cache: Manage Cache > Refresh CMS + Site.
Step 2: Configure the link on CMS Menu page.
Navigate to CMS > Navigation > Menu.
Select an option from the Menu drop-down under Link Assignment section. (Navbar, BillingMenu or SubscriptionMenu)
Drag and drop the FAQ link from the Available links section to the Menu Links section.
Click Save.
Note:
You can successfully configure a hyperlink only at three sections of an SS page.
As a menu option on Navbar
As a hyperlink in the SubscriptionMenu (Subscription Details section) of Dashboard page
As a hyperlink in the BillingMenu (Billing information section) of Dashboard page.
3. Deprecated Credit Card images section
Starting with this release, the credit card icon will no longer appear within the iFrame on the Payment page when a credit card is selected. Previously, when users entered their credit card number in the iFrame, the corresponding credit card icon would be displayed. The display of the AMEX credit card icon was previously controlled by the MG2 Control setting 'AmericanCardsImages.' However, in this release, this property has been removed. As a result, during credit card payments, no credit card icon will be shown within the payment iFrame.
Implementation Notes:
"AmericanCardsImages" property is removed from CreditCardSection, inside BillingWidgetSection, for all clients.
4. Customizable iFrame fields for Braintree
The Braintree hosted field place holders (in payment iframes) can now be customized by CMS contents. Previously these iframe field placeholders were hardcoded.
Implementation Notes:
The following CMS contents are used in Braintree payment iFrame from this release:
Placeholder.CCName
Placeholder.CCNumber
Placeholder.ExpirationMonth
Placeholder.ExpirationYear
5. New Page with Update Subscriber section
A new page, UPDATE SUBSCRIBER (Url: /subscriber/update) has been introduced in the Self-Service Portal, allowing only owners to edit their subscriber data. The new page includes an editable section, 'SUBSCRIBER INFORMATION,' which was previously part of the MyProfile page. The entire content on the page is CMS-driven. The page also has a read-only section where some subscription information is displayed which was previously a part of the MyProfile page.
Following this new development, MyProfile page no longer displays subscriber or subscription related information. The MyProfile page will only have registration fields (email, password and profile data sections).
This new page will be owned by Subscribers and hence it is restricted for guests and they will not have edit permissions on this page.
Implementation Notes:
New page and contents have been added to CMS (SubscriberUpdate). In Subcon.Config, SubscriberUpdate module has been added with SubscriberInformationSection and CurrentMembersSection. The CurrentMembersSection was removed from MyProfile page.
To display the hyperlink to this newly generated page on SS, follow the below two configuration steps in CMS.
Prerequisite:
Navigate to SS and login to the dashboard page. From the URL displayed in the address bar, delete /dashboard and type in /subscriber/update to navigate to the newly created Subscriber Update page. Copy the URL of the page.
Step 1: Generate a hyperlink to the new page from the CMS Links page.
Copy paste the URL on the Href field, enter the mandatory data and Save. Manage the Cache.
Step 2: Configure the link on CMS Menu page.
Select the location of the link from Menu drop-down. Drag and drop the generated link from the Available links section to the Menu links. Click Save.
The hyperlink to the Subscriber Update page will be visible at the configured location on the SS page where you have set it up.
6. Access - Message when there is no URL in DigitalAccess response
Based on some recent developments, it is not necessary for NewspaperEntitlementSettings table to have a redirect URL anymore. In such cases, the EntitlementsAPI could return a blank ReturnURL in the Output model. If this occurs, the Access page will be restricted from redirecting. In this scenario, the user will be displayed with a proper error notification message informing about the missing configuration. This error notification message is configurable from CMS (Error Code: SS_Access_04).
Implementation Notes:
The newly introduced Error Code SS_Access_04 can be customized from CMS.
Navigate to: Admin > Notification New > Notification New Mngmnt > Manage Error Codes > Add New Error Code.
Enter Code (SA_Access_04), Description and Click Save.
7. Map subscriptions with multiple registration to CMS restriction MultipleRegistrations
The CMS restriction, previously known as ‘CorporateSubscription,' has been renamed to 'MultipleRegistrations’ from this release. This restriction has been mapped in SubConSite accordingly. When any SS link is configured with CMS restriction ‘MultipleRegistrations’ in Hide links, the corresponding link will not be displayed in the SS UI, if the Subscription.RegistrationCount is not null and Subscription.RegistrationCount > 0 for the selected subscription.
7.1. Rename CorporateSubscription restriction as MultipleRegistrations
CMS > Navigation > Links (Choose a valid link)> Hide Link For > 'Multiple Registrations' restriction can be added
The CMS restriction 'Corporate Subscription' has been renamed 'Multiple Registrations' to better convey the purpose of the restriction. The restriction can be added in the "Hide Link For" field to prevent the link from being displayed if the registration count for the selected subscription is not null and is greater than 0.
Implementation Notes:
Open CMS, Select Navigation > Links section, then select a link from the drop-down menu. Multiple Registrations will be available in the Hide Link For.
8. Bigger PDF icon on Invoices page
The PDF icon on the /ebill/invoices page, used to download a user's OSG bill statement, was relatively smaller and had a very faint color. It has now been resized to a larger size to enhance visibility on the Invoice page.
9. Single Sign out functionality for clients using their own IDP
Starting from this release, it is now possible for the clients who have their own IDP to seamlessly logout users from all the sites where they were logged in, if they are logged out from the Self-Service portal.
When a logged-in user on both the website and SubCon Site logs out from the website, the user should not be logged out from the SubCon Site. However, in some instances of Firefox, the user gets logged out from the SubCon Site if they log out from the website, which is not the expected behavior.
Implementation Notes:
A new MG2Control Api setting Auth0.App.LogOutFromIDP has been introduced with the default value 0 (false). The value of this setting should be 1 (true) only for clients those who have their own IDP.
10. StopSaver - Bypassing TempStop step
Starting from this release, a digital subscriber entering StopSaver page will never see Temp Stop step. If something fails on Temp Stop step load routine for a digital subscriber, StopSaver workflow will just move to the next step to continue the workflow. The Temp Stop page will be bypassed. Before this enhancement, if the end user faced any issues in Temp Stop step, the whole page was failing out and was redirecting the user to the Dashboard page.
11. Supporting Classic and New Universal Auth0 login
The Identity provider Auth0 has introduced a new Universal login experience for its clients. Starting from this version, Subscribe supports both Classic and new Universal login of Auth0 through the Self-Service portal. However, there will be no visual changes for the user.
When a user hits the ‘Login’ button, Self-Service portal will direct the user to Sign-in page. Similarly, clicking the 'Register' button will still direct the user to the Sign-up page, as before. For those interested in learning more about the advantages of this new login experience, you may find additional information here:
One-CSR Portal
1. Enhancements in the Payment flows
The One-CSR Portal application has started using new endpoints in Payments API from this release for various payment flows such as One-time flows, Restarts and EZPay sign-ups. The grid for Rate details at the time of payment in all the flows will be as follows and consistent across all circulations irrespective of the payment method chosen (Bank payment or through credit card):
Term (e.g. 1 Month)
Rate
Other Cost
Tax
Amount
One-time flows:
Starting from this release One-CSR Portal application of NCS, Matrix, and CircPro clients will start using the new endpoint POST /api/Payment in the new Payment API for the successful completion of one-time payment flows. The Total amount calculation for one-time payment flow has been refactored, simplified, and centralized at Micro API level for all circulation systems. From this release, while submitting the payment request, Total amount will be (Amount + Tip + Donation + Activation fee (only for NCS)). This includes both credit card payment and payment through bank. However, payment through bank is not applicable for Matrix & CircPro circulation systems as of now.
Tip is applicable only for NCS and CircPro clients. The MG2 control app setting key StartCallPaymentBillingTabTip can hide and display the Tip amount field.
Donation is applicable only for NCS clients. The MG2 control app setting key StartCallPaymentBillingTabDonation can hide and display the Donation amount field.
The Activation fee is only applicable for NCS clients and is configurable using two MG2 control keys StartCallPaymentBillingTabActivationFeeACH and StartCallPaymentBillingTabActivationFeeCC for payment through bank and payment through credit card respectively.
The Amount displayed in the Subscription financial transactions grid after payment is the amount without including Activation fee.
Restart flow:
Starting from this release, One-CSR Portal application will start using the new endpoint POST api/RestartPayment in the Payment API for restarting a stopped subscription. While submitting payment request during Restart flow, a new API key Restart.ApplyCreditBalance will be considered in the TotalAmount calculation logic as follows:
If the setting is turned on and the subscription has a Credit balance (positive amount), that balance will be deducted from the TotalAmount.
If the setting is turned off, the Credit balance will not be considered in TotalAmount calculation.
Regardless of the value in the setting key Restart.ApplyCreditBalance, if the customer has a negative balance (i.e if they need to pay the company), the balance amount will be considered for TotalAmount calculation. The balance will be added to the TotalAmount to be paid.
Activation Fee will not be part of the calculation of TotalAmount from SA.
This Restart payment flow is applicable to both NCS and Matrix clients. However, for Matrix clients, Subscribe only supports Credit Card payment.
EZPay Sign up:
Starting from this release, One-CSR Portal application will start using the new endpoint POST api/EzPaySignUp in the Payment API for creating a new payment method for a Subscriber. Earlier, the microAPI used to handle both one-time payment & EZPay sign up in a single request. Starting from this release, One-CSR Portal will manage the requests and not the microAPI.
If the customer has negative balance (customer owes money to the publisher), then the One-CSR Portal will call One-Time Payment endpoint first and then the EZPay sign up endpoint. The EZPay sign up endpoint will be called only if the One-time Payment endpoint returns a success. In case it returns a failure, message from the API will be displayed. When both end points return a success, existing success message will be displayed to the user, if any. Otherwise, the error from microAPI will be displayed.
If the customer has positive balance, then the One-CSR Portal will directly call EZPay endpoint.
The transaction including One-time payment and EZPay Sign up will be a single submit like the existing functionality.
The Subscribe integration with payment vendors Stripe and PayWay do not support Diners Club credit card for any of the payment flows.
Implementation Notes:
The value of MG2 Control App keys StartCallPaymentBillingTabTip and StartCallPaymentBillingTabDonation determine the display of the Tip amount and Donation amount fields.
The MG2 Control API setting key Restart.ApplyCreditBalance handles the positive balance (whether the subscription's positive balance (credit) is deducted from the TotalAmount or not) in Restart flow. The client can be enabled and disabled from the Support Viewer.
2. Placement change of Access and Settings sections on Entitlement details page
Starting with this release, the Access section, providing information about Access levels and Household levels, will be placed at the top of the Settings section on the Entitlement details page within One-CSR Portal (Client Management > Entitlements > Entitlement details > Select any Newspaper > Search > Edit button on any Entitlement search result).
Apart from placement change on UI, there is no change in the functionality of these features.
3. Nonmandatory Settings section on the Entitlements page
The Settings section on the Entitlements page has been made non-mandatory from this release while adding a new Entitlement. After creating a new Entitlement (Client Management > Entitlements > Entitlements button > Search > Add new Entitlement), select the Entitlement details tab and click Search button to list the newly created Entitlement. Click the Add button along the new entitlement record in the Search result grid. The Entitlement details page of the selected entitlement will be displayed. On the Entitlement details page, Access section and Settings section are displayed. From this release, only Access section will be mandatory for saving the new entitlement with Access level and Household level details. Settings section has become non-mandatory.
4. Subscription end date in the Account information Tab
The Subscription end date will be displayed for all subscriptions irrespective of the subscription status in the Account information tab of the One-CSR Portal from this release. Earlier this field and data was displayed only for stopped subscriptions.
5. Registration Search via Company name
It is now possible to search user registrations directly for a specific company using ‘Company name’ from this release. A new search field ‘Company name’ has been added in the search screen of User accounts in One-CSR Portal. (One-CSR Portal > User accounts > Search).
Based on the entered search criteria, the search results will be fetched from the database & displayed in the search result grid. The company name will be checked in the metadata property of registrations.
The display of the search field ‘Company name’ and the column ‘Company name’ is decided by the value of the existing MG2 Control key that is otherwise used to enable Company name search criteria on the Subscription search screen. If the key value is set to 1, the Company name search field and the Company name column in the search result grid will be displayed. If the key value is 0, the search field and the column will not be displayed in the search result grid.
The Company name field is not a mandatory search criterion. If data is entered in any of the other displayed search fields, the search results will be displayed based on the full/partial match of the search criteria considering all entered parameters.
Implementation Notes:
When the value of the key SubscriberSearchCompanyNameOption is set to 1, then the Company name search field and the corresponding column in the search result grid will be displayed, or else it will not be displayed.
6. Removal of Auto renew signup option from One-time payment flow
The ‘Auto renew sign up’ checkbox option will no longer be available for one-time payment flows from this release. When a user clicks on the button ‘Make a payment’ button, the ‘Auto renew signup’ checkbox will not be displayed to the user anymore. The user will be able to enter the rest of the payment details and continue with the payment successfully.
If a CSR wants to sign up the subscriber for auto-renew, they can use the regular EZPAY Sign Up option instead of this checkbox that was previously available under one-time payments.
7. Users accounts Search page: Requires at least one parameter
Until 3.16.3 version, when a CSR/user clicks the Search button on Users Search page (User accounts > Search) without entering any search parameter (Login name, First name, or Last name), system used to list all users from Subscribe database. However, with the recent API refactoring and in view of performance optimization, the Users Search page will now require at least one search parameter to perform the search function successfully. The search results will be based on the search criteria input.
If the Search button is clicked without any input parameter, an error message will be displayed - “Please enter a value in at least one of the input fields.”.
If there is no data to return as per the provided the search criteria, then an information message will be displayed to the user - “Sorry! No data found for the entered search criteria.”
8. Capturing Newspaper from User while updating registration details
From this release, while updating any registration, the CSR or One-CSR Portal user will be provided with a mandatory drop-down to select a Newspaper publication while updating the Profile settings of a user (User accounts > Search Grid > Registration button > Profile settings tab) regardless of subscription. The list in the new drop-down will be identical to what is already available in the Subscription Search screen.
Based on the user selection of Newspaper, the registration update request will be accepted and the Papercode of the selected Newspaper will be submitted to the User update endpoint. On clicking the Submit button, the user will be displayed with a notification message “Registration profile has been updated successfully”.
While updating the user profile, if the Newspaper is not selected in the drop-down, the user will be notified with an error message “Newspaper field is required”.
9. Relevant message to user when they are not part of Sales team in Add New Account Start Call Flow
When a user attempts to create a new subscription from One-CSR Portal by selecting a publication for which they are not part of the Sales team in SolCon, they are prevented from proceeding. However, the application previously did not provide any information about the issue or how to proceed. Starting from this release, such users will receive a relevant message explaining the issue and providing guidance on how to resolve it.
10. Relevant error notifications while adding a new account
When a Customer Service Representative (CSR) attempts to add an account and start a new call from One-CSR Portal, a generic message is currently displayed - 'Sorry, there are no offers available for the selected zip code.' This message is shown regardless of the actual issue with the zip code, which can be due to the following reasons:
No Active Offers
Missing Zip Code (Print Offers)
Past-dated Offer Validity in Offer Group → Additional Options → Validity.
To address this, starting from this release, a more informative message will be displayed to help the CSR understand the cause of the issue and avoid any confusion. The new message will be:
"Sorry, there are no offers available. Please ensure you have active offers set up in SolCon with appropriate Available Areas (if applicable) and the Offer Validity under Offer Groups → Additional Options is not past-dated."
11. Configurable Search format for Postal Code
To support different countries' addresses, the Postal/Zipcode field in the Subscription search within SubCon Admin now allows the entry of postal / zip codes in desired format. A new MG2Control key, "PostalCodeMask", has been introduced to define the format. By default, the Zipcode field accepts 5 numeric digits, and the subscription search works with these values.
The Zipcode masking can be configured at the client level using the MG2Control key.
Below are some examples of masking formats:
AA99 = 2 alphabets followed by 2 digits
AAAA = 4 alphabets, no digits
9999 = 4 digits, no alphabets
***** = any 5 characters
** *** = any 2 characters, a space & then 3 characters
Note: If spaces are needed in the Postal Code like in the last example above, an additional masking in SA config must be requested to Naviga team for the search to work correctly.
Implementation Notes:
A new MG2 control key PostalCodeMask has been introduced to handle the postal code masking client-wise, with the default value of 5 numeric characters.
Solicitor Concierge (SolCon)
1. New API endpoints to fetch live Rate codes & Billing System Code section data population
Implemented new API endpoints (GET /DirectIntegration/Rates & GET /DirectIntegration/Rates/{externalId}) to fetch live Rate codes and corresponding Rate code details from the microAPI endpoint DirectIntegration/RateCodes that can be used for both NCS and CircPro circulation systems.
Offer Groups > New Offer Group > Coding > Billing system code > Subrate
For CircPro clients, when the Subrate value is selected, the remaining necessary fields in the Billing System Codes section for the Offer will be automatically filled with the relevant data. This data population is made possible with the help of the DirectIntegration API. The fields ‘Pay Types’ and ‘Delivery Type’ will be static drop-downs.
Implementation Notes:
To display the drop-down in SolCon, the MG2 Control App setting, SLOfferGroupsCoddingBillingCodesdropdown, should be set to 1.
2. Reason Code drop-down for Comp Offers independent of Rate Code
From this release, while editing an Offer group for Complimentary subscriptions, Reason codes for an Offer group will not be based on the value of Rate codes. The values in the Reason Code drop-down will be fetched from NCS via API. The Rate Code field remains disabled.
Note: For other subscription kinds, the values in the Reason Code field are populated as per the selection in the Rate Code field.
3. Allowed Registrations field as per Subscriptions.MaxLinks value
The Allowed registrations field in SolCon Additional Options will now consider the value defined in Subscriptions.MaxLinks setting. Starting from this release, the user will not be able to enter a number greater in the field than the defined limit in the setting key.
If the user enters a value greater than the Subscription.MaxLinks setting, a message will be displayed: “Enter a value less than the maximum limit i.e. <Max>” where <Max> represents the defined value in the Subscription.MaxLinks setting.
Implementation Notes:
The MG2 Control key Subscription.MaxLinks defines the max value of possible Registrations clients can set against any Subscription.
4. Move the field "Requires SheerID Validation" under Subscription Kind section
The checkbox "Requires SheerID Validation" which was previously a part of Subscription Validation section has been moved to Subscription Kind section on UI. There is no change in business logic other than UI placement. Subscription Validation section was not a relevant section for the field ‘Requires SheerID Validation’ as the field is not linked to active sub-check in anyways. Hence, the field has been moved to "Subscription Kind" section. This is a configurable checkbox with the MG2 Control App settings key “OfferGroupAdditionalOptionSheerIdValidationFlag”.
Implementation Notes:
The checkbox ‘Requires SheerID Validation’ will be visible under Subscription kind section only if the value of MG2 Control App settings key value is 1.
Subscription Panel
1. Seamless Flow updated for Payment Method Selector
The payment checkout page interface of the seamless flow has been updated to display all available payment methods as defined in the PaymentMethodSelector Style property in the CMS such as radio button, drop-down, etc.
Implementation Notes:
The user can configure the PaymentMethodSelector Style property by going to:
The CardHolderName (first and last names) has now been added as a hosted field (as part of the Braintree iframe) in the Subscription Panel user interface.
Note: The CardHolderName field will be displayed on the Subscription Panel page even if the CardHolderName show button has been turned off in the CMS presentation.
3. Password Validation
When purchasing a new subscription, a password validation error was displayed even when the same value was entered in both the Password and Confirm Password fields. In addition, the displayed password validation error had hard-to-read background and text colors.
Changes have been made to not display an error when correct values have been entered in the password fields, and if a validation error occurs, the message will be displayed in valid background and font colors.
4. Subscription Confirmation page now displays the latest Instagram logo
The Subscription Confirmation page in the Subscription Panel has now been modified to display the latest Instagram logo.
5. Expose Auth0 id in the set customer registration ID event
Through the Subscription Panel, the CRID (Customer Registration ID) was available to event triggers only after the user completed the User Information step. This prevented GTM/Fingerprint trackers from registering the CRID/Auth0 ID if the GTM scripts had already executed, as the Auth0 ID depended on the completion of User Information step. To address this, a new event is now triggered from the SP side once the customer registration ID is set in the application.
Starting from this release, SP exposes the CRID (Auth0 ID) in the set_customer_registration_id event specifically for GTM trackers. With this enhancement, when the email ID is available in the SP header component or as soon as a user enters their email in the Email field of the User Information component, the set_customer_registration_id event is triggered. This event includes the Auth0 ID, which can be captured by GTM scripts for further analytics processing.
CMS
1. Removed the Base64 encoding format Attribute Type in CMS
In CMS, when adding or editing any Attribute, the Base64String option will no longer be available in the Attribute Type drop-down menu. In addition, the existing Attributes and CMS Settings in the database with the Base64String Typehave been updated to the Character Type.
2. CMS Notification
CMS > Notification New > Notifications New Management > Manage Error codes
When creating, modifying, or deleting an error code record, the Notifications New Management page now displays relevant messages.
When an error code is created, a success message stating "Error code successfully added" is displayed.
When an error code is modified, a success message stating "Error code successfully updated" is displayed.
When an error code is erased, a success message stating "Error code successfully deleted" is displayed.
In addition, when a user attempts to save an error code after making no change to it, a warning message stating "Warning! No changes detected" is displayed.
3. Renamed the VideoLink Label in Benefits to YouTube VideoLink
The VideoLink field on the Benefits page has been renamed to YouTube VideoLink. A validation check has been implemented so that users can now only save a YouTube link in the field when adding a Benefit.
API
1. API - Entitlements
Previously, the Entitlements API needed records to be available in the NewspaperEntitlementSettings table in order to calculate the URL that has to be provided in the DigitalAccess endpoint, which was used by the Self-Service Portal's Access page for the redirect. This has now caused an issue since the Access Page is no longer being used, and clients are being forced to set up dummy data in the NewspaperEntitlementSettings table in order for the API to function properly.
Changes have been made to remove the validation checks to force NewspaperEntitlementSettings for entitlements that are used externally and do not require a redirect url provided by the API.
When generating Entitlements using the Entitlements API (POST /Entitlements), all dependency on the NewspaperEntitlementSettings table has been removed. If the EntilementCode has no association with any NewspaperEntitlementSettings when creating a digital access (POST /DigitalAccess), the steps to generate the URL will now be skipped.
2. API - Offers
The Offers API now includes a new endpoint, GET /CheckZipDeliverable, that validates the availability of a ZipCode in the Offer Delivery Area based on the input parameters ZipCode and OfferId.
3. API - Billing
Previously, a subscriber with multiple subscriptions was unable to change the auto-renew information of a subscription after one of the other subscriptions had been updated and received the error message "Payment method was modified recently. Please wait 24 hours or call our Customer Support team." This error occurred because the payment validation check for the past 24 hours was based on the Subscriber ID.
Changes have been made such that the validation check for payments made in the past 24 hours will now be based on the subscription rather than the subscriber. A subscriber who has multiple subscriptions can now update them one after the other without having to wait the 24-hour interval; however, payments towards a single subscription can only be made once per day.
When entering new payment information, the masked Credit Card details received in the CreatePaymentMethod endpoint will now be stored in the subsvc database under the PaymentMethod table.
4. API - MailingOrchestrator
A new orchestration API, MailingOrchestrator, has been developed to handle the workflow orchestration between the external services and Subscribe Emails API.
The Post /Emails endpoint sends the email related to an event based on the provided input parameters EventId (a unique identifier of the event in the SubCon database) and Email (optional; if provided, it will replace the destination email specified in the provided event).
Note: Currently, consumer applications are not using this new API.
5. API - Auth0
A new API, Auth0, has been developed to handle the integration between the Auth0 and Subscribe.
The POST /Users/Authentication endpoint validates an access token based on the input parameter, Token (access token generated in the consumer application).
The GET /Users endpoint has been developed to receive a paginated list of all users registered in Auth0. Input parameters:
Email: Optional; Email address of the user.
InternalId: Optional; Internal custom ID of the user.
PageSize: Optional; Maximum number of items returned per request. Default value 10.
PageNumber: Optional; Requested page number of pagination. Default value 1.
The GET /Users/{Id} has been developed to retrieve the details of a user registered in Auth0 based on the provided ID (a unique identifier for the user in Auth0).
The POST /Users endpoint creates a user in Auth0 based on the below input parameters.
Email: Email address of the user.
Password: User’s password.
FirstName: Optional; User’s first name.
LastName: Optional; User’s last name.
PhoneNumber: Optional; User’s phone number.
UserName: Optional; User’s user name.
NickName: Optional; User’s nick name.
Picture: Optional; User’s picture. It needs to be a valid public URL and will be validated on the Auth0 side.
InternalId: Optional; Internal custom ID of the user.
The PUT /Users/{Id} endpoint updates a user in Auth0 based on the provided ID (a unique identifier for the user in Auth0) along with the input parameters mentioned in the POST /Users endpoint.
The POST /Ticket/Password endpoint creates a URL for the user to change their password in Auth0 based on the provided UserID (a unique identifier for the user in Auth0).
Implementation Notes:
The new API is set up under $/MG2CEP/Main/SubscribeAPI/LowLevel/Integration/Auth0/Dev.
This new API will replace the current Auth0 MicroAPI starting with 3.17.0. As a consequence, the builds and releases for Dev and BetaRelease 3.17.0 have the new structure.
5.1 API - Auth0 - Tokens cache enhancements
Subscribe previously generated a new token for each Management API call since Auth0 required a token for interacting with the Management API. To prevent having to generate a token for each API call, a token cache has been introduced, in which Subscribe stores the token generated with an expiration date. The MG2 control internal setting, Auth0.MaxTokenExpirationSeconds, was used for determining the expiration date. An issue occurred when the value specified in the MG2 Control setting was longer than the expiration date of the token in Auth0, and the token cache had to be cleaned.
Changes have now been made to get the expiry date from the token rather than depending on the MG2 Control setting, so that the Auth0 API can store the access token to prevent further calls to the external API. In addition, when the token expires, it will be removed from the cache and a new token will be generated.
Note: The MG2 control internal setting, Auth0.MaxTokenExpirationSeconds, will no longer be used for determining the expiration date.
Implementation Notes:
The MG2 control internal setting, Auth0.MaxTokenExpirationSeconds, will no longer be used for determining the expiration date.
6. API - Purchase
In the Newstart flow, the logic for the Phone has been updated such that:
If an existing Circ subscriber does not have a phone and no phone information has been specified in the Subscription Panel, the API makes no changes.
If an existing subscriber in Circ has phones but the phone in Subsvc is null, the API updates the phone in Subscribe DB.
If an existing subscriber in Circ does have a phone and the phone information specified in the Subscription Panel is already on that list, the API makes no changes.
If an existing subscriber in Circ does not have any phones but phone information has been provided in the Subscription Panel, the API updates the occupant in NCS to save it as a Primary Phone.
If the subscriber in Circ has phones but the phone information provided in the Subscription Panel is not on that list, the API updates the Occupant in NCS to save the collected phone information as the Primary Phone and the existing phone as the OtherPhone.
Previously, when creating a Newstart, columns such as the SubscriptionKindId, PaymentMethodType, or CC_type in the AUTHCC event were not being populated, making it difficult to troubleshoot when an issue occurs. When creating Newstarts, changes have now been made to collect and store all of the information received in the AUTHCC event.
7. API - Address
Because Comp subscriptions are not billable, the Subscribe API will now include the subscription's BillingMethod along with the RateCode when sending the request to the NCS in the AddMove (addmovetrandelschedchg) endpoint when creating Moves for Comp subscriptions with the MG2 control flow setting "Flow.AddressMove" set to RealTime.
Implementation Notes:
The MG2 control flow setting "Flow.AddressMove" has to be set to RealTime.
8. API - DTI
Currently, when requests have been sent to NCS from both Naviga Consumer Apps and External Consumer Apps, the user will be retrieved from the value defined in the MG2 Control Setting, DTI.CircAPIUserId.
To differentiate between requests received from Naviga Consumer Apps and requests received from External Consumer Apps in the NCS, an internal setting in the MG2 DB can be created by concatenating the Source System from which the request has been sent with the MG2 Control Setting, DTI.CircAPIUserId.
For example, if a client's Source System is ClientWebSite, an MG2 Control Internal Setting "ClientWebSite.DTI.CircAPIUserId" can be created, and if a value of "ClientWebSiteUser" has been set to it, the user value will be displayed as ClientWebSiteUser in the NCS when sending requests through this Source System.
Implementation Notes:
If a particular source system needs a different value when sending a request to NCS, it can be set up now.
9. API - Subscriptions
New Address fields for Australia
Previously, when standardizing an Australian address through the MelissaData API, it returned the parameters "Level Designator" and "Level Number" (as SubPremiseLevelType and SubPremiseLevelNumber, respectively), but SubscribeAPI was not mapping them.
Changes have now been made to the Purchase and Change Address flows such that the LevelDesignatorID and LevelNumber will now be provided when calling the NCS CircAPI, "Add Address/Occupant (addaddrocc)" for Australian addresses.
In addition, two columns, LevelDesignator and LevelNumber, have been added to the Address table in the subsvc database, which will be populated with the data received from the standardization.
Implementation Notes:
This functionality is only applicable when the MG2 control flow setting, MelissaDataIntegration, has been set to "GlobalOnPremise” or “GlobalCheckAPI”.
Prerequisites:
Circ System & Minimum Supported Version: NCS Circ, 2020-4.1
Subscribe Extract Minimum Supported Version: Subscribe Extract export version 6
API - Subscriptions - Remove ExpireDate Check to allow Cancel
Starting from this release, the validation that prevents InGrace users with ExpireDate in the past to Cancel their subscriptions, has been removed. Subscribers will be now able to cancel their subscription even if the subscription is in grace period regardless of the expiration date being past/future. Cancelling a subscription will not have any dependency on the expiration date.
Bug Fixes
DayPass Flow corrections
DayPass subscriptions are special subscriptions that grant users one-day premium access to Publications. That means, if a user purchases a 'DayPass' subscription today, they can access the premium content until midnight the following day. Currently, only the NCS circulation system supports this type of subscription.
In this release, some changes have been made to the DayPass subscription flow. Here are some key points to note:
The subscription type (Subscription kind) of DayPass subscriptions in Subscribe will be set as ‘PaidPass’. In NCS, these subscriptions will have their DeliverySchedule designated as ‘DayPass’.
Whenever the subscription status becomes ‘Stopped’ for a DayPass subscription, the access to the Publication content will be denied.
The HouseHold Level value of DayPass subscriptions will be based on the Status of these subscriptions.
Implementation Notes:
The HHL rule to grant/revoke the access for DayPass subscriptions must be set in the HHL Business Rules.
Self-Service Portal
1. Cancellation reasons unavailable on SS page
The issue of the user being unable to view cancellation reasons in the drop-down while canceling a subscription has been resolved.
2. Logged in users getting redirected to homepage
The issue of logged in users getting redirected to homepage when any changes were made to the URL has been resolved. As a result of the fix, any alterations to the URL will no longer grant logged-in users access to the homepage. Instead, they will be automatically redirected to the Dashboard page.
3. Alignment issues in Dashboard page on iPhone
The alignment for the name, company name, and account number was not correct when compared to the system UI for the Self-Service Portal dashboard page on iPhone. However, this issue has been fixed.
4. Error message after the successful cancellation of the subscription
The user was displayed an error message after the cancellation of the subscription even when the cancellation was successful. This issue has been resolved now.
After fixing, the Cancel Subscription workflow no longer displays an error message, even if the event is part of the Stop Saver flow and was successful.
5. Logo overlapping text in the payment receipt
When the user clicked the ‘Print’ button for the payment receipt of a successful restarted subscription, the client logo was overlapping with the ‘My Subscription’ text in the downloaded receipt. This issue was observed both on the laptops and iPhones. After the fix, the overlapping issue is resolved.
6. Multiple opt-in/opt-out instances in eBilling
The user could sign up for eBilling multiple times over and again even when successfully signed up. The same issue occured for sign-out process too. After the fix, when a user signs up for eBilling, they will see 'eBill Manage' link on SS. Conversely, when the user signs out from eBilling, they will then see the 'eBill sign Up' link.
7. User getting logged out from selectaccount page
The issue of user getting logged out from SS selectaccount page on refreshing the page has been resolved.
8. User with Trial subscription able to Restart subscription
Restart workflow is restricted for a stopped Trial subscription. However, in the Account information tab of a stopped trial subscription, ‘Restart’ button was available, and it was also possible to successfully run the Restart workflow for the user from SA. This issue has been resolved now.
9. Discrepancies in the information collected while downgrading or cancelling a subscription using Stopsaver
There were discrepancies in event information and email triggers when downgrading or canceling a subscription using Stopsaver, depending on whether the action was taken from SubCon Admin or SubCon Site.
Downgrading from SubCon Site: Incorrect email triggered, missing downgrading reason and parent event ID, blank email address in SubCon Admin.
Downgrading from SubCon Admin: No email triggered, but cancellation reason and event ID recorded, blank email address in SubCon Admin.
Canceling from SubCon Site: Email triggered, reason and parent ID captured.
Canceling from SubCon Admin: No email triggered, blank email address, but reason and parent event ID captured.
These issues have now been fixed.
One-CSR Portal
User not getting logged out from the Subscribe application without refreshing the page
When the user logs out from any of the sub application of Subscribe (SA, SS, and SolCon), the expected behavior is that they should also be logged out from all the other sub-applications opened on different tabs in the same browser. However, this was not happening. The user was logged out from other sub applications on other tabs only by refreshing the corresponding pages. The issue has been resolved now.
Customer Email trigger Issue for REDEEMGIFT event
Even though Internal and Customer email templates were configured for Gift Redeeming event under the Internal Emails and Customer Emails tabs accordingly, the email configured under the Customer Emails tab was not getting triggered after the successful completion of a gift redeeming flow. This issue has been fixed in this release.
After the fix, whenever a recipient redeems a gift subscription successfully, the congratulatory email configured under the Internal Emails tab and the notification email configured under the Customer Emails tab are sent to the recipient and purchaser accordingly.
Issues with stopped accounts having balances
For accounts with a positive balance (credit), a validation message was displayed, preventing the purchase of a subscription. Conversely, for accounts with a negative balance (outstanding), no validation message was displayed, allowing the purchase of a subscription. These issues have now been resolved.
Solicitor Concierge (SolCon)
1. Absence of the Close button in the Inventory module
The problem of lacking a Close button and instead having a Cancel button (along with a pop-up asking the user to Quit/Return to editing) when saving a record in the Inventory module has been addressed. After implementing the solution, users now have access to a Close button after saving in the Inventory module, and they are also automatically redirected to the previous screen.
2. Filter on HHL page
When the ‘Show only active’ filter (a checkbox) was unchecked on the House Hold Levels page under Reference Tables section (Reference Tables > House Hold Levels), the result grid was not showing inactive house hold levels. This issue has been resolved now. With the fix in place, when the ‘Show only active’ filter is checked, then only the active house hold levels will be displayed on the page and if the filter is unchecked, both active and inactive house hold levels will be displayed on the page.
3. Filter on Billing Plans page
When the ‘Show only active’ filter (a checkbox) was unchecked on the Billing Plans page under Reference Tables section (Reference Tables > Billing Plans), the result grid was not showing inactive billing plans. This issue has been resolved now. With the fix in place, when the ‘Show only active’ filter is checked, then only the active billing plans will be displayed on the page and if the filter is unchecked, both active and inactive billing plans will be displayed on the page.
4. Status Filter on Offer Groups page
Previously, the Status filter on the Offer Groups page did not properly filter the Active, Inactive, or Draft offer groups that were chosen for export. This issue has been resolved and the filter now functions correctly. After the fix, when the user clicks the 'Show Selected' button to view the offer groups selected for export and applies the status filter (Active, Inactive, or Draft), the selected offer groups in each category are displayed correctly, if any are present.
5. Offers not getting created under correct Client code on Import
When the user exported Offer groups and imported them to a specific client, the offer groups were created with Marketing text and Terms and Conditions, but no Offers were generated for the client. The created Offer groups were also non-editable. It was also observed that the Offers were being created under the ‘ALL’ category rather than for the selected client. This issue has now been resolved.
6. Issues on Safari browser and Export issue
The following issues that were reported in the Safari browser have been resolved:
The Sync message was erroneously displayed in front of the ‘Clear cache’ button.
The welcome message of SolCon was not displayed correctly.
The Export feature (Admin > Users > Export) was non-functional. Upon clicking the Export button, the progress bar completed, but no file was exported.
7. Error message while updating an offer with ‘Marketing text’ or ‘Marketplaces’
The issue of user receiving error messages in SolCon Admin while updating an existing offer with Marketplaces or Marketing text has been resolved now.
8. Multiple issues observed in SolCon on Safari browser
While using SolCon Admin on Safari browser, the user was encountering below listed issues:
Unable to enter value in the “Price” section
Unable to open “Additional Options” section
Unable to click on “Search” bucket while creating “Sales team” and “Team Member”
All these issues have been resolved. After the resolution, it is now possible to create offer group with valid price and also to search and create sales team and team members.
9. Error notifications on SL pages
The user received error notifications on Offers, Promotions and House Hold Levels pages while clicking on the up or down arrows (for sorting ascending or descending) in the header fields of the displayed grid on those pages. The error messages appeared when sorting was attempted on fields with empty headers. As part of the fix, the ‘Tags’ header field has been added on Offers and Promotions pages and ‘Status’ header has been added on Offers, Promotions and House Hold Levels pages. These fields have been added to the respective tables too. It is now possible to sort the grid records in ascending or descending order using any header fields displayed in the grid.
10. Timeout error while adding offer groups
The issue of getting timeout errors while adding offer groups for a new price point has been resolved. (Teams > Sales Teams > Select any Sales team from the grid >Offer groups). During timeouts the user is notified with proper error messages.
API
1. APICore
Previously, ApiCore has been updated to include a new feature that ignores the log attribute from the request model, preventing it from adding properties to attributes that are too long, such as Receipts in Webhooks. An issue with this occurred when there were null collections of nested objects in the input model, and an exception was logged in the log files.
This issue has now been resolved; the endpoint responds successfully, and no exceptions will be logged in the log files.
2. API - New Start Errors
When creating Newstarts, if NCS returns two occupants based on the provided email (one that matches exactly and one that matches partially), the whole Newstart process fails with the error message "Child Event: FINDADDRESSOCCUPANT failed. Error: Completed," since it was expecting only one occupant. This issue has now been resolved, and if NCS still returns two occupants, Subscribe will select the email that exactly matches the provided email and process the Newstart normally.
3. API - Restart-related issue
When a user reactivated a subscription through the One-CSR Portal, it created a new account for the user instead of reactivating their existing subscription in CircPro. However, when the user attempted to access the account using the One-CSR Portal, it displayed as inactive and prompted the user to sign up for a new account. This occurred because the inactive CircPro account remained linked to the One-CSR Portal rather than the newly created account. When the client changed the inactive account to active in order to get access to the account, the subscriber now has two active accounts.
This restart event issue in the One-CSR Portal has been resolved, and reactivating a subscription no longer results in the creation of a duplicate account.
4. API - Subscriptions
Previously, the GET /Users/{customerRegistrationId}/Subscriptions/v2 API was returning null responses for subscriptions that were inactive in the RegistrationSubscriptions table. This issue has been resolved and the API will now correctly return inactive records from the RegistrationSubscriptions table.
5. CreateSub API not encoding special characters in the DeliverySchedule parameter
The special characters in the DeliverySchedule parameter of the CreateSub API request URL were not encoded and this was failing the call. This issue has been fixed.
CMS
1. Component addition error under PageV3
Previously, saving a presentation after adding the InformationV3 component as a child under PageV3 resulted in the error message "Error! This item must not be here" and "Excess item". This setup issue has now been resolved, and the InformationV3 component can now be added as a child to PageV3.
Implementation Notes:
The user can configure the properties by going to:
Previously, when a user logged out of the Landing Page, they were not automatically logged out of the CMS application.
This problem occurred when, following a successful logout in the landing application, it redirected the users to the login page, but CMS did not receive this message.
This has now been resolved by modifying the functionality logic on the landing page iframe such that when the landing application logs out and the CMS call fails, the iframe passes a message to the CMS application.
3. Incorrect success messages
CMS > Slideshow > (Select any Slideshow) > Edit (update the required values) > Submit > Remove Override
When overriding a Slideshow , the incorrect success message "Slideshow successfully deleted" was displayed instead of the correct message "Slideshow override successfully removed". This issue has now been fixed.
CMS > Rewards > (Select any Reward) > Delete
When deleting a Reward, the incorrect success message "Benefit successfully deleted" was displayed instead of the correct message "Reward successfully deleted". This issue has now been fixed.
CMS > Content > (Select any Page from the Filter By Page: drop-down menu) > Edit (update the required values) > Save > Remove Override (under Delete column)
When removing an override of a Content, the incorrect success message "Content successfully deleted" was displayed instead of the correct message "Override successfully removed". This issue has now been fixed.
5. Application Error
When the user left the CMS application idle for a while and then did any operation such as changing the hierarchy or presentation, an error message "Sorry there was an unexpected error.Err:500" was displayed.
This issue has now been resolved, such that if a user loads the CMS and remains idle for more than half an hour before trying to perform any operation, the application now displays a time-out warning message, the entire page reloads, and the user is logged out of the session and redirected to the landing page.
When attempting to upload an image file greater than 5MB in size, an invalid error message "Sorry there was an unexpected error.Err:500" was displayed instead of the appropriate message "Maximum request length exceeded. Please upload a smaller file."
This issue has been resolved, and the correct error message will now be displayed.
7. Content Segments
The issue of being unable to save after setting all CMS Content Segments to "Active" has now been resolved.
Subscription Panel
User Interface Error
When purchasing a new subscription, when a user chose an offer, entered the email and address fields, and then clicked the continue button, the user interface behaved incorrectly by expanding and collapsing the fields before advancing to the next step. This issue has been resolved, and the user will be able to advance to the next step without the extra animation in the user interface.
Error during eBill Sign-up
During a Newstart from Subscription Panel, the eBill sign-up was failing with an error message stating, 'Could not find any processing command for event type and processor.' This issue has now been resolved.
Landing
Password validation issue in the ‘Forgot Password’ workflow
The problem with password validation in the Forgot Password workflow (the flow that is initiated when the user clicks on the link from the email) has been fixed. According to the validations, a subscription application password must be a minimum of 8 characters in length and must include at least one special character and one numeral.
Refactor and Maintenance
Self-Service Portal
1. Adding of Resolver steps in SS pages
Resolvers were added to Self-Service Portal pages to fetch the configuration before rendering the page to the user. Starting from this release, in addition to the Get Configurations, more steps have been added in every page to load in resolvers, so as to get information before rendering them. The following is the list of the candidate calls to be done in Resolvers:
Get Availability (except on the Dashboard page)
Complaint
Address / AddressUpdate
Payment
AutoPay Sign Up
AutoPay Sign Out / AutoPay Cancel
AutoPay Manage
Add Tip
Ebill Sign Up
Ebill Manage
Subscription Cancel
Subscription Restart
Temporary Stop
Stop Saver
Get Reasons/Options/Categories to populate drop-downs in forms
Feedback (Get Categories)
Stop Saver (Get Reasons)
Subscription Cancel (Get Stop Reasons)
Get the key resource of the page (without that, there is no point in loading the page)
Subscription Update (Get Offers)
Temporary Stop (Get Stop Dates)
Rewards (Get Rewards)
Transactions (Get Transactions)
Update Subscriber (Get Subscriber)
Unsubscribe (Get Allowance)
Invitation Confirm (Get Target Invitation)
EBill Invoices (Get Invoices)
Forgot Password (Get Validity)
2. Unifying components on SS pages
With this release, Circ-specific components have been replaced with a generic and configurable approach for all pages in the Self-Service Portal application. The SS pages on which the components were unified across all circulation systems are:
TemporaryStops page - A single page now covers all Circulation systems. Also did the clean up of unused code. Example: the Wizard presentation.
AutopayCancel page - Previously this page was associated only to NCS. Now it is applicable for all circ systems. All components are renamed.
Transactions page - Previously this page was associated only to NCS. Now it is applicable for all circ systems. All components are renamed.
TemporaryStopRestart page - Previously this page was associated only to Saxo. Now it is applicable for all circ systems. All components are renamed.
Code cleaning has been achieved with this development. All the changes are transparent for the user. There is no visual implication.
Implementation Notes:
The Subcon.Configuration setting "hideRedliveryTable" inside TemporaryStopModule is deprecated.
3. Deprecation of Wizard Presentations
Starting from this release, unused Wizard Presentations have been removed from the Complaints and Address pages of Self-Service Portal application. This change is transparent to the user.
4. Deprecation of Layout property from SS Configuration
The Layout property has been removed from every client’s SS.Config file. However, the Layout module is still in place. The Layout property was initially introduced with the assumption that clients would have two styles (Type A and Type B) of layouts to choose from. However, it was discovered that both layout styles were identical, using exactly the same code. Therefore, regardless of the client’s choice, the site would look the same. Hence, as part of the cleanup task, the layout property has been removed from the config file. There are no changes from the user's perspective.
Implementation Notes:
The layout property is removed from the Subcon.Configuration file since Type A and Type B were using the same code.
5. Angular - Environment enhancements
Originally, the environment.release.ts had client-specific versioning, requiring the team to update the variable throughout the entire file whenever a new branch was created.
A newer approach has now been introduced, unifying the WebApp and WebAPI in the same branch. This means that the WebApp can use the same version as the WebAPI.
The Environments file has been cleaned up to remove anything related to the version. Additionally, it has been ensured that the WebAPI version is displayed in the UI.
6. Upgrade to .NET 6
The SS application has been upgraded to .NET 6. The .NET core is already available on all servers.
7. Deprecate Autofac
Autofac, an open-source dependency injection (DI) container for .NET applications, has been deprecated in the WebAPI of the Self-Service Portal application.
8. Upgrade Braintree SDK
The Braintree-web library and other Braintree scripts have been upgraded from version 3.62.0 to the latest version, 3.100.0. There was a known issue in the Braintree SDK where the Cardholder Name field appeared as a numeric field on iPhones. This issue has been resolved in the newer versions of Braintree. The SDK upgrade has successfully addressed this issue in SS.
One-CSR Portal
1. New endpoints for UsersOrchestrator
1.1 GET: User end point implementation
A new User endpoint "api/registrations/GetUserdata" has been implemented to get the user data. One restriction for the GET request is that PaperCode should not be null or NA. Any random code of the client can also be passed. The existing behavior of the user data being from fetched from DB will continue.
Starting from this release, while getting User data, the object will have a property called State. Additionally, the registration State will be displayed in One-CSR Portal Registration lookup as applicable. If the Tenant is using a third-party auth system such as Auth0, Firefly, etc., then the State will always be Standard. If the Tenant uses MG2 Auth, the value of State will be as follows:
When the Password is blank in the DB, State will be Lite
When Verified is false in the DB, State will be Unverified
When Password is not blank and Verified is true, State will be Standard
Implementation Notes:
Created a new MG2 Control App Setting DefaultPaperCodeSA for configuring default paper codes. A default paper code can be set client-wise that will be passed to lookup the users on the user screen, if paper code is not set.
1.2 POST: User end point implementation
For active users on the digital tab, the old user creation endpoint has been replaced with new "api/addUser". The activation flow works as per the existing behavior. The verifyEmail parameter is not being sent in the payload anymore. Hence the user activation (Creation of user) flow is effective for both authentication systems, Auth0 and Mg2Auth.
1.3 PUT: User Email end point implementation
A new User Email endpoint "api/registration/updateUserEmail" has been created to update the email address on the user update registration screen (User accounts > Search > Registration button > Profile settings tab) and Digital tab (Subscription information > Subscription search > Start call > Digital). The new endpoint will replace the old one.
Note: For Mg2groupstripe, email will be updated in DB instantly but for Auth0 clients, email update happens only after Sync.
1.4 PUT: User Password end point implementation
Created one new endpoint "api/registration/updateUserPassword" to update the password and replace the old one. In case of User accounts search screen, "Password" section (User accounts > Search > Registration button > Profile settings tab) will be only visible to clients using Auth0 authentication system.
1.5 PUT: User Customer registration id end point implementation
A new endpoint “api/registration/{CustomerRegistrationId}/CustomerRegistrationId” has been created to update the registration and replace the old one. There is no change to the existing functionality.
If a blank value for CRID is submitted for update, the following message will be displayed:
'Customer Registration ID cannot be blank'. The message will be the same in both screens i.e. via User Accounts & via Start Call Digital tab CRID Update.
Implementation Notes:
The section “Update customer registration ID" section in Subscription Search Screen (Digital Tab) and the field “Customer registration ID” in the User accounts screen (Profile settings tab) will be visible on UI only if the value of the MG2 control setting key StartCallDigitalTabEditCustomerRegistrationId = 1.
2. Replace RegistrationId with CustomerRegistrationId
Starting from this release, RegistrationId has been replaced with CustomerRegistrationId at several instances as follows:
2.1 GET /CampaignMessages
From now on CustomerRegistrationId will be added in the payload of the GET ComaplaintsHistory API request while adding a new delivery error (Subscription search > Start call > Service tab > Add new delivery error > Enter the valid error details > Save) in the place of RegistrationId.
Only the api/messaging/campaignsMessages endpoint was impacted in this replacement. After the replacement, the GET request is functioning as expected.
2.2 User Invitation
Along with the RegistrationID replacement, Phone key under MetaData has also been replaced with PhoneNumber in User Invitation/Registrations.
The Invitation Screen, Insert Invitation, Bulk Invitations, AppendInvitation, Update Invitation, Get PendingInvites, Update Registration, Get Registration, Export Registration, and Import Registration are the different points where User invitation/Registration is employed. There is no impact on the functionality with these replacements.
3. Deprecation of PayBalance flow
Beginning with this release, the PayBalance flow has been deprecated and will no longer be displayed in the One-CSR Portal UI for any scenario. Previously, One-CSR Portal had two separate flows - PayBalance and Restart. The assumption was that the PayBalance button was displayed only if the 'CheckRestartAvailability' endpoint returned false, and if the endpoint returned true, the Restart button was displayed. However, at the backend, both endpoints were calling the same 'Restart' endpoint, and the subscription account was getting restarted regardless of the 'RestartAvailability' response. Hence, the unnecessary PayBalance flow is now deprecated. The Restart option that redirects to SP new start flow is also deprecated.
From now on, the Restart button will be displayed in Account Information Tab only if the endpoint CheckRestartAvailability returns True. Clicking the Restart button will restart the same subscription. Negative & Positive balance are handled as per their expected behavior. If there is a negative balance, its payment is captured during the restart flow. If there is a positive balance, it is adjusted based on the new key Restart.ApplyCreditBalance introduced in 3.17.0.
Implementation Notes:
The Restart button will be available only if the API api/CheckRestartAvailability/subscriptionId returns True.
4. New endpoint to monitor the health of SA
A new endpoint to monitor the health of One-CSR Portal application (whether the application is up and running) has been functional from this release. Status/Ping route is added to One-CSR Portal API that enables the monitoring of One-CSR Portal.
Solicitor Concierge (SolCon)
New endpoint to monitor the health of SL
A new endpoint to monitor the health of SolCon application (whether the application is up and running) has been functional from this release. Status/Ping route is added to SL API that enables the monitoring of SolCon application.
API
1. API - Subscribe Entitlements
A new endpoint, Post /Access, has been developed to create access for the User based on the provided EntitlementID, RegistrationId, PlatformType, and UserAgent.
A new endpoint, Get /Access, has been developed to return whether the user has access based on the provided EntitlementId and CustomerRegistrationId.
A new endpoint, Get /Entitlements, has been developed to return the details of Entitlements based on the provided EntitlementCode.
A new endpoint, Get /TemporaryEntitlements, has been developed to return details of a user from the TemporaryEntitlement’s Table based on the provided CustomerRegistrationId.
A new endpoint, Post /TemporaryEntitlements, has been developed to create a new record in the Subscribe TemporaryEntitlement’s Table based on the provided user’s details and EventID.
Implementation Notes:
A MG2 control internal setting: SubscribeEntitlements has been added.
2. API - Entitlements Orchestrator
A new orchestration API, EntitlementsOrchestrator, has been developed to handle the workflow orchestration between the external services and Subscribe Entitlements API.
The Post /Access endpoint creates Access Log record for the User based on the provided EntitlementCode and CustomerRegistrationId.
The Get /Access endpoint returns the current access level (Premium, Upgrade, Purchase) based on the provided EntitlementCode and CustomerRegistrationId.
The Post /TemporaryEntitlements endpoint creates a new record in the Subscribe TemporaryEntitlement’s Table based on the provided user’s details and EventID.
Enhancements have been implemented to enable One-CSR Portal to utilize the new set of endpoints mentioned above. Some of the changes in the flow (transparent to the user) are listed below:
Access page POST an Access request to generate a log entry.
Activate page should GET a Subscription's access to know which step to display next.
Additionally, some access codes have been hardcoded in the CMS as follows:
SS_Access_01 = "Access Success"
SS_Access_02 = "Access No Authorized"
SS_Access_03 = "Get Access Level has failed"
SS_Access_04 = "Unable to perform redirection because configuration is missing"
The Access messages against each Access code can be edited in CMS under for each access code.
Implementation Notes:
ProxyAPI needs to have the following settings in place in order to redirect to EntitlementsAPI or to EntitlementsOrchestratorAPI.
MG2 control internal setting: EntitlementsOrchestrator has been added.This value includes a string.Format that must be used to determine the correct API route. The default value is “{0}/EntitlementsOrchestrator”.
Note: ProxyAPI calls EntitlementsOrchestratorAPI directly, so GatewayAPI is not involved in the request chain.
3. API - Payments
Starting with release 3.17.0, the logic for the following four payment flows has been transitioned from the existing Billing API to a new API known as Payments API:
One-time payment
Restart
Ezpay sign-up
Update Ezpay information (previously referred to as 'Change payment')
The Payments API features improved code and maintains the same functionality for these payment flows as previously provided by the Billing API.
The POST /Payment, POST /Payment/EzPay, and POST /Payment/Restart endpoints have been modified to add a new input parameter, PaymentOptionAmount, that allows users to provide the payment option amount that is being paid. This will simplify the calculations in the API and provide clarity in consumer applications. In addition, the PaymentOptionAmount value given in the request will be saved in the event log table under the payment_selected_amount column.
The POST /Billing/Payments/{subscriptionId}/EzPaySignup endpoint has now been replaced with a new endpoint, POST /Payment/EzPay, to create a payment method for a recurring payment (EZPay) in Circulation Systems (NCS Circ, CircPro, Saxo, and Matrix) and assign it to a subscription in Naviga System based on the below input parameters.
SubscriptionId: Unique identifier of the Subscription in Naviga System.
PaymentMethodId: Unique identifier of the payment method in Naviga System.
PaymentOptionAmount: EZPay OptionAmount that will be paid.
Donation.DonationAmount: Donation amount. Not Applicable for CircPro.
Tip.TipAmount: Tip amount.
RenewalTerm: Indicates the term to the Circulation System Provider. Applicable only for Matrix, CircPro, and NCS.
RenewalLength: Indicates the length to the Circulation System Provider. Applicable only for Matrix, CircPro, and NCS.
Note:Recurring payment (EZPay) through a bank account is not supported for Matrix clients, and any payment method other than credit card will result in a validation error.
The PUT /Billing/{subscriptionId}/PaymentMethods endpoint has now been replaced with a new endpoint, PUT /Payment/EzPay, to update the payment method for a recurring payment (EZPay) in Circulation Systems (NCS Circ, CircPro, and Matrix) and assign it to a subscription in Naviga System based on the input parameters SubscriptionId (the unique identifier of the Subscription in Naviga System) and PaymentMethodId (the unique identifier of the payment method in Naviga System).
Note:Recurring payments through a Bank Account are not supported for Matrix clients, and any payment method other than credit card will result in a validation error.
The POST /Billing/Payments/{subscriptionId}/ApplyPayment endpoint has now been replaced with a new endpoint, POST /Payment, to perform a one-time payment in Circulation Systems (NCS Circ, CircPro, and Matrix) based on the below input parameters.
SubscriptionId: the unique identifier of the Subscription in Naviga System.
PaymentMethodId: the unique identifier of the payment method in Naviga System.
DonationAmount: Donation amount. Not applicable for CircPro.
TipAmount: Tip amount.
TotalAmount: The total amount being paid (PaymentOptionAmount + TipAmount + DonationAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount).
If the PaymentType is Credit Card for NCS clients, an Activation Fee is charged to the TotalAmount.
(Total Amount for NCS = PaymentOptionAmount + TipAmount + DonationAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount + ActivationFee)
PaymentOptionAmount: The Payment Option Amount being paid.
IgnoreFee: Indicate whether the Activation Fee should be ignored. Applicable for NCS clients.
TransactionId: Transaction ID created by the Payment Gateway when creating a new Payment Method. Applicable for Matrix clients.
ProcessingFeeAmount: The Fee amount being paid. Applicable for NCS clients.
ProcessingFeeTaxAmount: The Fee tax amount being paid. Applicable for NCS clients.
Note:
The Activation Fee is only applicable to NCS clients, and the amount can be defined in MG2Control setting DTI.ActivationFeeAmount (applicable if IgnoreFee is set to false). Currently, this is taken into consideration in the TotalAmount validation only for the NCS clients.
Payments through a Bank Account are not supported for CircPro and Matrix clients, and any payment method other than Credit Card will result in a validation error.
The POST /Billing/Payments/{subscriptionId}/RestartPayment endpoint has now been replaced with a new endpoint, POST /Payment/Restart, to restart a stopped subscription in Circulation Systems (NCS Circ and Matrix) based on the below input parameters.
SubscriptionId: the unique identifier of the Subscription in Naviga System.
PaymentMethodId: the unique identifier of the payment method in Naviga System.
Donation.DonationAmount: Donation amount.
Tip.TipAmount: Tip amount.
TotalAmount: The total amount being paid (PaymentOptionAmount + TipAmount + DonationAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount - Subscription’s Balance).
PaymentOptionAmount: TheRestart OptionAmount being paid.
TransactionId: the Transaction ID generated by the payment gateway when a new Payment Method is created. Applicable only for Matrix.
RenewalTerm: Indicates the Circulation System Provider's renewal term. Applicable for CircPro and NCS.
RenewalLength: Indicates the Circulation System Provider's renewal length. Applicable for CircPro and NCS.
RestartDate: Indicates the Subscription’s Restart Date. Currently, this is applicable for CircPro and Matrix.
CreateRestartEvent: Indicates whether to create the RESTART event. For Saxo, CreateRestartEvent can be set to False if the client chooses to restart payment without restarting the subscription. Otherwise, this is optional.
ProcessingFeeAmount: Fee amount being paid. Currently, this is applicable only to NCS.
ProcessingFeeTaxAmount: Fee tax amount being paid. Currently, this is applicable only to NCS.
Implementation Notes:
For NCS Circ clients, two new MG2 control internal settings have been added to set the values for the SourceCode and the ReasonCode:
Restart.DTI.ReasonCode
Restart.DTI.SourceCode
Depending on the client, the values for the above-mentioned internal settings will change. If the client does not specify a value for these settings in the MG2 control, the default values that have been given below will be sent to the NCS Circ system.
The default value for "Restart.DTI.ReasonCode" will be "payment".
The default value for "Restart.DTI.SourceCode" will be "MG2".
The following new endpoints have been created to enable One-CSR Portal application to consume the new Payments API and some of the Billing API endpoints. Note: The new One-CSR Portal endpoints are written in bold below.
Endpoint for performing a one-time payment:
If Restart,
Post API/ApplyPayment (Old) → Post api/RestartPayment => /Payment/Restart (MicroAPI)
If not Restart,
Post API/ApplyPayment (Old) → Post api/Payment => /Payment (MicroAPI)
Endpoint for updating a payment method in Circulation Systems:
api/StartCall/updatePaymentMethod/{subscriptionId} -> Put api/updatePaymentMethod => /Payment/EzPay (Update EzPay Info MicroAPI)
Endpoint for creating a new payment method for a Subscriber:
api/CreatePaymentMethod → Postapi/PaymentMethod => Billing/PaymentMethods
Endpoint for getting a payment method from Naviga Subsvc database:
api/getPaymentMethods/{subscriberId} → Get api/getPaymentMethod => /Billing/PaymentMethods/{paymentMethodId} (MicroAPI)
Endpoint for managing the addition of Tip amount (one-time or recurring) to the Subscription amount:
Post AddTip =>POST /api/AddTipPayment
The Subscribe's PayWay, Stripe, and AuthorizeNet integrations do not support Diners Club credit card. These new endpoints have been incorporated for NCS, DSI, Matrix and CircPro clients from this release.
The endpoints of new Payments API in 3.17.0 fully replace some of the endpoints previously hosted in Billing API. Additionally, some improvements were made to the Payment Methods management within the Billing API, which involved creating new endpoints. These changes have been integrated into the SS consumer application. However, there is no change in the user experience.
EzPay SignUp flow consumes the new PaymentsAPI endpoint (all circ systems), but nothing changes in the user experience. SS has been switched to use the new Create Payment method created in the new PaymentsAPI. There is no visual impact for the existing flow.
Activation fee is applicable only for NCS clients if it is configured in MG2 Control for the specific client.
Payment through bank is not supported for CircPro and Matrix clients.
NCS clients accept recurring Tips whereas SaxoCirc (DSI) clients accept both recurring Tips and Donations. CircPro and Matrix clients accept neither Tips nor Donations.
Implementation Notes:
Subcon.Configuration
In the Payment and Restart pages, there is an optional section called PaymentOptionsSection that specifies which columns should be displayed in the payment options grid. By default, it will only show 'Term' and 'Amount'. Example:
"PaymentOptionsSection":{
The RestartInfoSummary section is deprecated (inside Restart module)
The ActivationFeeSection is deprecated (inside BankAccountSection and CreditCardSection from every BillingWidgetSection, present in payment-related pages)
CMS
New CMS contents have been introduced for each page that has a payment options grid. PaymentOptionsHeader.Term
PaymentOptionsHeader.Rate
PaymentOptionsHeader.Tax
PaymentOptionsHeader.Amount
PaymentOptionsHeader.Date
PaymentOptionsHeader.OtherCosts
PaymentOptionsHeader.IsAutoRenew
PaymentOptions.NoPaymentOptionsText
The POST /Billing/Payments/{subscriptionId}/AddTip endpoint has now been replaced with a new endpoint, POST /Payment/Tip, to handle the one-time and recurring payment transactions to add tips.
A new MG2 control internal setting, Payments.MaximumTipAmountAllowed, has been introduced for setting the maximum amount allowed for tip payment.
Implementation Notes:
A new MG2 control internal setting, Payments.MaximumTipAmountAllowed, has been introduced for setting the maximum amount allowed for tip payment.
Previously, when restarting a permanently stopped subscription in NCS Circ, the restart flow triggered an ADDSUBSCRIPTION event to restart the Subscription. In other Circ systems, such as Matrix and CircPro, the RESTARTSUBSCRIPTION event is used rather than the ADDSUBSCRIPTION event.
In order to standardize across all Circ systems, restarting a stopped subscription will now create a RESTARTSUBSCRIPTION event in NCS client databases rather than an ADDSUBSCRIPTION event.
Note:The RESTARTSUBSCRIPTION event will trigger the same request that the ADDSUBSCRIPTION event did previously in the NCS CircAPI, CreateSubscription.
Implementation Notes:
Now, the RESTARTSUBSCRIPTION event is processed with exactly the same configuration as ADDSUBSCRIPTION.
Validation checks have been implemented for all the payment-related operation flows to ensure that only payment method types acceptable to the particular circ system will be allowed for each transaction.
Single Payments:
NCS Circ: Transactions have been allowed through both a bank account and a credit card.
Saxo Circ: Transactions have been allowed through both a bank account and a credit card.
CircPro: Transactions can only be made with a credit card.
Matrix: Transactions can only be made with a credit card.
EZPay:
NCS Circ: Transactions have been allowed through both a bank account and a credit card.
SaxoCirc: Transactions have been allowed through both a bank account and a credit card.
CircPro: Transactions have been allowed through both a bank account and a credit card.
Matrix: Transactions can only be made with a credit card.
Update EZPay:
NCSCirc: Transactions have been allowed through both a bank account and a credit card.
Saxo Circ: Transactions have been allowed through both a bank account and a credit card.
CircPro: Transactions have been allowed through both a bank account and a credit card.
Matrix: Transactions can only be made with a credit card.
Restarts:
NCSCirc: Transactions have been allowed through both a bank account and a credit card.
Saxo Circ: Transactions have been allowed through both a bank account and a credit card.
Matrix: Transactions can only be made with a credit card.
Tips:
NCS Circ: Transactions have been allowed through both a bank account and a credit card.
Note: Any transactions made using other than the allowed payment methods will result in a validation error.
Flow
NCS
Saxo
CircPro
Matrix
Payment
CC/Bank
CC/Bank
CC
CC
EZPay
CC/Bank
CC/Bank
CC/Bank
CC
Update EZPay
CC/Bank
CC/Bank
CC/Bank
CC
Restarts
CC/Bank
CC/Bank
N/A
CC
Tips
CC/Bank
N/A
N/A
N/A
Given that tip and donation payments have been considered one-time charges in the Restart subscription and will always be recurring in the AutoRenew subscription, the POST /Payment/EzPay and POST /Payment/Restart endpoints have been modified to remove the input parameters, IsTipAutoRenew and IsDonationAutoRenew, from the request body.
The Payment Methods table structure has been modified as part of the refactoring of the Payments API. As a result, the token will now be mapped to the PaymentGatewayToken column rather than the BillingSystemPaymentMethodId column.
The Billing API has now been modified so that the ExternalPaymentMethodId will now be associated with the PaymentGatewayToken rather than the BillingSystemPaymentMethodId.
As part of the Payments API restructuring, the following Billing API endpoints that handle the creation and retrieval of Payment Methods have been deprecated and replaced with new endpoints with the suffix 'v2'.
To simplify calculations by ensuring that the API returns rounded values without requiring additional rounding operations in consumer applications, the Current Balance returned in the GET /Billing/AutoBill/{subscriptionId} endpoint and Processing Fees and Tax returned in the POST /Billing/CreditCards/ProcessingFee endpoint have been modified to return values with no more than two decimals.
The POST /Billing/{subscriptionId}/PaymentMethods endpoint has now been replaced with a new endpoint POST /Billing/PaymentMethods to create a new payment method for a Subscriber using either a Credit Card or a Bank Account and to create a new record in the PaymentMethod table in the database.
The Purchase API endpoint, POST /Purchases, has been updated so that the Newstart flow will create payment methods in the database based on the new Payment Method schema created as part of the Payment API refactoring.
The earlier method for Instant Access involved the API looking for eEdition Complaint events to grant Temporary Access. This method has been changed by integrating the Complaints API with the TemporaryEntitlements API. Now, when creating a complaint with eEdition access as the resolution, a new record will be added to the TemporaryEntitlements table to provide temporary access to the subscribers.
To prevent users from attempting to restart their subscriptions if they already have pending restarts in the future, a validation check has been implemented in the CheckRestartAvailability (GET /Billing/Payments/{subscriptionId}/CheckRestartAvailability) and Restart (POST /Payment/Restart) endpoints.
4. API - Billing
The GET /Billing/{subscriptionId}/PaymentMethods/{paymentMethodId} endpoint has now been replaced with a new endpoint, GET /Billing/PaymentMethods/{paymentMethodId}, to retrieve the payment method information from the Naviga System based on the provided input parameter, PaymentMethodId (the unique identifier of a payment method in Naviga System).
The GET /Billing/AutoBill/{subscriptionId} API response has now been standardized across all Circ systems to retrieve billing information for a subscription in a single array for both Regular and Stopped subscriptions.
The following output parameters will be returned in the array:
Length
Term
DatePaidThru
Rate
Tax
OtherCosts
Amount
IsAutoRenew
Following the above development, the schema of One-CSR Portal API consuming AutoBill Id has been modified to display accurate rates data in the grid for Payment, Auto renew and Restart flows.
Note:
The API GET /api/GetBillingInformation/options/{subscriptionId} will be used for Restarts from now on, while the API api/GetBillingInformation/StoppedSubscriptionPaymentOptions/{subscriptionId} will be deprecated.
When retrieving billing information for a stopped subscription in Matrix, the GET /Billing/AutoBill/{subscriptionId} endpoint has been modified to include the PeriodId (output parameters: Term and Length) in the response.
Prerequisites:Circ System & Minimum Supported Version: Matrix, 38.0.034.ITSP6
5. API - Users
The Subscribe integration with Newzware has been modified to bypass the Users API and instead utilize Proxy/Gateway to communicate directly with the Newzware API and return the required output.
A code cleanup has been done in the Users API to deprecate all Newzware-related classes.
The Users API endpoints have been updated to replace references to the Users API and integrate with the new UsersOrchestrator endpoints, GET /Users and GET Users/{UserId}. To get users, the Users API endpoints now call the UsersOrchestrator API rather than the Users API.
6. API - Entitlements
The Subscribe integration with Newzware has been modified to bypass the Entitlements API and instead utilize Proxy/Gateway to communicate directly with the Newzware API and return the required output.
A code cleanup has been done in the Entitlements API to deprecate all Newzware-related classes.
7. API - Purchase
The Purchase API endpoint, POST /Purchases, has been updated to replace references to the Users API and integrate with the new UsersOrchestrator endpoints. To get users when purchasing a new subscription, the Purchase endpoint now calls the UsersOrchestrator API rather than the Users API. The GET /Users endpoint will be used for SSOR clients, while the GET Users/{UserId} endpoint will be used for other authentication systems.
The Purchase API endpoint, POST /Purchase, has been updated to replace references to the old Entitlements API and integrate with the new Entitlements Orchestrator endpoint, POST /TemporaryEntitlements. When purchasing a new subscription, this creates a new record in the Subscribe TemporaryEntitlement’s Table.
8. API - Invitations
The Invitations API endpoint, POST Invitations/{invitationId}, has been updated to replace references to the Users API and integrate with the new UsersOrchestrator endpoint, PUT User/ (update user). To update users when creating a new invitation, the Invitations endpoint now calls the UsersOrchestrator API rather than the Users API.
9. API - UserOrchestrator
A new endpoint, GET /Users/{CustomerRegistrationId}/Links, has been added to the UserOrchestrator to retrieve the list of subscriptions associated with the Registration from the SubscriptionLinks table based on the provided CustomerRegistrationId.
The User Orchestrator now includes a new endpoint, POST /Users, which handles the workflow orchestration between the external services and the SubscribeRegistration API to create a user based on the input parameters listed below.
Email: Required;Subscriber’s email.
CustomerRegistrationId: Optional; Unique identifier for the user in the authentication provider.
EncryptedCustomerRegistrationid: Optional; Encrypted unique identifier for the user in authentication system.
Password: Optional;Subscriber’s password.
VerifyEmail: Optional; Default false. If True is provided, then the registration will not be created right away. Naviga would wait until the user confirmed the registration by clicking the link in the verification email.
ReturnUrl: Optional; URL to which users must be redirected after they have successfully verified their registration.
IgnoreProvider: Optional; If the IgnoreProvider flag is false, it executes a Create operation through the ThirdParty system (Integration). If the IgnoreProvider flag is true, it executes a Create operation through the SubscribeRegistration API (Subscribe).
FirstName: Optional; Subscriber’s first name.
LastName: Optional; Subscriber’s last name.
Metadata: Optional; Metadata must be an object in camelCase format.
The User Orchestrator now includes a new endpoint, PUT /Users/{CustomerRegistrationId}, to handle the workflow orchestration between the external services and the SubscribeRegistration API to update a user based on the input parameters listed below.
CustomerRegistrationId: Required; Unique identifier for the user in the authentication provider.
Verified: Indicates whether the user has confirmed the registration.
LastLogoutDate: Subscriber's last logout date in the Naviga platform.
RemoveLastLogoutDate: Indicates whether to remove the Subscriber's last logout date.
FirstName: Optional; Subscriber’s first name.
LastName: Optional; Subscriber’s last name.
Metadata: Optional; Metadata must be an object in camelCase format.
IgnoreProvider: Optional; If the IgnoreProvider flag is false, it executes a Create operation through the ThirdParty system (Integration). If the IgnoreProvider flag is true, it executes a Create operation through the SubscribeRegistration API (Subscribe).
The UsersOrchestrator now has a set of new endpoints to handle the Forgot Password and Change Password operations.
The Forgot Password (START) endpoint, POST /Users/ForgotPassword, has been developed to create the STARTFORGOTPASSWORD (PWDREQ) event and send an email with a link to the subscriber.
The Forgot Password (Validate) endpoint, GET /Users/ForgotPassword/{{EncryptedEventId}}/Validity, receives an EncryptedEventId and checks whether it represents a valid event for the forgot password flow.
The Forgot Password (FINISH) endpoint, POST /Users/ForgotPassword/{{EncryptedEventId}}, receives the new password to set based on an event. This will impact the AUTH system.
The Update Password endpoint, PATCH Users/{{customerRegistrationId}}/Password, updates the new password for a given CRID. This will impact the AUTH system.
The UsersAPI endpoints, POST /Authenticate and POST /AuthenticateByToken, have now been replaced with a new UsersOrchestrator endpoint, POST /Users/Authentication. This endpoint will handle the workflow orchestration between the external services and the SubscribeRegistration API to authenticate a user based on the input parameters listed below.
Login Name (Optional)
Password (Optional)
Token (Optional)
Note:Token-based authentication will only be applicable for Auth0 clients.
The following UserOrchestrator endpoints have been integrated with the Subscription Panel to create, update, and retrieve user data.
GetUser API (/v4/Users?email={email})
CreateUser API (/v4/Users)
Authentication API (/v4/Users/Authentication)
Forgot password API (/v4/Users/ForgotPassword)
GetUserByCRID API (/v4/Users/{customerRegistrationId}/?ignoreProvider={boolean})
UpdateUser API (/v4/Users/{customerRegistrationId}):
The UserInformationV3 component should be included in the presentation in CMS.
The GET /Users endpoint has been enhanced to allow the API to filter the user data in the Subscribe Registration based on the metadata fields.
To search using the metadata:
Since it is a dictionary query parameter, each "Key-Value" pair must be sent individually with the prefix "metadata."
For example, if the purpose is to filter users based on their first and last names, the query string will be: "https://UrlBase/Users?metadata.firstName=FirstName&metadata.lastName=LastName”.
When an Email is provided:
the lookup will be performed in Auth system and only one record will be returned.
either pass an Email or encrypted email in the request since the email parameter passed will override the encrypted email value.
When the Metadata is provided:
no more than 10 metadata parameters should be sent.
In addition, each Key and Value of the metadata parameter should not exceed 100 characters.
while creating data, the metadata parameters should be passed in the string type. passing the value as Array will be saved but the GET /Users endpoint will not fetch the data.
In addition, the workflow has been changed to avoid searching for users based on both the Email AND Metadata. if both values are provided, a validation error will be returned.
When an email is provided:
The lookup will be performed in the Auth system, and only one record will be returned.
Either pass an email or encrypted email in the request since the email parameter passed will override the encrypted email value.
When the metadata is provided:
No more than 10 metadata parameters should be sent.
In addition, each Key and Value of the metadata parameter should not exceed 100 characters.
While creating data, the metadata parameters should be passed in the string type. Passing the value as an array will save it, but the GET /Users endpoint will not fetch the data.
In addition, the workflow has been changed to avoid searching for users based on both email and metadata. If both values are provided, a validation error will be returned.
Changes have been made to the Get User by ID endpoint, GET /Users/UserId/, so that if the input parameter, IgnoreProvider, has been set to True, users will be able to get the details of a user based on both the Email and Metadata fields provided at the same time since the data search will be within the database.
If the IgnoreProvider parameter has been set to False, Email and Metadata fields cannot be accepted at the same time, and the API will return a validation error.
The Get Subscription Links endpoint, GET /Users/{CustomerRegistrationId}/Links, has been updated to return a set of additional output parameters in the SubscriptionInfo object of the API response, which have been listed below.
First Name: The user's first name
Last Name: The user's last name
ServiceTypeInfo (Core object): Includes the details of the service type of the subscription.
EZPay: Indicates whether the subscription has EZPay enabled.
AddressInfo (Core object): Includes the address details of the subscriber.
NewspaperInfo (Core object): Includes the details of the subscribed newspaper.
Subscription Kind: Indicates the kind of subscription, such as trial, complimentary, gift, etc.
The Auth0 API has been integrated with the UsersOrchestrator to handle requests against Auth0 services.
This integration also includes few changes in UsersOrchestrator endpoints as follows:
Create User endpoint (POST /Users):
UsersOrchestrator will execute the create flow with the prefix "nav" for Custom Customer Registration ID (internal ID) for clients with custom implementations, i.e., if the value of MG2 control flow setting "Flow.Auth0.IntegrationType" has been set to 'Custom'. If the value is not "Custom," the normal flow will be executed by UsersOrchestrator.
When creating a passwordless user, UsersOrchestrator will generate a dummy password and the proper Change Password URL.
Get User By Id endpoint (GET /Users/{UserId}):
UsersOrchestrator will execute the GET operation with Custom Customer Registration ID (internal ID) as the QueryString parameter for clients with custom implementations, i.e., if the value of the MG2 control flow setting, "Flow.Auth0.IntegrationType", has been set to 'Custom'. If the value is not "Custom," the normal flow will be executed by UsersOrchestrator.
Implementation Notes:
The following setting will be used for the business selection:
SettingKey = Flow.Auth0.IntegrationType
SettingValue = Custom
SettingType = Flow
New class:
Auth0CustomCreateOrchestrator
Auth0CustomGetByIdOrchestrator
Validation checks have been implemented in the Metadata fields of the POST /Users and
PUT /Users/{CustomerRegistrationId} endpoints to make sure that the value provided is in an acceptable format.
When providing the Metadata,
The Metadata key should not be more than 100 characters long.
Non-object values of the Metadata parameter cannot be more than 100 characters long.
These validations will also be applicable to nested properties.
A new endpoint, PATCH /Users/{{CustomerRegistrationId}}/Email, has been developed to update the email of a Subscribe Registration in SubCon and the Auth System.
The workflow for updating the email address of a Subscribe Registration will be as follows:
The UsersOrchestrator executes a GetById operation (GET /Users/{UserId}) through the third-party or the SubscribeRegistration API.
The UsersOrchestrator then executes an Update Email operation (PATCH /Users/{{CustomerRegistrationId}}/Email) through the ThirdParty/SubscribeRegistration API.
This will create a CHGEMAIL event for all the normal cases.
For Firefly tenants,
If the new email does not exist in Firefly, a simple update email for the existing user will be required. The CHGEMAIL event will also be triggered in this instance.
If the new email exists in Firefly, a TRANSFERLICENSE event must be triggered for each linked subscription in order to transfer the link from the old email to the new email.
The UsersAPI endpoint, POST /User/VerifyEmail, has now been replaced with a new UsersOrchestrator endpoint, POST /Users/Verification, to perform the email verification operation based on the provided email and the verification code.
A new endpoint, POST /Users/VerificationCode, has been developed to send or resend a Verification Code by email so that users can click on the verification link provided in the email in order to start using their new registration.
Implementation Notes:
Email for Event 670 needs to be set up in the One-CSR portal.
When carrying out CRUD operations, the FirstName and LastName properties will be added to the root of the User object instead of being part of the Metadata.
The UserOrchestrator API has been updated to include the registration status in the API response.
The GET /Users and GET /Users/id endpoints have been updated to include a new output parameter, State, which returns the status of a registration.
The registration's status will be returned as follows:
If the tenant has been associated with a third-party authentication system such as Auth0, Firefly, etc., the State will be returned as Standard.
If the tenant has been associated with MG2 Auth:
When the Password field in the database remains blank, the State will be Lite.
When the Verified field in the database has been set to False, the State will be Unverified.
When the Password field hasn't been blank and the Verified field has been set to true, the State will be Standard.
The POST /Users endpoint has been modified to display an error when trying to create a registration that already exists in the database and has the Verified field set to false.
The POST /Users/Authentication endpoint has been modified to display an error when trying to login with an Unverified or Lite registration.
A new endpoint, PATCH /Users/{CustomerRegistrationId}/CustomerRegistrationId, has been developed to update the CustomerRegistrationId (CRID) of a Subscribe Registration in the database.
The workflow for updating the CRID of a Subscribe Registration will be as follows:
Based on the CRID provided in the API request path, the UsersOrchestrator performs a GetById operation (GET /Users/UserId) through the SubscribeRegistration API. The flow will be terminated if the provided CRID does not exist in the database.
Based on the CRID provided in the API request body, the UsersOrchestrator performs another GetById operation (GET /Users/UserId) through the SubscribeRegistration API. The flow will be terminated if the provided CRID does not exist in the database.
The Update CRID endpoint updates the record found in the database with the information retrieved by the Provider.
If both the CRID and the EncryptedCRID have been provided, the API will update both values in the database.
If only the CRID has been provided, the API will calculate the EncryptedCRID and update both values in the database.
If only the EncryptedCRID has been provided, the API will return a validation error since the CRID must be provided.
In the old Users API, a few endpoints were based on RegistrationID, while others were based on CustomerRegistrationID. However, in the new Users Orchestrator API, all endpoints use the CustomerRegistrationID as the main key for finding a registration. As a result, changes have been made to replace the parameter, RegistrationID, in the old APIs with CustomerRegistrationId.
The following APIs have been updated:
MessagingAPI
In the GetCampaignEmails endpoint, RegistrationId has been replaced with CustomerRegistrationId. The CustomerRegistrationId will then be used to filter the Campaign Messages in the database Store Procedure. This change has no impact on the existing functionality.
InvitationsAPI
In the CreateInvitation endpoint, HostUserId has been replaced with HostUserCRID. The HostUserCRID is then utilized in the database Store Procedure without impacting the existing functionality. In addition, events will now be created by providing the EventData with a CustomerRegistrationId instead of a RegistrationId.
ComplaintsAPI
In the CreateComplaint endpoint, RegistrationId has been replaced with CustomerRegistrationId. The events will now be created by providing the EventData with a CustomerRegistrationId instead of a RegistrationId.
Note:The logic for populating registration's info fields will now be based on the CustomerRegistrationId, instead of the existing logic using RegistrationId (ApiCreateEventLog).
Changes have been made at the application level in the Users Orchestrator such that each operation now triggers its own event, so that the Event Log has a clear picture of everything that takes place either in the AuthSystem or in the DB, regardless of the AuthSystem that tenant has been configured for.
Implementation Notes:
The new events created for UsersOrchestrator no longer require the trigger_post/newspapereventprocessorassignments configuration. However, the new events still require email configuration if needed.
Metadata properties such as DisplayName, OptOutMarketing, and AgreeToTerms will be part of the CreateUser endpoint in the UserOrchestrator API for Mg2Auth, Auth0 and SSOR user authentication system, starting from this release. When a new user is created following a subscription purchase from SP, the API request body will now include these metadata properties along with other parameters such as FirstName, LastName, etc. The FirstName, LastName, and metadata will be stored in the Registrations Table of the Subsvc database.
This is applicable only to creating a new user or updating an existing user. Display Name and Full Name will be displayed in the Users section of SubCon Admin.
In this release, the SS application has been enabled to utilize the new set of endpoints in the UserOrchestrator API, replacing the old Users API. Importantly, these enhancements do not result in any visual impact for users.
Some of the valid changes as part of this development are listed as follows:
Previously a single endpoint served multiple operations such as changes to Email, Password and Profile information. With the new API, separate endpoints have been dedicated for each transaction.
When changing an Email, the new endpoint PATCH /Users/{{CustomerRegistrationId}}/Email is used now. Note: The client GCI that was using Transfer Links endpoint earlier has switched to use this new endpoint.
While changing password, the endpoint PATCH Users/{{customerRegistrationId}}/Password is used.
When changing any of the Profile fields, the endpoint Update User is used, saving the fields within the Metadata.
Cookie values will only be returned by Authenticate endpoints. Consequently, the Verify flow can no longer authenticate the user. As part of the new enhancement, the verification flow has been tweaked. Once email verification is done, users are prompted to login by entering their credentials. This ensures a seamless and secure authentication process.
Implementation Notes:
Create User:
If the IgnoreProvider flag is false, it executes a GetByEmail operation through the ThirdParty system (Integration) and a Create operation through the ThirdParty system (Integration) and the SubscribeRegistration API (Subscribe).
If the IgnoreProvider flag is true, it executes a Create operation through the SubscribeRegistration API (Subscribe).
If the IgnoreProvider flag is false, it executes an update operation through the ThirdParty system (Integration) and the SubscribeRegistration API (Subscribe).
If the IgnoreProvider flag is true, it executes an update operation through the SubscribeRegistration API (Subscribe).
The following setting will be used for the business selection:
SettingKey = Flow.Auth0.IntegrationType
SettingValue = Custom
SettingType = Flow
New class:
Auth0CustomCreateOrchestrator
Auth0CustomGetByIdOrchestrator
The new events created for UsersOrchestrator no longer require the trigger_post/newspapereventprocessorassignments configuration. However, the new events still require email configuration if needed.
10. API - Gateway
When linking a subscription or changing a user's details in the registration, the logic used to be to create a UPDATEOCCUPANT event to maintain the subscriber details in sync with the Auth and Circ systems. Changes have been made to remove this logic and to not change the occupant details when changing a user's information through the Update Registration (PUT /User ) and Link Owner (POST /User/OwnerUser) endpoints.
11. API - Proxy
The Proxy API has been modified to handle requests for both the old Entitlements API and the new Entitlements Orchestrator API listed below.
Post Access (POST /Access)
Post TemporaryEntitlement (POST /)
Get Access (GET /Access)
In order to redirect to EntitlementsOrchestratorAPI, ProxyAPI must have the following settings in place:
MG2 Control Internal setting, EntitlementsOrchestrator - Its value includes a "string.Format" that must be utilized to determine the correct API route. The value by default is "{0}/EntitlementsOrchestrator/".
Note:Since the ProxyAPI directly calls the EntitlementsOrchestratorAPI, GatewayAPI is not involved in the request chain.
Implementation Notes:
If the error message— "Procedure or function 'ApiGetEntitlementAccessByCustomerRegistrationId' expects parameter '@EntitlementId', which was not supplied." has been returned, the Proxy API should be pointing to EntitlementsOrchestrator.
The following endpoints have been removed from the UsersAPI and GatewayAPI. In addition, changes have been made in the Proxy API so that if a client that has upgraded to 3.17 attempts to access any of these endpoints, an error message stating that the endpoint has been deprecated will be displayed.
POST User/ByToken/ (GetUserFromTokenContent)
GET User/Encrypted/{type} (encrypted crid)
GET User/Encrypted/
GET User/{customerRegistrationId}/{type}
GET User
POST User
PUT User
PUT User/{customerRegistrationId}
POST User/Passwordless
POST Authenticate
POST AuthenticateByToken
POST ForgotPassword
POST ForgotPassword/Validity
POST ForgotPassword/ChangePassword
POST User/TransferLinks
Implementation Notes:
MG2 Control Flow Setting, Flow.Users.RedirectToOrchestrator should be configured correctly.
The Post/DigitalAccess endpoint has been removed from the Entitlements and Gateway APIs. In addition, changes have been made in the Proxy API so that if a client that has upgraded to 3.17 attempts to access this endpoint, an error message stating that the endpoint has been deprecated will be displayed.
Previously, the ProxyAPI handled tenant version selection as well as request redirection to the GatewayAPI, which sometimes acts as an orchestrator and sometimes does not, but always routes requests to internal services.
As part of the Subscribe API refactoring, the old internal services have been migrated and moved to new ones using the orchestrator paradigm, allowing signatures to be created or modified and the output model to be modified in terms of ProxyAPI.
A set of new endpoints has been created with the prefix “v4” as listed below:
v4_DirectIntegration
v4_Entitlements
v4_Subscriptions
v4_Users
Versions 3.17.0 and higher:
ProxyAPI will support both the new and old endpoints.
The ProxyAPI will route requests to the relevant OrchestratorAPI for new endpoints with Prefix v4.
The ProxyAPI will redirect requests to the GatewayAPI for old endpoints (for backwards compatibility with older versions).
The Proxy API has been modified to return Headers (X-SessionId, X-RequestId, and X-Version) in the response headers as well as the correct Status Code (200, 400, 401, 404, 500, 502, etc. ) in the response status.
12. API - Ping
A new endpoint, GET /ping, has been developed so that the Naviga monitoring tool can keep monitoring to check whether an API is down.
Affected Endpoints:
Auth0
BPay
DirectIntegration
EntitlementsOrchestrator
MailingOrchestrator
Melissa
NavigaPay
SubscribeEmails
SubscribeEntitlements
SubscribeEvents
SubscribeRegistration
SubscribeRegistrations
SubscribeSubscriptionLinks
SubscribeSubscriptions
SubscriptionsOrchestrator
UsersOrchestrator
13. API - Subscriptions
The Subscriptions.HHSubscriptionLevel column in the Subscriptions table has been renamed to HouseHoldLevelId to establish a foreign key with the HouseHoldLevels table.
The Subscriptions API endpoints GET /Users/{customerRegistrationId}/Subscriptions, GET /Subscriptions, and GET /Subscriptions/{subscriptionId} have now been modified to display the values in the API response based on the renamed property, HouseHoldLevelId.
Modified endpoints:
GET /Users/{customerRegistrationId}/Subscriptions
GET /Subscriptions
GET /Subscriptions/{subscriptionId}
The PUT /Subscriptions/{subscriptionId} endpoint has been modified to include a new input parameter, PaymentMethodId, which allows a payment method to be assigned to the subscription in order to process the transaction.
14. API - Gateway
The GET /Settings/{settingkey} endpoint in the Gateway API has been deprecated because it duplicates with another endpoint, GET /Settings/, and requires the input parameter SettingKey to be provided as a PathString rather than a QueryString. The endpoint GET /Settings/ will now be utilized instead of the deprecated GET /Settings/{settingkey} endpoint.
The Apply Payment endpoint, POST /Payment, has now been added to the PaymentsController in the Gateway and Proxy API.
Previously, the Proxy and Gateway projects included input and output models for each request executed; however, they are no longer in use. Changes have been made to replace the input/output models for Proxy and Gateway projects with objects, preventing custom logic and parameters from being provided in the URL.
15. Naming Convention from PascalCase to camelCase
To maintain the consistency across applications, the naming convention of the metadata objects for all endpoints in the Invitation API has been changed from PascalCase to camelCase. This modification has no visual impact on users engaging in Invitation flows. The Invitation flows will continue to function as earlier. Invitations can be sent and accepted successfully, and users can be registered with all the provided information.
16. User session maintenance in SS and SP
For MG2Auth clients, when Sign in/Sign up happens on Self-Service Portal, Subscription Panel, or any .com site (auth managed by Connext) the following cookies will be created on the root domain:
igmRegID
igmContent
igmAuth
The primary purpose of these cookies is to maintain the Single Sign-On between SS, Subscription Panel, and the .com site. The igmRegID cookie stores the encrypted Customer Registration ID.
In a recent development, the endpoint in the old Users API used to look up a user by the Encrypted Customer Registration ID was deprecated. However, for MG2Auth clients, the cookie value was crucial for recovering the user session. With the deprecation of the endpoint, it became challenging for MG2Auth clients to look up the user (since the cookie value was encrypted) and recover or maintain the user session between SS, SP, and .com site.
Instead of reinstating the old endpoint, the decision was made to add a new parameter in the Get Users endpoint. This new parameter will be included in the search criteria to facilitate the required functionality.
Starting from this release, the GET /Users endpoint in the User Orchestrator API will introduce a new parameter: EncryptedCustomerRegistrationId. To ensure consistency across all applications, SS will no longer decrypt the igmRegId cookie value for MG2 Auth clients. The encrypted cookie value will be considered as-is and will be utilized at the GET /Users endpoint in the User Orchestrator API to retrieve user details and recover the user session.
With this enhancement, a user logged into SS and SP with MG2 Auth will no longer be logged out upon reloading the page. This improvement enables the successful maintenance of user sessions.
Implementation Notes:
The User Information V3 component should be present in the presentation. The user can configure the properties by going to:
In the Clear Cache API calls, a new header parameter, X-SourceSystem, has been added as a required field with the value CMS for all the clients.
In addition, the X-MediaGroupCode header parameter has been changed to X-ClientGroupCode.
2. CMS Content Module Changes
3. New endpoint to monitor the health of CMS
The CMS API now includes a new endpoint, ping, for monitoring the performance of the CMS application. The application's status can be monitored using the Status/Ping route details.
SP
1. Performance Optimizations
On the subscription panel, performance issues caused by render-blocking resources such as CSS and JS files on the UI side have been resolved. To prevent the issue, the render-blocking resources will now be preloaded or loaded in an asynchronous manner.
In addition, the "commonResource" and "commonResourceBody" pug files have been included in the layout pug file in order to allow for multiple GTM script additions as well as the ability to add a script in the body of the pug.
2. Purchase API
When purchasing a subscription in SP through AuthorizeNet, changes have now been made to modify the way parameters have been sent in the CreatePaymentMethod through the Purchase microAPI.
The value of the parameter "ExternalPaymentMethodId" in Purchase microAPI will now have the value of the parameter "CustomerPaymentProfileId" in EndPaymentSession API.
In addition, a new parameter, "ExternalCustomerId," has been introduced to the Purchase microAPI, which will have the value of the EndPaymentSession API parameter, "CustomerProfileId."
Implementation Notes:
Credit card option should be checked for particular offer group id in SolCon.
Credit Card AuthorizeNet component should be there in the presentation.
SubCon DB
1. Optimization in Stored procedure
The Stored Procedure ApiGetActiveSubscriptionByCustomerRegistrationId is optimized now. The ‘where’ clause in the stored procedure was not optimized and hence it was taking time to execute. After the optimization rework, the performance of stored procedure is enhanced, and cost of execution is reduced.
2. Subsvc - Registrations Clean up
The Registrations table has undergone cleanup to align with the fields decided for mapping in the new Users Orchestrator API.
The list of columns after the cleanup are as follows:
RegistrationId
CustomerRegistrationId
EncryptedCustomerRegistrationId
EmailAddressId
NameFirst
NameLast
LoginPassword
VerificationCode
Verified
Metadata
LastLogoutDate
AddDate
AddSource
ChangeDate
ChangeSource
Additionally, with the help of a script, data has been moved into the Metadata before deprecating the columns from Subs. The following changes have been done.
Some discrepancies in the Database that were causing data issues have been fixed by altering the schema. There is no impact on the end user.
4. Subsvc - Script to migrate from old User to new UserOrc Event Types
As part of the API Refactor and the development of the new Users Orchestrator API, an entirely new set of Event Types have been introduced to replace the previous event types associated with transaction emails and were triggered by the old User API endpoints. A post-deployment script has been created to assign the TransactionEmail to the new event types, ensuring the successful sending of transaction emails when the corresponding new events are triggered. After deployment, TransactionEmails (that are configured under 'Event management > Event types emails' against each Event ID in One-CSR Portal) will be assigned to new event types.
The following event types are the ones that got replaced by the new ones:
Old Event Types with Event ID
New
CREATELOGIN 68
SUBSCRIBE_USER_CREATE 4002
VERIFYCODE 670
SUBSCRIBE_USER_CREATEPENDING 4003
PWDREQ 64
SUBSCRIBE_USER_STARTFORGOTPASSWORD 4009
Implementation Notes:
A script has been incorporated into the DACPAC (Data-tier Application Component Package) to replace the old event types with the new ones.
Sync Jobs
1. Payment Method Changes
A new version of the 'Create Payment Method' endpoint, previously part of the Billing API prior to 3.17.0, has been introduced in the new Payments API starting from version 3.17.0. To ensure synchronization between Sync jobs and the API refactor, the following modifications have been made:
The input model has been streamlined to only receive the essential payment information (masked in case of CC), Payment gateway token, and customer ID (if the Payment gateway exposes it).
The PaymentMethods table has been revamped retaining only the columns that are essential.
There will no more relationship between Subscriber and PaymentMethods table. This means that, there will be only one payment method associated to each subscription (Subscription already has a Foreign Key to PaymentMethod table).
In the new logic, Sync jobs will perform the following:
If a new Subscription record has to be created, its corresponding PaymentMethod record will be created.
If it's an EZPay Subscription, the Payment Method will be populated with the Autorenew information the corresponding subscription already has.
If it's NOT an EZPay Subscription, the Payment Method will be populated with the most recent Payment done by that Subscription.
For existing Subscriptions, the sync job will assure that the information is correctly updated.
The current info (CC, BK, etc) will be compared with the information exposed in the file. If there is any change, the Subsvc record will be updated. Whenever an update occurs, the PaymentGatewayToken and PaymentGatewayCustomerId columns wil be updated to NULL.
2. Subsvc Registrations Table Schema Changes - Impact on OI, Discover & Other jobs
As part of the 3.17.0 Refactor, the Registrations table in Subsvc DB underwent cleanup so as to map the fields correctly to the new Users Orchestrator API introduced in this release. Some columns are retained, some are moved to Metadata field whereas a few are deprecated.
These modifications have eventually led to database schema changes. These changes were implemented in sync jobs to ensure effective data synchronization, subsequently reflecting correctly in OI DB, and from there, propagating to Subscribe DB.
Future Enhancements
1. PayTrace Integration through NavigaPay
The payment provider PayTrace has been successfully integrated with NavigaPay. Now it is possible to successfully complete payment transaction with PayTrace through NavigaPay from SP and Self-Service Portal. In the payment iFrame provided by PayTrace, the user can enter a credit card number with a maximum of 19 digits in the Credit Card field. The CVV number can have a maximum of 4 digits in the CVV field (4 digits of CVV is for AMEX cards).
NOTE: PayTrace does not support special characters in the User name field. If a user enters any special character in the User name field, the system will throw an error.
If the user is browsing in Incognito mode, then third-party cookies must be allowed in the Chrome settings to load NavigaPay PayTrace. To enable third-party cookies on the browser perform the following steps:
Chrome > Settings > Privacy & Security > Third-party cookies > Allow third-party cookies.
This integration was achieved through enhancements made to the Subscription Panel, CMS and Self-Service Portal. The details of these application-specific enhancements are provided below:
PayTrace Integration - CMS Configurations
A new CMS component NavigaPayPayTraceV3 has been introduced with the following properties.
The users can configure the properties by going to:
CMS > Subscription Panel > Presentation (Choose a valid presentation) > Page V3 > Step V3 > PaymentMethodsV3 > NavigaPay PayTrace V3
PayTrace style Customization
The style of PayTrace iFrame has been customized and matched with the look and feel of the Self-Service Portal and Subscription Panel.
Implementation Notes:
Client using NavigaPay with PayTrace should contain a CSS file of a particular theme.
For customizing PayTrace iFrame style, the following list of MG2 Control API setting keys must be in place:
SubscriptionPanel.NavigaPay.SiteCode = cvpaytrace
SubscriptionPanel.NavigaPay.SiteKey = fred
SubCon.NavigaPay.FieldOptionalString
SubCon.NavigaPay.LabelString
SubCon.NavigaPay.SubmitButtonString
SubCon.NavigaPay.CurrentCSS
2. API
2.1. API - Payments (DSI)
The POST /Billing/Payments/{subscriptionId}/ApplyPayment endpoint has now been replaced with a new endpoint, POST /Payment, to perform a one-time payment in Circulation Systems (Saxo) based on the below input parameters.
SubscriptionId: the unique identifier of the Subscription in Naviga System.
PaymentMethodId: the unique identifier of the payment method in Naviga System.
DonationAmount: Donation amount.
TipAmount: Tip amount.
TotalAmount: The total amount being paid (PaymentOptionAmount + TipAmount + DonationAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount).
PaymentOptionAmount: The Payment Option Amount being paid.
IgnoreFee: Indicate whether the Activation Fee should be ignored. Applicable for NCS clients.
TransactionId: Transaction ID created by the Payment Gateway when creating a new Payment Method. Applicable for Matrix clients.
ProcessingFeeAmount: The Fee amount being paid. Applicable for NCS clients.
ProcessingFeeTaxAmount: The Fee tax amount being paid. Applicable for NCS clients.
Note:
The Activation Fee is only applicable to NCS clients, and the amount can be defined in DTI.MG2Control setting ActivationFeeAmount (applicable if IgnoreFee is set to false). Currently, this is not taken into consideration in the TotalAmount validation.
The POST /Billing/Payments/{subscriptionId}/RestartPayment endpoint has now been replaced with a new endpoint, POST /Payment/Restart, to restart a stopped subscription in Circulation Systems (Saxo) based on the below input parameters.
SubscriptionId: the unique identifier of the Subscription in Naviga System.
PaymentMethodId: the unique identifier of the payment method in Naviga System.
Donation.DonationAmount: Donation amount.
Tip.TipAmount: Tip amount.
Donation.IsDonationAutoRenew: Indicates whether the Donation amount should be auto-renewed. Applicable only for Saxo.
Tip.IsTipAutoRenew: Indicates whether the Tip amount should be auto-renewed. Applicable only for Saxo.
TotalAmount: The total amount being paid (PaymentOptionAmount + TipAmount + DonationAmount + ProcessingFeeAmount + ProcessingFeeTaxAmount - Subscription’s Balance).
PaymentOptionAmount: TheRestart OptionAmount being paid.
TransactionId: the Transaction ID generated by the payment gateway when a new Payment Method is created. Applicable only for Matrix.
RenewalTerm: Indicates the Circulation System Provider's renewal term. Applicable for CircPro and NCS.
RenewalLength: Indicates the Circulation System Provider's renewal length. Applicable for CircPro and NCS.
RestartDate: Indicates the Subscription’s Restart Date. Currently, this is applicable for CircPro and Matrix.
CreateRestartEvent: Indicates whether to create the RESTART event. For Saxo, CreateRestartEvent can be set to False if the client chooses to restart payment without restarting the subscription. Otherwise, this is optional.
ProcessingFeeAmount: Fee amount being paid. Currently, this is applicable only to NCS.
ProcessingFeeTaxAmount: Fee tax amount being paid. Currently, this is applicable only to NCS.
The POST /Billing/Payments/{subscriptionId}/EzPaySignup endpoint has now been replaced with a new endpoint, POST /Payment/EzPay, to create a payment method for a recurring payment (EZPay) in Circulation Systems (Saxo) and assign it to a subscription in Naviga System based on the below input parameters.
SubscriptionId: Unique identifier of the Subscription in Naviga System.
PaymentMethodId: Unique identifier of the payment method in Naviga System.
PaymentOptionAmount: EZPay OptionAmount that will be paid.
Donation.DonationAmount: Donation amount.
Tip.TipAmount: Tip amount.
Donation.IsDonationAutoRenew: Indicates whether the Donation amount should be auto-renewed. Applicable only for Saxo.
Tip.IsTipAutoRenew: Indicates whether the Tip amount should be auto-renewed. Applicable only for Saxo.
RenewalTerm: Indicates the term to the Circulation System Provider. Applicable only for Matrix, CircPro, and NCS.
RenewalLength: Indicates the length to the Circulation System Provider. Applicable only for Matrix, CircPro, and NCS.
The PUT /Billing/{subscriptionId}/PaymentMethods endpoint has now been replaced with a new endpoint, PUT /Payment/EzPay, to update the payment method for a recurring payment (EZPay) in Circulation Systems (Saxo) and assign it to a subscription in Naviga System based on the input parameters SubscriptionId (the unique identifier of the Subscription in Naviga System) and PaymentMethodId (the unique identifier of the payment method in Naviga System).
2.2. API - Subscribe Subscriptions
A new endpoint, GET /Subscriptions/{SubscriptionId}, has been developed to retrieve the complete details of a particular Subscription based on the provided input parameter SubscriptionId.
A new endpoint, GET /Subscriptions, has been developed to retrieve a paginated list of Subscribe Subscriptions.
2.3. API - SubscriptionsOrchestrator
A new orchestration API, GET /Subscriptions/{SubscriptionId}/Links, has been developed to handle the workflow orchestration between the external services and the SubscribeSubscriptionLinks API. The API retrieves the list of Registrations associated to the Subscription in SubscriptionLinks table based on the input parameter SubscriptionId.
A new orchestration API, GET /Subscriptions/{SubscriptionId}/LinksInformation, has been developed to handle the workflow orchestration between the external services and the SubscribeSubscriptionLinksInformation API. The API retrieves the Subscription.DefaultOwnersLimit and Subscription.DefaultGuestsLimit configured for a Tenant based on the input parameter SubscriptionId.
A new orchestration API, GET /Subscriptions, has been developed to handle the workflow orchestration between the external services and the SubscribeSubscriptions API. The API retrieves a paginated list of subscriptions based on the provided user’s details (First or Last name, account number, Email, Phone, etc.).
A new orchestration API, GET /Subscriptions/{Id}, has been developed to handle the workflow orchestration between the external services and the SubscribeSubscriptions API. The API retrieves a paginated list of subscriptions based on the provided ID (Subscribe SubscriptionId).
Implementation Notes:
A new MG2 control internal setting, SubscriptionsOrchestrator, has been added.
The below two new MG2 control internal settings have to exist in MG2 Control.
Subscription.DefaultOwnersLimit: The maximum number of Links that can be set for Owner Type is defined by this setting.
Subscription.DefaultGuestsLimit: The maximum number of Links that can be set for Guest Type is defined by this setting.
2.4. API - Subscribe Subscription Links
A new endpoint, GET /SubscriptionLinks, has been developed to retrieve the Subscribe Subscription Links based on the input parameters CustomerRegistrationId, RegistrationId, and SubscriptionId. In order to obtain the details, at least one of the aforementioned input parameters must be provided.
A new endpoint, POST /SubscriptionLinks, has been developed to create a new Subscribe Subscription Link in the SubscriptionLinks Table based on the input parameters CustomerRegistrationId, SubscriptionId, and TypeLink (OWNER or GUEST).
A new endpoint, PUT /SubscriptionLinks/{subscriptionLinkId}, has been developed for modifying the Subscribe Subscription Link in the SubscriptionLinks Table based on the input parameter SubscriptionId.
A new endpoint, DELETE /SubscriptionLinks/{subscriptionLinkId}, has been developed to delete a Subscription Link from the SubscriptionLinks Table based on the input parameter SubscriptionId.
A new endpoint, PUT /SubscriptionLinks/{SubscriptionLinkId}/Transfer, has been developed to update the CustomerRegistrationId of a Subscription Link in the SubscriptionLinks Table based on the input parameter CustomerRegistrationId.
Implementation Notes:
A new event_type_id, UPDATELINK event_type, has been added in subcon.database.
2.5. API - Subscriptions
The GET /Subscriptions/subscriptionId/Cancelled endpoint has been integrated with the PermStop CircAPI so that the Subscribe API now creates and processes the GETPERMANENTSTOP event to retrieve the real-time scheduled stops for a given subscription instead of consuming the data from the Subsvc database when checking the status during the cancellation of a subscription in NCS Circ.
The GET /Subscriptions/subscriptionId/Cancelled endpoint has been integrated with the getFutureChanges CircPro LawAPI so that the Subscribe API now creates and processes the GETPERMANENTSTOP event to retrieve the real-time scheduled stops for a given subscription instead of consuming the data from the Subsvc database when checking the status during the cancellation of a subscription in CircPro.
The GET /Subscriptions/subscriptionId/Cancelled endpoint has been integrated with the CancellationListID MatrixAPI so that the Subscribe API now creates and processes the GETPERMANENTSTOP event to retrieve the real-time scheduled stops for a given subscription instead of consuming the data from the Subsvc database when checking the status during the cancellation of a subscription in Matrix.
Prerequisites:
Circ System & Minimum Supported Version:
CircPro, 2021-3.0
Matrix, 38.0.034.ITSP6
If you are upgrading to Subscribe version 3.17.x and utilizing the Subscribe /Authenticate, /DigitalAccess or other endpoints in the Billing, Users, and Entitlements micro APIs, then there are breaking changes. For the full list of changes, please review the API Migration .
The release notes for the internal stakeholders can be found in (access required).
The detailed Implementation settings for NavigaPay integration is available here:
The footer page of the CMS Content Module has been changed from Visual Basic .NET () to NET Framework 4.8 (.NET 4.8).
Further details are available here: ColumnMigratorApp →
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
In this section you can find Release notes for the latest Subscribe releases
NCS Circ Service Packs
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
This section contains information about NCS Circ versions and service packs.
Please note that for all new clients minimum version required is 2020.2-1
NCS 2020.2-1 will include all the service packs initially issued for 2018.5
3.16.1.X Hotfixes
This page containes the description of the hotfixes related to 3.16.1 version
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Please note that all the 3.16.1.X hotfixes are by default included in both the next minor and major versions, which are 3.16.2 and above and 3.17.0, respectively.
If you want the fix to be applied please input a Salesforce case.
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Bug fixes and general enhancements
Subscription search against Company name in One CSR Portal
Subscription search against company name is now available in One CSR Portal. The Company field is enough to perform the search. Search is done based on 'contains'
To enable the Company name field please set the SubscriberSearchCompanyNameOption MG2 control setting for a certain client to 1. By default the field is hidden (value = 0).
Customer details included in Payment Token for Matrix
Both Payment & Customer details are now included in the Payment Token for a new start in Matrix circ system. This fixes the 3.16.1 issue of Customer details being omitted. Matrix version required is 30.00.034.ITSP5.
Bulk Delete for Corporate Subscriptions in One CSR Portal
Unwanted registrations can be deleted by CSR in one go. During the bulk import of registrations from CSV file, the registrations that do not exist in the newly uploaded file will be removed from the database. Please note that The 'Import from CSV' button is only available for Subscription Kind 'Lite'.
Registration creation for Auth0
Users receiving invitations to corporate subscriptions can now create registrations in Auth0. The button from the invitation will redirect them to the Auth0 modal window showing the Signup tab. When the user enters the relevant credentials, the confirmation is received through email and also displayed in Account Management. To turn this on please set Auth0.App.CanRegister mg2control setting to False.
Areas covered
API, One CSR Portal
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Bug fixes & general enhancements
Removal of unnecessary special characters (NCS Circ specific)
Whenever a subscription/subscriber related API call is made to NCS Circ, the special characters from the following parameters will be discarded before submitting the request with an exception mentioned against each:
First Name: ' - & / .
Last Name: ' - & / .
Cardholder Name: ' - & / # .
House number: / -
Unit number: No Special Chars
Email: @. + - _ ,
When testing email please keep in mind that there is also standard API validation in place:
only one special character is allowed per email
special character cannot be the last one , there should be at least one regular character after the special character
Email update not working - bug fix (NCS specific)
Transfer Links endpoint was enhanced to update the email both in Subscribe database and in NCS Circ
Activate Page button redirecting to the Sign Up tab
When a user clicks the Login/Register (or any text defined in CMS) button at the Activate page, they are now redirected to the Sign Up tab instead of the Login tab
Activate page logic reworked to recognise Publication Code/ Site Code
The logic for the Activate page has been reworked to redirect users referring to the publication code: the Site Code in URL is changed in accordance with the subscription selected. To set this up please go to Support Viewer → APISetting, then updated the Site codes for the SubCon.AllowedPaperCodesByClientAPI setting
Subscription Search via Phone number optimization in One CSR Portal
Subscription search via Phone number in One CSR Portal logic was optimised by adding appropriate Indexes in the database table so that it is now able to handle large datasets of up to 7.5M records
Authpanel Buttons visibility control via SS Config
The visibility control for AuthPanel buttons SignIn, Register, Custom has been reworked. It can now be managed individually for these buttons via SS Config (HideSigInBox, HideRegisterBox, HideCustomBox, respectively). However, the other properties, like text can be managed from CMS
Areas covered
One CSR Portal, Self-Service, Database
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Auth0 / SSOR related fixes
Social Media Login/SignUp Options in Subscription Panel
Fix the login/signup via social media option in Subscription Panel.
The following properties configuration is required in CMS: Subscription Panel --> Presentations --> Page V3 Landing Page --> Step V3 User Information --> User Information --> Switch on 'Google show: ', Facebook show:' and 'Apple show:' properties
User Creation via Subscription Panel Auth0
The realm Auth0 integration is now configurable via Subscription Panel configuration file to be able to work with SSOR.
To configure the flow to work with SSOR please go to Config --> Systems --> Auth0 within SP and set the 'realm' key value to 'AutomaticMigrationSSOR’. The default 'realm' key value is 'Username-Password-Authentication'.
Login failure for subscribers with multiple subscriptions
To prevent potential login failures with subscribers with multiple subscriptions caused by SSOR / Auth0 migration the User Provider configuration setting was created in MG2Control must be set appropriately (e.g. SSOR, Firefly, Gigya, Auth0, etc.)
Logged-in state not carrying over to MyAccount
Logged-in user state not carrying over to MyAccount was fixed by modifying the session recovery logic in SSOR.
VWO script changes
For a certain client the hardcoded VWO smartcode on the checkout pages was outdated. This script has been updated with the details shared by the client.
Delayed Login in Self-Service for Publications using SSOR Authentication
Added on October 16th, 2023.
The issue of publications using SSOR authentication taking too long to load SubCon Sites has been resolved. This delay was primarily because of an additional API call triggered by an internal cookie with an empty value. With the issue resolved, it is now possible to log in to the My Account pages of publications using SSOR authentication without any delays.
This fix is also merged to 3.16.2.5 & 3.16.3.4.
Areas covered
Self-Service, Subscription Panel
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Braintree SDK update
Braintree is sunsetting their API on python platform. Hence, as per Braintree's recommendation, the backend Braintree SDK has been updated to version 4.18.1.
Areas covered: API
The fix was also merged to 2.39.0.1 and 3.16.0.8
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Self-Service logging in/out issues
Logging out when switching between .com and Self-Service
Due to the cross-site validation, Auth0 was deleting the cookie when visiting Self-Service after .com and vice versa. This was fixed by ensuring that the cookie is deleted only when the user actually clicks the Logout button.
Areas covered: Self-Service
The fix was also merged to 3.16.0.9
Users getting logged out from the main news site after visiting their My Account page
The issue of registered users getting logged out from the main news site after visiting their My Account page and the issue of users getting logged out from the My Account page after visiting the main news site have been resolved now.
The fix was also merged to 3.16.0.9.
Stalling of the My Account First Page
For clients using SSOR authentication, the issue of a logged-in user experiencing a prolonged loading time and the failure to open the dashboard or verified account page on the My Account page has been resolved, and the user can now access the page without the need for a refresh.
The fix was also merged to 3.16.2.3 & 3.16.3
Self-Service - Users on vacation unable to raise complaints while on vacation
For NCS Clients, the issue of a user on vacation who has paused his subscription with a specific restart date not being able to raise a complaint has been resolved.
Note:
Please ensure that the Business Rule within NCS application is set to allow a user to submit a complaint while on vacation.
The fix was also merged to 3.16.2.3.
Solicitor Concierge issues
Error message while updating Google Pay payment option
When attempting to update the payment method using the Google Pay option and saving the offer group, the system was throwing an error message stating “Subscribe with Google SKU codes can be specified only if Subscribe with Google Payment Method selected" for clients on version 3.16.1.X. This issue has been resolved now.
Timeout error when selecting a team member
The timeout error occurring in SolCon when selecting specific team members has been resolved.
The fix was also merged to 3.16.2.3.
CMS - Getting error message (Error400:) while selecting Offer available under Presentation Properties V3
The error message "Error400:" that was displayed while selecting DefaultOfferGroupId from the 'Available Offer Groups' in the CMS module's Presentation Properties V3 due to the presence of an excessive number of offers on SolCon has now been resolved.
The fix was also merged to 3.16.2.3.
Subscription Panel - User registration after third-party authentication
When a user was trying to buy a subscription after getting registered via a third-party authentication system (e.g., a user on a newspaper site clicks on a link ePaper-->Auth0-->Subscription Panel), even after the successful authentication by Auth0, the registration was not created in the Subscribe database. This issue has been resolved now.
The fix was also merged to 3.16.0.12 and 3.16.2.2.
Subscription Panel - Confirmation page Login button not working for known users
Changes have been made to the Subscription Panel confirmation page such that:
When creating a subscription for a new user, the user will be directed to the website after the subscription has been successfully purchased.
Once an existing user's subscription has been successfully purchased, they must authenticate with Auth0 before being taken to the website.
Configuration Notes:
Auth0 should be set up for the user.
In config.System "AuthCookieDomain" key is mandatory.
The fix was also merged to 3.16.2.3.
Subscription Panel - Special characters related issues
Allow Special Characters in Presentation Fields
Below Special Characters are now allowed in the fields listed below in the Subscription Panel.
Users can now enter:
' , - & / . in the First and Last name fields.
All special characters are allowed in the Email field.
' - & / # .in the Card Holder Name field.
# - . / \in the Address Line 1 field.
. - #in the Address Line 2 field.
When purchasing a subscription, CreateSubscriber failed with the error message “Child Event: CREATESUBSCRIBER failed. Error: FirstName field contained invalid characters that were removed. (19) LastName field contained invalid characters that were removed. (19)" when special character “," was used in the cardholder's name field (First Name and Last Name) on the payment page. This issue has now been resolved.
The issue has occurred since the comma (,) was not one of the earlier permitted special characters ('- & /.) for the name fields. The name fields now allow the usage of special characters: (' , - & / .).
When creating a subscription, AddSubscription failed with the error message "The entered payment information was not accepted" when special characters (&/.,') were used in the Cardholder's name field (First Name and Last Name) on the payment page when using Cybersource gateway. This issue has now been resolved.
The fix was also merged to 3.16.2.3.
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
PayPal via Braintree Renewals fix
Paypal via Braintree Renewals have been getting declined in circulation. It was identified that the PaypalBAID parameter while purchasing the subscription on EZPay was not being sent accurately to Circ. The issue has been fixed by passing the appropriate parameter from the payment vendor to the circulation system.
Areas covered: Self-Service
This fix was also merged to 3.16.0.10 and 3.16.2.1
Auth0 Client-Specific Custom Configuration for Social Login
Client specific custom configuration for social login has been added to the Subscription Panel config files so that subscribers can authenticate through Auth0 to the client's site using their social media login connections (Facebook, Google, and Apple) based on the respective client's custom configurations. Clients that have not opted for this method of authentication will be able to utilize the default method for subscribers to login to their sites.
Areas covered: Subscription Panel
This fix was also merged to 3.16.2.4
CMS - Transport Layer Security (TLS) Upgrade to Version 1.2
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket.
The Hotfix 3.16.1.7 documentation was updated on June 12th, 2023.
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
This fix was also merged to 2.39.1, 2.39.1.0, 3.15.3.1, 3.15.2.1, 3.16.0.13, 3.16.2.4, and 3.16.3.
Subscription Panel - Error loading the offer group page
The error “Sorry, the page you requested was not found. See current offers.“ that was displayed when using the input parameter "ofrgp_id" to purchase a subscription in the Subscription Panel has now been resolved. There was an issue with the SolCon GetOffers logic, which has been reworked.
This fix was also merged to 3.16.2.4
Solicitor Concierge - Unable to add Division to a published offer
The user was not able to add a Division to a published offer in SolCon. An error message was displayed during this update. This issue has been resolved.
This fix was also merged to 3.16.2.4
API - Complaints
Previously, in SubCon Site (Self-Service), the GET /Complaints/{subscriptionId}/Problems endpoint was failing because the complaint problem codes retrieved from CircPro were not available in Subsvc, which resulted in an error. This issue has now been resolved.
This fix was also merged to 3.16.2.4
One CSR Portal - Issue with 'Mark as processed' button
The issue with the 'Mark as processed' button in SubCon Admin has been resolved.
This fix is also merged to 3.16.0.14, 3.16.2.5 & 3.16.3.0.
Areas Covered
One CSR Portal
Self-Service - Invalid Logout call on some flows and 500 error by Update user endpoint
The issue of an increased number of 500 and 404 errors found on clients' servers has been successfully resolved. This was an Authentication system-specific issue. For SSOR clients, even if the user was logged out while navigating to the SubCon site, the logout call was triggered and returned a 500 error. For MG2 Auth clients, the wrong credentials during login were triggering the logout action. After the fix, for SSOR clients, the logout call will be executed with a status 200 and for MG2 Auth clients, there will not be any logout call while entering the bad login credentials.
This fix is also merged to 3.16.2.5 & 3.16.3.0.
Seamless Flow updated for Credit Card Edgil Payment Method
In the seamless flow, if the Independent Address component for the payment page has been enabled, users could purchase or subscribe to a subscription with a single click after entering their credit card information. The issue occurs when the credit card details have been validated, the Submit button disappears, and the user is taken directly to the payment options, even if the fields, First and Last names, Phone, and Zip Code, have not been filled. This resulted in the AddSubscription call being triggered with incomplete information, and since the Submit iframe button is from a third-party payment site, it does not validate whether the aforementioned fields have been filled, resulting in no error warnings being displayed.
Changes have been made to allow the submission of incomplete fields if the credit card has already been validated in the seamless flow by introducing a delay time after each keystroke while filling the fields under the independent address component.
A key, "SeamlessInputDelayTime", must be added to the SP Config file with any numerical value. The value indicates the delay time in milliseconds, with the default value set at 1500 milliseconds (1.5 seconds).
For example, after entering the first name, it will wait 1.5 seconds and then call AddSubscription if no additional keystrokes have been detected. When the user starts entering the following fields, such as Last name, phone number, and zip code, the timer is reset after each keystroke, and the AddSubscription call is triggered only after a 1.5-second delay.
This fix is also merged to 3.16.0.14, 3.16.3.1, 3.15.2.4, 3.15.3.5, 3.16.2.5
This release is in its beta version now.
Attention - Enhancement
Enhanced Sign-In Mechanism of Landing Application
Recently, major browsers have introduced additional security measures and constraints related to third-party cookies, as well as cross-domain data transfer and communication. The latest release of Chrome no longer supports third-party cookies. These were impacting the functioning of the Landing application and user experience negatively. Despite the implementation of workarounds, users were encountering issues in the sign-in flow at times.
Therefore, the sign-in logic for the Landing application has been revised without significantly affecting the existing functionality and behavior. The previous dependency on local storage has been replaced, and a Redis caching approach is now implemented for the users to sign in on the Landing application for accessing consumer applications (SubCon Admin, SolCon & CMS).
Following the new implementation, users can access any consumer application only through the Landing application.
If a user has opened different consumer applications on different tabs in a browser, logging out from one application will force the user to log out from the other opened applications as well. The user will regain access to the application only by signing in through the Landing application.
Page refresh will work as before and have no impact following the redesign.
Multi-Factor Authentication (MFA) with Okta will also work as intended if the feature is turned ON for the specific client.
There is no dependency on third-party cookies related to the Landing application, and the landing works perfectly fine on Safari, Firefox, Chrome, and Edge browsers.
Consumer applications are no longer dependent on Local storage to fetch data.
The CMS Idle Time functionality, which notifies the user if they have been inactive on a CMS page for an extended duration and provides the option to either continue or exit from the page, is working as before.
For a seamless user experience and as a best practice, please do not disable cookies in your browser.
This fix is also merged to 3.16.0.15, 3.16.2.8, 3.16.3.13 & 3.17.0.3 releases.
3.17.0.x Hotfixes
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Please note that all the 3.17.0.X hotfixes are, by default, included in the minor version currently in development, which is 3.17.1, and all subsequent releases.
Please raise a Salesforce case if you want the fix to be applied.
Issues in Share Subscription Flow:
When users shared their subscription with someone and the recipient tried to accept the invite, they encountered an error. This issue has now been resolved.
When CSRs were sending invites using the 'Invite without registration' button, the request was previously failing, and this issue also has been fixed now.
Error while updating Subscriber details
Whenever the user edited the account details, especially the phone number, on the Subscriber/Update page of the SubCon Site, an error message from the Circulation system was displayed saying, “New start failed: Could not update occupant.” This issue was occurring for clients outside the US & has been resolved. After the fix, the user can update account details without encountering an error message.
Auth0 error message not displayed
While attempting to subscribe through the Subscription Panel, if the user entered a password that did not meet Auth0's rules (e.g., a password with fewer than 8 characters), the error messages from Auth0 were not displayed, preventing the user from proceeding with the subscription. This issue has now been resolved.
Following the fix, users will receive appropriate error messages whenever an error occurs during the subscription process.
Error while updating user profile in SubCon Site
When the user tried to select the ‘Update profile’ menu after logging in to the SubCon Site, the system threw an error message: ‘Invalid input’, unless the page was refreshed. This issue has now been resolved. After the fix, the user can select the ‘Update profile’ menu and successfully update their profile data without any error messages.
Title property of 'ApplePay Braintree V3’ component
The Title property of the 'ApplePay Braintree V3’ component has been changed from 'html type' to ‘text type'.
Updating an existing Sales Team with a large data set (such as adding a significant number of offer groups and/or team members) was causing time-out errors. To address this issue, the Sales Teams update functionality has been restructured for performance enhancement.
There are no functional changes. After the refactoring, the performance has significantly improved. It is now possible to successfully update large numbers of offer groups or sales team members within existing Sales Teams without encountering time-out errors.
This fix is also merged to the 3.16.3.13, 3.17.1 & 3.17.2 releases.
Bug Fixes
Display Name not getting auto-generated
For MG2 Auth clients, when a user attempted to register on the site by providing an email ID and password without entering a display name, the display name was not auto-generated for the newly registered user. This issue has been resolved. After the fix, even if the display name is not provided by the user during registration, it is now auto-generated in the backend.
Errors while updating Display name and email in Self-Service
Previously, when a user tried to edit their Display Name or email ID from the My Profile page the system displayed error messages. These issues have been resolved. After the fix, users can successfully edit the Display Name or email ID from the My Profile page without encountering any error messages.
Implementation Notes:
A new MG2 Control Api setting key SubCon.IgnoreProvider has been introduced. When the value of SubCon.IgnoreProvider is set to true (1), the API does not interact with the Auth system, meaning the identity providers are ignored. When the key value is set to false (0), the API request interacts with the Auth system, which could be MG2 Auth or Auth0, depending on the configuration.
Error while updating address via Self-Service
When the user tried to edit the Billing or Delivery address, the system displayed an error message saying, “Address Second Pass,” and the user was restricted from changing the address. This issue was specific to CircPro clients and has now been resolved.
Subscriber Update issues in Self-Service
The following issues on the Subscriber Update page have been resolved:
The user was unable to update the email ID due to an error message displayed by the system. This issue occurred when the user tried to update the email ID to one that already existed. This problem was caused by an internal validation that restricted the usage of the same email ID in two accounts. After the fix, the user is now able to update an Email ID that is already available in the Subscriber table with a different subscription.
There was another issue specifically observed for users who did not have an email ID saved in NCS Circ. When these users tried to update their details from the Subscriber page, the SUBMIT button was greyed out, preventing them from completing the update. This issue has also been resolved. After the fix, the email field is now optional on the Subscriber Update page. Users can update the subscriber details even if the email field is left blank.
When a user tried to update their phone number by entering a new number after clearing the existing one, the update was successful. However, it was observed that when the user attempted to change the digits of the existing number after the parentheses displayed in the field (area code enclosed in parentheses), the system displayed an error message, preventing the update. This issue has now been resolved.
Error while updating Profile Information in Self-Service
After editing profile information on the My Profile page, users encountered an error message while clicking the SUBMIT button, and the update failed. This issue has been resolved. Following the fix, when a user edits the First Name and/or Last Name, the update is now successful without any errors.
Implementation Notes:
Set the value of MG2Control key SubCon.IgnoreProvider True or False (0 or 1). The default value of the key is True.
Issue in creating a subscription
This issue was specific to CircPro clients. When a user attempted to subscribe with EZPay, the subscription was unsuccessful if the circulation system was CircPro. This was due to a mismatch between the Pac term values set up in the SolCon offer and the Pac terms in the circulation system. This issue has been resolved.
Issue in Restarting subscription from the Subscription Panel
This issue was specific to CircPro clients using the payment vendor Authorize.net. When users attempted to restart subscriptions from the Subscription Panel, it failed. This issue has been resolved. After the fix, the CircPro clients with Authorize.net payment vendor can successfully restart a subscription from the Subscription Panel.
Post login error for recently subscribed users with previously stopped subscriptions
When a user with a previously stopped subscription purchased a new subscription and tried to log in to the self-service portal, they encountered an error message stating 'Max Linked Subscribers.' As a result, the user was unable to verify their account and log in to the site. This issue has now been resolved.
Removal of Special Characters Encoding
The encoding of special characters has been removed due to issues arising when the rate code length exceeded 20 characters in the circulation system after encoding.
This fix is also merged to the 3.16.3.13 release.
Applications Covered:
API, Self-Service, SolCon
Attention - Enhancements
Enhanced Sign-In Mechanism of Landing Application
Recently, major browsers have introduced additional security measures and constraints related to third-party cookies, as well as cross-domain data transfer and communication. The latest release of Chrome no longer supports third-party cookies. These were impacting the functioning of the Landing application and user experience negatively. Despite the implementation of workarounds, users were encountering issues in the sign-in flow at times.
Therefore, starting with this release, the sign-in logic for the Landing application has been revised without significantly affecting the existing functionality and behavior. The previous dependency on local storage has been replaced, and a Redis caching approach is now implemented for the users to sign in on the Landing for accessing consumer applications (SubCon Admin, SolCon & CMS).
Following the new implementation, users can access any consumer application only through the Landing application.
If a user has opened different consumer applications on different tabs in a browser, logging out from one application will force the user to log out from the other opened applications as well. The user will regain access to the application only by signing in through the landing application.
Page refresh will work as before and have no impact following the redesign.
Multi-Factor Authentication (MFA) with Okta will also work as intended if the feature is turned ON for the specific client.
There is no dependency on third-party cookies related to the Landing application, and the Landing works perfectly fine on Safari, Firefox, Chrome, and Edge browsers.
Consumer applications are no longer dependent on Local storage to fetch data.
The CMS Idle Time functionality, which notifies the user if they have been inactive on a CMS page for an extended duration and provides the option to either continue or exit from the page, is working as before.
For a seamless user experience and as a best practice, please do not disable cookies in your browser.
This fix is also merged into the 3.16.1.10, 3.16.2.8, 3.16.3.13 & 3.17.0.3 releases.
Merchant Password in the P12 file for Cybersource
Following an urgent update regarding the P12 merchant file for Cybersource keys, Subscribe will now send Password, Filename, and Merchant ID to ensure successful payment transactions with the Cybersource payment gateway. Previously, only the Merchant ID was included in the Cybersource request.
Note that the Merchant ID and Filename values remain the same in the Cybersource request.
This fix is also merged into the 3.16.3.14 release.
Redeployed the deprecated /DigitalAccess endpoint
The /DigitalAccess (POST) endpoint was deprecated in Subscribe version 3.17 as part of a major API refactoring. However, to ease the migration, this endpoint has been made available again.
Bug Fixes
Improper Notifications when Linking an Account
When a user linked an SS account with an existing subscription, the success notification displayed HTML tags along with the message text. This issue has been resolved. After the fix, notification messages are displayed correctly with the intended styling (e.g., bold text) and without any visible HTML tags.
Implementation Notes:
The existing property “EnableHtml” in Subcon.config should be set to true → "EnableHtml": true (for converting HTML tags).
Tax not getting included in the payment
If a potential subscriber switched the payment method while making the payment, the tax was getting skipped. The issue has been fixed now.
After the fix, while purchasing a subscription, the Tax is included along with the subscription cost irrespective of the Payment method selected.
Issue with In-App Subscription Purchase
This intermittent issue was specific to Apple's V1 in-app purchase. When users purchased subscriptions through the Apple app via in-app purchase, the corresponding transaction was not reflected in the Subscribe database. Subsequently, the user was unable to access the website. This issue has been resolved. After the fix, the Apple in-app purchases are updated in the Subscribe database correctly and the users can access the websites too.
This fix is also merged into the 3.16.3.13 release.
Error while linking Email ID to subscription
Subscribers for specific clients using dedicated Auth connection per Publication were getting a 'Max Linked Subscribers' error when the same user had subscriptions for more than one publication. The issue has been fixed now.
Reward details not displayed
When the user selected a Reward from the Rewards page, instead of navigating the user to the Membership Rewards page where the user can enter the details to claim the reward, the loader kept on spinning on the Rewards page. This issue has been resolved. After the fix, when the user selects a Reward from the Rewards page, the user is navigated to the Membership Rewards page successfully, and can enter the user details and submit it for claiming the reward.
Non-deduction of Donation amount while signing up for Auto-renew
When a subscriber entered a donation amount during auto-renew sign-up, it was not getting submitted and subscribers were not charged. The issue has been fixed. In addition, the donation is now displayed as part of the one-time payment being made other than the amount for auto-renew sign-up.
User Name not reflected in SubCon Admin after Registration via Engage
Even though the User Registration template in the Engage included First Name and Last Name fields, the user name details entered during user registration were only captured by the Auth0 and were not reflected in SubCon Admin for the corresponding user after a successful registration. This issue has now been resolved.
Error message when subscribing via ApplePay Braintree
When a user attempted to purchase a subscription using ApplePay via Braintree, the transaction failed, and an error message was displayed. This issue has now been resolved. After the fix, users can successfully complete their subscription transactions through the Subscription Panel using ApplePay via Braintree, without encountering any error messages.
This fix is also merged into the 3.16.3.12 release.
Error in specific cases for Email IDs with special characters
In certain workflows Subscribe uses GET /Users?Email endpoint. It was breaking for email IDs with special characters such as the "+" sign thereby affecting the workflows like Gift subscriptions, Invitations, etc. This issue has been resolved.
Forget Password email not received
Whenever a user clicked on the “Forget Password” link in the Digital tab for an MG2 Auth user, though a success message was displayed, the corresponding email was not actually received by the registered user. This issue has been resolved.
Entitlements API - GET Method not inserting data in Access Log
The GET method implemented for the DigitalAccess endpoint did not insert data into the Access Log. This issue has been resolved.
After the fix, if the GET method is implemented for the DigitalAccess endpoint, user data is inserted successfully into Access logs. Additionally, in the POST API, the parameter accessLevelCode is included in the response to provide entitlement information.
Issues in canceling a subscription
The issue that prevented users from canceling subscriptions due to an error message has now been resolved.
Previously, it was not possible to set a Custom CSS Class in the CMS for the Self-Service (SS) Dashboard footer link. This issue has now been resolved, and users can successfully assign a CSS class to the SS footer link in the CMS. This fix applies to both Horizontal and Vertical DisplayType.
This fix is also merged into the 3.17.1.1 & 3.17.2.1 releases.
UI label Misalignment in Self Service Dashboard
The misalignment issue of week-day labels with checkbox icons in the Subscription menu and Billing menu label values has been resolved. After the fix, checkboxes are now center-aligned below the week-day labels, and Billing menu label values are right-aligned. This update ensures a cleaner and more structured display of the Subscription and Billing menus on the SS dashboard.
This fix is also merged into the 3.17.1.1 & 3.17.2.1 releases.
Issue with Cache Refreshing
When refreshing the CMS cache using the “Refresh CMS + Site” button, not all cache servers were being refreshed. This issue has been fixed now.
This fix is also merged into the 3.17.1.1 & 3.17.2.1 releases.
News site instant access issue when restarting a subscription
When a stopped subscription was restarted from the Subscription Panel, users did not receive instant access to the site. Additionally, a different account number appeared in internal records for the restarted subscription, though it was corrected to the original account number after the nightly sync process.
These issues have been resolved. After the fix, restarting a stopped subscription now grants users instant access to the news site as per their purchased subscription.
This fix is also merged into the 3.17.1.1 release.
OneTrust Modal not opening in the Self Service Dashboard footer link
The issue where the OneTrust Modal did not open upon clicking the Self Service (SS) Dashboard footer link has been resolved. After the fix, clicking the SS Dashboard footer link now correctly opens the OneTrust modal on the same page without refreshing the screen.
Implementation Notes:
To open the OneTrust modal on clicking the SS Dashboard footer link:
Add OneTrust script via GTM in Subcon.Configuration.
Create the CMS link with href="#" and enter the class name in the Class field.
The CMS link must be placed inside the SS Dashboard Footer.
Note that if the link is outside the footer, the modal will not open because the required CMS class is only applied in the footer as of now.
This fix is also merged into the 3.17.1.1 & 3.17.2.1 releases.
Subscription failure while using Amex Credit card with Apple Pay
When a user tried to pay the subscription amount via Apple Pay with American Express credit card, the transaction failed. This issue has been resolved. After the fix, user can successfully purchase a subscription with American Express credit card via Apple Pay.
This fix is also merged into the 3.16.3.14 release.
InApp Subscribers not getting website access
Even though a user could successfully purchase a subscription via InApp purchase and the user was created in SubCon Admin, the user did not gain access to the website. This issue has been resolved. After the fix, the details of successful in-app subscriptions are updated in SubCon Admin, ensuring that subscribers now have valid access to the websites as per their subscriptions.
This fix is also merged into the 3.16.3.15 & 3.17.1.1 releases.
Applications Covered:
API, Self Service
3.16.2 Minor Release
The document contains the major new features and changes in the minor 3.16.2 release. It also documents known problems and workarounds, if any
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
3.16.2 is a minor release, hence it does not contain any breaking changes, but mostly enhancements, bug fixes and several small new features. The new features supported are related to Complimentary subscriptions and Trial-with-Payment subscriptions
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Please note that in the process of implementation, the sync job has to be updated to 3.16.2.
Also for Trials-with-Payment (ideally for the whole release) Subscribe extracts version 5 is required.
New features
3.16.2 minor release has the following new features
Feature
Description
Trial-with-Payment subscriptions
Complimentary subscriptions with no end date
The complimentary (free of charge) subscription flow is revamped. More options to define the number of complimentary days are supported as well as the option to create a complimentary subscription with no end date.
Upgrades & enhancements
The following enhancements are introduced to the existing features
Feature
Description
Account Management: Address Update page for CircPro clients
CircPro clients now have the newly designed Update Address.
The page only shows the options relevant for CircPro clients e.g. the ability to edit Billing or Delivery Address. While the irrelevant options, like Schedule Move etc are hidden. The page content is managed via CMS.
Address update requests from the page are handled via the newly developed endpoint in Address API PUT /Subscription/{subscriptionId}/Address
ZipCode validation on different pages i.e. Address, Temporary stop Transfer, Activate, Access and VerifyAccount, is now consistent and accepts 4-8 characters
One CSR Portal: fields renamed
Two fields at the Account Information tab in One CSR Portal are renamed:
Subscriber Since → Subscription start date
Subscriber stop date → Subscription end date
Subscription start date displays the date the account was created, i.e. in case of a restart with the same account number the date of the new start is displayed. In case of a restart with a new subscription being created - the date of the latest new start is displayed
The columns in the Offers tab are renamed and made consistent with those at Add account and Start call screen
One CSR Portal: Between filter criterion in Custom Reports
The new filter criterion Between is added to Reports → Custom reports → Predefined reports grid column filters.
This filter is applicable to all the columns displaying numeric values as well as the columns displaying date values
Solicitor Concierge: Marketing Text Search Filter values alphabetically ordered
Marketing Text Search Filter values (available under Inventory → Marketing Text) are alphabetically ordered
Solicitor Concierge: Term field deprecated
The field Termon the Offer Group screen is deprecated since it had no functional use
Solicitor Concierge: Terms&Conditions character limit
Terms & Conditions field (available under Inventory → Terms & Conditions) is now set to have a character limit of 300 characters
Subscription Panel: Password validations inline to Auth0
The User Information component now supports password validation. The newly added CMS properties are:
Lowercase
No Two Identical characters in a row
One special character
Security: Automatic Session Killing
To improve security the automatic session killing is added to Subscription Panel.
If the user remains idle for a specific time period defined in the configuration, the time-out warning is triggered and the user is expected to refresh the page within 30 seconds to continue the session. If the user doesn’t act on the warning message, then the entire page reloads and the user is logged out of the session.
Within the client configuration, the following properties need to be defined - config.enableIdleTimer, Idle Time setup
Landing: Enhanced User Search & Export
PurchaseAPI: Zip code check
When a potential subscriber enters a Zip Code while purchasing a print/hybrid offer, the Purchase API now validates the Zip Code in the input model is also available in the Offer Delivery Area in the Solicitor Concierge Offer setup.
However, Matrix as an exception doesn’t validate ZipCode from SolCon delivery Areas, the functionality has been made configurable via an MG2Control setting and can be enabled/disabled by clients as required: MG2Control Setting - Purchase.ValidateZipCodeWithinDeliveryArea can be set to 0 to disable this functionality. By default the functionality will validate Zip Code
GetSubscription API: Balance sync
getSubscription call synchronizes the owed balance which is displayed in the Start Call window and the Pay Balance button also reflects under the Account Information tab on the first attempt
BillingAPI: Real-time Status update in Restart endpoint call
During Restart the subscription status is updated to 'L' in real-time, in addition to a previously existing update of the Household Level for entitlement
BillingAPI: Consistent Balance format in all circulation system
The inconsistency of the Positive & Negative balance definitions for different circulation systems is resolved.
Starting from this release for Matrix and SaxoCirc circulation systems the Subscriptions/Billing API displays the owed balance as negative in API response while it is stored as a positive value in currentBalance column of Subscription table in the database. So that Matrix, SaxoCirc circ are now aligned with NCS Circ and CircPro.
Get User API: returns AddDate from AuthSystems
The endpoints of Get User API now returns an additional parameter AddDate mapped from all Authorization systems
Get Promotion API: info stored in event logs
The Get Promotion step has been included as part of the Sync step
TempStopAPI: Return Options with filters AvailableAfterDays and AvailableUntilDays
The options returned for real-time tenants by Temporary Stops API are now filtered against the AvailableAfterDays and AvailableUntilDays from the Vaccation_Options table
Payment Methods for Complimentary Subscriptions - Matrix
With Trial & Complimentary Subscriptions redesign, the Payment Methods are enabled while creating Complimentary Offers for Matrix clients to enable a similar behaviour as of traditional Trials (Billed payment method is allowed from the API side)
Braintree SDK Upgrade
Braintree is sunsetting its API on the python platform. Hence, as per Braintree's recommendation, the backend Braintree SDK is updated to version 4.18.1.
Bug fixes
The following bugs are fixed in this release
Feature
Description
The Late Route Delivery event not fired on the Complaint page
GETROUTEDELIVERYDELAYS event is now fired on the Complaint page as expected
MG2Auth Page not allowing the user to sign out without refresh
MG2Auth Page now allows the user to sign out immediately
Typographical corrections of Account Type options
CheckingsAccount was corrected to Checking Account
Incorrect Subscription retrieved for a Subscription with more the one Product one of them being inactive
The correct subscription is returned. To fix this, the purge policy for inactive records has been modified from 15 days to 7 days. Also, the data is now being fetched based on AddDate column to make sure that the latest record is always returned
Alignment of Payment options / Rates on My Profile page
The payment details/rates of a subscription under My Profile → Billing Information are now Left aligned and in line with other details.
Upgrade/Downgrade of subscriptions not allowed with Temporary stop history
Upgrade/Downgrade is now allowed regardless of the Temporary Stops history
The minimum Matrix version is 38.00.034.ITSP5
Scheduled stop not picking the selected stop date
For a scheduled stop the application was passing the current date, not the selected date to the API request. The issue was fixed to pass the selected date from the date picker.
The minimum Matrix version is 38.00.034.ITSP5
EZPay for Stop Saver, Start Call & Upgrades/Downgrades Offers
The EZPay field now displays the correct selected option as per the offer setup on the following screens:
Chevron visibility for Upgrade/Downgrade offer in One CSR Portal
At Subscription Search → Start Call → Offers → Upgrade Offer, the Chevron aside Offer Id was not displayed hence the user could not see Marketing Text.
This was made consistent to the Downgrade Offer tab on the same screen and the chevron is now displayed in both tabs.
Active Billing Plans Filter
Within the Solicitor Concierge, Reference Tables → Billing Plans screen, the check Show only Active did not filter the displayed data. The issue is fixed and now all the data is filtered
Select & Export Offers Errors
The issue with exporting selected Offer Groups in Solicitor Concierge is fixed.
The minimum Matrix version is 38.00.034.ITSP5
Error in adding a new user to the Team
Adding a new Team member to the existing teams in Solicitor Concierge under the Teams → Team Members section was generating an error since release 3.16.0
This is now fixed and new users can be added to the teams.
Attributes data not auto-refreshed after Import
In CMS under Attributes → Options → Import → Select File → Import → Confirm → Ok, there was no further message or screen auto-refresh with the imported data. The success message is added saying 'Successfully Imported Your data' and thescreen is refreshed.
Additionally, the Ok button on the Import pop-up that was earlier disabled is now enabled.
Benefits - Remove Override Success message
When the user tried to Remove Override for a Benefit and save the record, the wrong success message was displayed.
The message is replaced with 'Override successfully removed'.
Benefits - Save operation without changes
When the user accessed any Benefit record via Benefits → Search and tried to save the record without making any changes, a success message was displayed. The success message is replaced with a warning message 'Warning!! You have not changed Benefit for saving'.
Failed retry logic on AppleV2
In the Web-hooks API Retry endpoint, the AppleV1 logic was applied for AppleV2 causing the whole workflow to fail since these versions are not compatible with each other. The logic is now fixed.
Subscription Information in My Profile hidden when no Subscription is linked - fix
When a registered user who doesn’t have any linked subscriptions visits the My Profile section on self-service, the Subscriptions header will not be visible to them. Earlier, this section used to be visible but with no data
Refund Stop Type Issue - Matrix
When a user in SA attempts to initiate Permanent Stop with Refund as a preferred option, they were still being displayed as No Refund. However, in SS there is no option for a subscriber & the request is always submitted as No Refund. The issue was identified as an incorrect mapping for Matrix Stop types and API referring to NCSStopTypeCode. This has been fixed by adding a new setting in MG2Control to control the mapping based on circulation and adding the appropriate reference to the applicable Stop Type in Matrix
Change to Paper Bill /GoPaperless API
The Change to Paper Bill request from SubCon Site used to get submitted successfully however the request was not being sent to the circ system appropriately thus leading to failure in change to the Paper bill in the circulation system. The issue has now been fixed.
The following parameters of GoPaperless API have been modified to handle this:
ReasonCode = eBillOut
EbillEmail = Null
RenewalDelivery = Null
OverrideCode = Null
3.16.2.X Hotfixes
This page containes the description of the hotfixes related to 3.16.2 version
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Please note that all the 3.16.2.X hotfixes are by default included in both the next minor and major versions, which are 3.16.3 and above and 3.17.0, respectively.
If you want the fix to be applied, please input a Salesforce case.
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Lite Subscriptions Expiration Data & Status fix
Within Lite Subscriptions, the functionality to edit and update Expiration date from One CSR Portal UI was not working completely. The expiration date was being updated in one of the two dependent tables in the database and subscription status also remained Expired even if updated expiration date was set to a Future Date. This issue has been fixed by introducing new endpoints within One CSR Portal application.
Lite subscriptions: One CSR Portal tab renamed
When a user clicks on ‘Start call’ push button, the first tab displayed contains the selected account information. For Lite subscriptions, this tab name is renamed as ‘Lite Account Information’ to give it more clarity from this release.
Lite subscriptions: Currency field added
A new field Currency is introduced in Lite Account Information tab under Account Details section. By default, the field displays the value of the currency entered by the user/CSR while creating the Subscription through the Subscription Panel Presentations. The field is editable and provides the following options in a drop-down to choose from: 1) Euro 2) US Dollar 3) Swiss Franc and 4) Pound Sterling
The above UI changes and the corresponding functionality works in tandem with the following updates in the API side.
A new endpoint is created api/startCall/Currencies/{CountryCode} to get the currencies list
The /Billing/Currencies endpoint from SubscriptionsAPI is called to verify the validity of the currency being sent. Only valid currencies can be sent
To the Update Subscription API endpoint, the Currency parameter is added
One CSR Portal: Registration search within Subscription
In Subscribe, there are corporate accounts where each account having almost 2000 users registered under it. With the new enhancement, it is possible to search for a specific user within a corporate account.
Within the Digital Tab of Start Call push button, a new section ‘Search Registrations’ is added now. It has three search fields: Login name, First name and Last name along with Clear and Search buttons.
A new column Full name is also added in the result grid which shows the combined value of First name & Last name that brings more clarity.
The CSR can now filter the data of registrations grid by entering the login name (usually email id), by combination of First Name & Last Name, or all of them. The search results will be based on partial or exact match of the names given in the search fields.
When the Search button is clicked without any data being entered in the search fields, the grid displays all data related to active registrations under the subscription, without applying any filters.
One CSR Portal: Subscription Search by First Name or Last Name only
The Subscription Search is enhanced to be able to search with just one search field compared to the prior three search fields. With this new development, it is possible to search for user account(s) by giving either First name and/or Last name in the respective search fields.
This enhancement is enabled by an MG2Control App setting (Client Components Permission) with the key ‘SubscriptionSearchBasedOnFirstAndLastName’. If this key value is set to 1(true), then ‘Search only by First name or only by Last name’ is permitted. Or else, the current behavior follows (i.e, the user should enter value in First name, Last name and Newspaper). By default, the key value is set to 0 (false).
While the key value is 1, if the user attempts to search with fields such as House number, Street or Zip/Postal code that do not work independently, then the following error message will be displayed:
“Either First Name or Last Name or Account number or Phone number or Email or Company name or three other fields are required.”
Configuration Notes:
Created new App setting key (Support Viewer > Management > App Settings > Setting type - Client Components Permission, App type - SubCon Admin, Key - SubscriptionSearchBasedOnFirstAndLastName)
When key value is set to 1, it is possible to search with First name and/or Last name. However, a search with only House number, Street or Zipcode will trigger an error message.
By default, the key is set to 0.
One CSR Portal: User Accounts Search by First Name or Last Name only
Certain clients can have a large number of users and hence it might get difficult to search registrations only by Login Name i.e. Email Id. Hence this new development.
The User Accounts → Search Module is enhanced with additional search criteria for First Name and Last Name. With this new feature, users can now search for user accounts either by giving First name and/or Last name in the respective fields. The search results will be based on partial or exact match of name given in the search fields with the only requirement being that the initial characters of the search text must match exactly. For instance, a search using the text "HE" will return a match for "HELLO", but not for "LLO".
A new column ‘Full Name’ is added in the search results grid to provide users with more accurate search outcomes.
In addition, the "Show only registrations" checkbox is removed from the user interface. The checkbox was previously checked and disabled in all cases, rendering it redundant. However, this change does not affect the backend logic.
The above enhancement is made possible with the following API changes in the backend.
The SearchUserByEmail endpoint is renamed to SearchUser.
The APIs are modified to include FirstName and LastName as parameters.
One CSR Portal: Capture Additional Registration Data when creating a New Registration
Certain clients have corporate accounts in which each account can have a large number of registrations under it. The registrations data can be used by the client for their external activities and campaigns but currently the system does not capture enough information to fulfill this purpose. From this release, the Subscribe system is enabled to capture extra information for each user Registration. However, this is an optional function and can be switched on/off with a MG2Control App setting, RegistrationAdditionalData.
When the MG2Control RegistrationAdditionalData is set to true, the following happens:
When a user clicks Invite / Invite Without Registration, additional fields for Company Name, Position (Job Title), Phone, Address, City, Postal Code, Country are displayed. Data entry to these fields are optional.
Data entry to these fields are free text except for the Country field, which will be a dropdown. The Country drop-down has the same options as that are available under Lite Account Information tab.
When the MG2Control RegistrationAdditionalData is set to false then the additional fields are hidden.
One CSR Portal: Additional user details available in Profile settings of User account
Once the additional user registration data is captured in the system, it will be available under the Profile settings of User accounts (User accounts > Search > Registration > Profile settings). The additional user data fetched from the database will be editable with a Submit button. This functionality also depends on the value of the MG2Control App setting key, RegistrationAdditionalData.
Configuration Notes: The additional fields will be available under Profile settings only if the key value of RegistrationAdditionalData is set to 1 in MG2Control > App settings.
One CSR Portal: Downloadable CSV Template
From this release, a CSV template file is available for download with extra fields such as Company Name, Position, Phone, Address, City, Postal Code, and Country, along with existing fields. A push button Download CSV Template will be displayed side by side with the Import from CSV button. The headers in the downloaded template are in sequence with the expected import order. This helps the end user to identify the sequence of columns to be maintained while importing the CSV for registration invites.
Clicking Import from CSV captures additional data columns and stores them in the Registration table without impacting existing import behavior. Country field values are validated from Subscribe Country Setup. Error messages are displayed if columns are missing or out of sequence.
Configuration Notes: The Download CSV Template button is displayed only if the MG2Control App setting key ImportRegistrationButton value is 1. The value of RegistrationAdditionalData MG2 Control App setting determines if extra fields are to be included in the template or not. If the value is 1, the template file will have all the extra fields and if the value is 0, the template will have only the default fields (Email, First name, Last name and User Type). When this setting is 1, the additional fields are also saved in the Invitation table at the time the Registration invitation is sent.
One CSR Portal: Append action added for Registration Import from CSV
In the Bulk Invitations Import window, when importing the uploaded file, all existing entries were deleted and replaced with the records in the file. It was difficult to handle the requirement to add a couple of entries to an existing list of over 500 entries. Enhancements have been made to add records to the existing list rather than totally replace the entries.
The Bulk Invitations Import window now includes the option "Choose an action." By default, the action has been set to "Append." An alert message— “This action will add the new records without deleting the existing ones." for the selected action will be shown at the bottom.
The "Upload" button that appeared after choosing a file has been replaced with an "Import" button. Only after a file has been chosen for upload will the "Import" button become enabled.
If a record in the uploaded file matches an existing registration (Pending or Active), the log file generates the message “Record already exists” against the record.
Note: Since records are now appended rather than overwritten, the import limit will be defined by pending invitations rather than the total registration limit.
One CSR Portal: Add Address fields in Lite Account Information
On the Lite Account Information tab, a new section called "Billing Address" has been added. This section consists the subscriber's Address, City, State, Postal Code, and Country.
Note: The Country field, which was previously located under the Personal Details section, has now been moved under the Billing Address.
The information in this section is already filled in based on the information given when the subscription was created. The values can be modified by clicking the Edit button at the bottom of the section.
Note: All fields in this section are mandatory and cannot be left blank.
One CSR Portal: Change Resend Invitation endpoint
One CSR Portal now uses the POST /Invitations/{invitationId}/Resend instead of PUT /Invitations/{invitationId} to resend the invitation email.
SubCon Site (Self-Service) - Change Resend Invitation endpoint
The SubCon Site (Self-Service) now uses POST /Invitations/{invitationId}/Resend instead of PUT /Invitations/{invitationId} to resend the invitation email.
API - Modification in GET/User/{customerRegistractionId}/{type}, GET/User/{type}, and GET/User endpoints
The above endpoints now include a new output parameter called "metadata" that returns the additional registration details that are added when creating a new registration (see the point above).
Note: The metadata can contain any information in JSON format and is not restricted to the registration's additional fields.
API - Modification in POST User (Create User) and PUT User (Update User) endpoints
When a user is created using the POST /User endpoint, metadata information can now be added and stored in the database under the Registrations table.
When using the PUT /User endpoint to update the user details, the provided data will be used to update the user information in the Registrations table, including the metadata.
API - Modification in POST /Invitations and POST /Invitations/{Id} endpoints
When creating an invitation using the POST /Invitations endpoint, metadata information can now be added and stored in the database under the SubscriptionInvitations table.
Once the invitation has been accepted, the metadata details in the SubscriptionInvitations table will be copied to the Registrations table.
API - Modification in PUT /Invitations/{Id}endpoint
The PUT Invitations endpoint has been modified so that the API can only be used to change information about an invitation that is still pending registration.
The API modifies the information of an invitation in the SubscriptionInvitations table with the provided details, including the metadata.
API - New endpoint POST /Invitations/{invitationId}/Resend
To resend the invitations email, a new endpoint POST /Invitations/{invitationId}/Resend was developed.
API - Modification in GET /Invitations and GET /Invitations/{Id} endpoints
The above endpoints now include a new output parameter called "metadata" that returns the metadata details that are added when creating an invitation.
API - Modification in PUT /Subscriptions/{subscriptionId}/Address endpoint
The above endpoint has been updated so that the Billing and Delivery address details of offline subscribers who don't have a Circ system can now be modified.
Except for CircPro, the API modifies the address of the subscription in the repository (Subsvc) and the Lite Account Information tab with the provided details for all clients.
If the specified City and State do not match the provided Postal Code, the address will be standardized with Melissa, and the response will return the correct City and State based on the Postal Code. Melissa will fail address standardization if an invalid address is provided, resulting in an error in the response.
Missing First Name and Last name for Registered Users in Profile Settings - fix
When the CSR sends an invite to an end user to register an account or when invites were sent via bulk upload, the first name and last name were entered alongside the email and guest/owner fields. However, after registration, the First Name and Last Name fields were not populated in the user's profile settings in One CSR Portal.
The root cause of this issue was that the first name and last name of an invited user were getting saved only on the Subscriptioninvitations Table and not in the Registration table. This data was not getting stored or introduced in any other scenario of the entire Invitations flow.
To rectify this, we have added an extra step. When a user accepts an invitation, the site calls /Invitations API as always, and the /Invitations API also pass first name and last name information to /Users API (endpoint PUT /User). This results in an update of firstname and lastname in the Registration table (Subsvc DB of a specific client).
Thus, with this new release, the first name and last name fields are now correctly populated in the user's profile settings upon registration.
PayPal Braintree Autorenewal - fix
Paypal via Braintree Renewals have been getting declined in circulation. It was identified that the PaypalBAID parameter while purchasing the subscription on EzPay was not being sent accurately to Circ. The issue has been fixed by passing the appropriate parameter from payment vendor to circulation system.
This particular fix was also merged to 3.16.1.6 and 3.16.1.10
Areas covered:
API, One CSR Portal, SubCon Site (Self-Service)
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
SubCon Site (Self-Service) - Incorrect Tip Payment processing in CircPro
For CircPro clients, when a signed in subscriber selects an offer and do the bill payment, the tip amount entered in the corresponding field was getting added twice to the subscription amount resulting in a high cost of subscription. This issue has been fixed now.
Subscription Panel - Added client-specific GTM script in layout pug
The client specific GoogleTagManager (GTM) script has been included in the Subscription Panel configuration.
Subscription Panel - User registration after third-party authentication
When a user was trying to buy a subscription after getting registered via a third party authentication system (e.g., a user on newspaper site clicks on a link ePaper-->Auth0-->Subscription Panel), even after the successful authentication by Auth0, the registration was not created in the Subscribe database. This issue has been resolved now.
The fix was also merged to 3.16.0.12 and 3.16.1.5.
API - Seamless flow failure
Within the Seamless presentation flow of Subscription Panel, there was an issue while completing the purchase flow that did not let the user purchase a subscription. The issue has been identified and fixed now.
API - Resend Invite button error
The issue of users getting error messages while clicking on the Resend Invite button under Pending Invites has been resolved.
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Activation of users from One CSR Portal
A CSR can now create and directly activate users from the One CSR Portal. When a CSR activates an invited user, a registration will be created for the user with a system-generated password. Additionally, it is possible to notify the newly created user of their username and password via email.
If the CSR attempts to activate a user who already exists in the Subscribe database (typically a registered user with a different subscription), the system will deny the activation and display a notification message.
The display of the 'Activate' button and the drafting of the notification email can be configured in the Support Viewer using specific configuration settings (StartCallDigitalTabActivateUser, StartCallDigitalTabActivateUserEmailSend, StartCallDigitalTabActivateUserEmailTemplate).
This feature is currently available only for Auth0 clients.
Note added on October 27th, 2023.
Lite Subscriptions - Saving of Unstandardized Addresses
From this release, it is possible for the CSR to re-attempt and save the address in Lite Accounts even if the Melissa standardization of the entered address fails. The application will provide an option to update the unstandardized address only with the user’s consent. The user can consent in a pop-up asking “The address standardization failed. Do you want to retry and save the best available match?”. If the user confirms with a ‘Yes’, then the unstandardized address will be accepted and the success message “Address has been standardized to the best available match & updated“ will be displayed.
Note: The details are updated based on the address returned by Melissa. Hence if a CSR enters a partially incorrect address that Melissa would consider as Standardization failure but would also return a best available match, in this case, the best available match gets updated which could be partially different than what CSR had originally entered.
The UpdateSubscriptionAddress endpoint (PUT /Subscriptions/{subscriptionId}/Address) has now been updated so that address standardization is performed at every call irrespective of the value of the ValidAddress element.
If standardization fails and the ValidAddress element value is true, the API will return an error.
The display of the pop-up depends on the value of the MG2 Control App setting key "StandardizationFailedPopup".
Captcha added to Newsletter Unsubscribe Links
reCAPTCHA V2 has now been implemented on requested client sites, ensuring that when a user goes to the site's Newsletter Unsubscribe Links and clicks on any of the unsubscribe options (either "Unsubscribe from this newsletter" or "Unsubscribe from all newsletters"), they must pass captcha verification to complete the unsubscribe request.
The captcha is configurable at client/publication level. This feature can be turned on/off by including or excluding the appropriate code in the configuration file, config.System.
One CSR Portal - Company name search results available on partial search
The GET /Subscriptions endpoint has been updated so that when a client searches for a subscription based on a partial name of the company, all records containing the keyword are returned if the keyword is present in the CompanyName column.
One CSR Portal - Partial search on User Search Screen by checking keywords with Contains logic
The GET /User endpoint has been updated such that the logic for searching for a user is now based on "Contains" rather than "Starts with". Searching for a user with a partial name under the FirstName, LastName, and Login Name fields will now return all records containing the keyword if the keyword is present in the relevant columns.
One CSR Portal - Description correction of the Pending invites grid
The grammatical error in the description of Pending invites grid has been corrected. The word being has been removed from the description of the Pending invites to make it accurate. Now the description for Pending invites grid is read as “These people have not accepted your invite”.
Solicitor Concierge - Timeout error when selecting a team member
The timeout error occurring in SolCon when selecting specific team members has been resolved.
The fix was also merged to 3.16.1.5.
CMS - Getting error message (Error400:) while selecting an Offer available under Presentation Properties V3
The error message "Error400:" that is displayed while selecting DefaultOfferGroupId from the 'Available Offer Groups' in the CMS module's Presentation Properties V3 due to the presence of an excessive number of offers on SolCon has now been resolved.
Subscription Panel - Confirmation page Login button not working for known users
Changes have been made to the Subscription Panel confirmation page such that:
When creating a subscription for a new user, the user will be directed to the website after the subscription has been successfully purchased.
Once an existing user's subscription has been successfully purchased, they must authenticate with Auth0 before being taken to the website.
These changes do not impact clients using SSOR authentication.
Configuration Notes:
Auth0 should be set up for the user.
In config.System "AuthCookieDomain" key is mandatory.
The fix was also merged to 3.16.1.5.
Subscription Panel - Special characters related issues
Allow Special Characters in Presentation Fields
Users can now enter:
' , - & / . in the First and Last name fields.
All special characters are allowed in the Email field.
' - & / # .in the Card Holder Name field.
# - . / \in the Address Line 1 field.
. - #in the Address Line 2 field.
When purchasing a subscription, CreateSubscriber failed with the error message “Child Event: CREATESUBSCRIBER failed. Error: FirstName field contained invalid characters that were removed. (19) LastName field contained invalid characters that were removed. (19)" when special character “," was used in the cardholder's name field (First Name and Last Name) on the payment page. This issue has now been resolved.
The issue has occurred since the comma (,) was not one of the earlier permitted special characters ('- & /.) for the name fields. The name fields now allow the usage of special characters: (' , - & / .).
When creating a subscription, AddSubscription failed with the error message "The entered payment information was not accepted" when special characters (&/.,') were used in the Cardholder's name field (First Name and Last Name) on the payment page when using Cybersource gateway. This issue has now been resolved.
The fix was also merged to 3.16.1.5.
Self-Service - Users on vacation unable to raise complaints
For NCS Clients, the issue of the user on vacation, who has paused his subscription with a specific restart date, not being able to raise a complaint, has been resolved now.
Note: Please ensure that the Business Rule within the NCS application is set to allow a user to submit a complaint while on vacation.
The fix was also merged to 3.16.1.5.
Self-Service - Stalling of the My Account First Page
For clients using SSOR authentication, the issue of a logged-in user experiencing a prolonged loading time and the failure to open the dashboard or verified account page on the My Account page has been resolved, and the user can now access the page without the need for a refresh.
The fix was also merged to 3.16.1.5.
SolCon - Timeout error while selecting a team member
The timeout error occurring in SolCon when selecting specific team members has been resolved.
The fix was also merged to 3.16.1.5.
Transport Layer Security (TLS) Upgrade to Version 1.2
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket.
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
This fix was also merged to 2.39.1, 2.39.1.0, 3.15.3.1, 3.15.2.1, 3.16.0.13, 3.16.1.7, and 3.16.3.
Auth0 Client-Specific Custom Configuration for Social Login
Client specific custom configuration for social login has been added to the Subscription Panel config files so that subscribers can authenticate through Auth0 to the client's site using their social media login connections (Facebook, Google, and Apple) based on the respective client's custom configurations. Clients that have not opted for this method of authentication will be able to utilize the default method for subscribers to login to their sites.
Areas covered: Subscription Panel
This fix was also merged to 3.16.1.6
Subscription Panel - Error loading the offer group page
The error “Sorry, the page you requested was not found. See current offers.“ that was displayed when using the input parameter "ofrgp_id" to purchase a subscription in the Subscription Panel has now been resolved. There was an issue with the SolCon GetOffers logic, which has been reworked.
This fix was also merged to 3.16.1.7
Solicitor Concierge - Unable to add Division to a published offer
The user was not able to add a Division to a published offer in SolCon. An error message was displayed during this update. This issue has been resolved.
This fix was also merged to 3.16.1.7
API - Complaints
Previously, in SubCon Site (Self-Service), the GET /Complaints/{subscriptionId}/Problems endpoint was failing because the complaint problem codes retrieved from CircPro were not available in Subsvc, which resulted in an error. This issue has now been resolved.
This fix was also merged to 3.16.1.7
One CSR Portal - Issue with 'Mark as processed' button
The issue with the 'Mark as processed' button in SubCon Admin has been resolved.
This fix is also merged to 3.16.0.14, 3.16.1.8 & 3.16.3.0.
Self-Service - Invalid Logout call on some flows and 500 error by Update user endpoint
The issue of an increased number of 500 and 404 errors found on clients' servers has been successfully resolved. This was an Authentication system-specific issue. For SSOR clients, even if the user was logged out while navigating to the SubCon site, the logout call was triggered and returned a 500 error. For MG2 Auth clients, the wrong login credentials triggered the logout action. After the fix, for SSOR clients, the logout call will be executed with a status 200 and for MG2 Auth clients, there will not be any logout call while entering the bad login credentials.
This fix is also merged to 3.16.1.9 & 3.16.3.0.
Self-Service - Delayed Login for Publications using SSOR Authentication
The issue of publications using SSOR authentication taking too long to load SubCon Sites has been resolved. This delay was primarily because of an additional API call triggered by an internal cookie with an empty value. With the issue resolved, it is now possible to log in to the My Account pages of publications using SSOR authentication without any delays.
This fix is also merged to 3.16.1.3 & 3.16.3.4.
API - Failure of Newstart due to Invalid Email Characters
In the Self-Service Portal, when creating a start with an email address that included the special character "+" (e.g., user+1@domain.com), the new start failed to create with the error message "Child Event: ADDSUBSCRIPTION failed. Error: EbillEmail field contained invalid characters that were removed." Since the special characters in the Query String Parameter had been removed, the FindAddressOccupant method failed to find the occupants with the specified email address and returned the error "No occupant record found."
The special character ‘+’ has now been encoded in the Query String Parameter when communicating between EventsAPI and CircAPI in the FindAddressOccupant method, so that when entering an email address with the special character "+," new starts will now be created and errors will no longer be displayed.
This fix is also merged to 3.16.3.1.
Seamless Flow updated for Credit Card Edgil Payment Method
In the seamless flow, if the Independent Address component for the payment page has been enabled, users can purchase or subscribe to a subscription with a single click after entering their credit card information. The issue occurs when the credit card details have been validated, the Submit button disappears, and the user is taken directly to the payment options, even if the fields, First and Last names, Phone, and Zip Code, have not been filled. This resulted in the AddSubscription call being triggered with incomplete information. Since the Submit iframe button is from a third-party payment site, it does not validate whether the aforementioned fields have been filled, resulting in no error warnings being displayed.
Changes have been made to allow the submission of incomplete fields if the credit card has already been validated in the seamless flow by introducing a delay time after each keystroke while filling the fields under the independent address component.
A key, "SeamlessInputDelayTime", must be added to the SP Config file with any numerical value. The value indicates the delay time in milliseconds, with the default value set at 1500 milliseconds (1.5 seconds).
For example, after entering the first name, it will wait 1.5 seconds and then call AddSubscription if no additional keystrokes have been detected. When the user starts entering the following fields, such as Last name, phone number, and zip code, the timer is reset after each keystroke, and the AddSubscription call is triggered only after a 1.5-second delay.
This fix is also merged to 3.16.0.14, 3.16.1.9, 3.16.3.1, 3.15.2.4, 3.15.3.5.
Areas Covered
API, Self-Service, Subscription Panel, One CSR Portal
Attention: Enhancement
Self-Service - Auth0 changes to bypass Intelligent Tracking Prevention on Safari
Recent versions of the Safari browser introduced a new feature called Intelligent Tracking Prevention (ITP). ITP is designed to prevent websites from tracking user activity across multiple websites. By default, ITP is active or enabled on the Safari browser. These advancements in user privacy controls of browser adversely impact the user experience by preventing access to third-party cookies. Following this update, the Mac users on Safari browser were experiencing issues while logging into the self-service portal. Auth0 integration was not working on Safari browsers when Intelligent Tracking Prevention was enabled.
To overcome this issue, starting from this release, the Self-Service portal has successfully upgraded the Auth0 SDK from 1.8.0 to 2.1.3. Changes have been made in SS to accommodate Auth0 2.1.3 SDK.
After the enhancement users now have a smooth login process ensuring a better user experience even if the Intelligent Tracking Prevention is enabled on their Safari browsers of Mac systems.
Bug Fixes
API - ApplePay Integration Error
The issue with the Cybersource gateway rejecting payment authorization attempts due to ApplePay integration not sending CountryCode to CyberSource has now been resolved.
SP - User unable to redeem Coupon Codes
The issues with redeeming Coupon Codes (One-time and Multi-use) in the Subscription Panel have now been resolved.
This fix is also merged to 3.16.3.5.
Self-Service - Unable to maintain login state from .com to MyAccount when redirected
Post client upgrade to version 3.16.2.4, the logged-in user from .com site was unable to navigate to the Myaccount page in Self-Service portal in the logged-in state. The user could only login at the self-service portal when the value of cookies/cache was cleared. This critical issue has been resolved now.
This fix is also merged to 3.16.3.6.
Self-Service - Myaccount shows data of logged out user
When a logged-in user navigated to the Myaccount page in the Self-Service portal, they were unable to see their own account information. Instead, the Myaccount page displayed information from the previous logged-out user. This issue has been resolved now.
This fix is also merged to 3.16.3.6.
SolCon - Terms & Conditions exceptions not working
The Terms & Conditions content added under Exceptions (SolCon > Offer Group > Terms & Conditions > Exception) for publications was not displayed correctly wherever the offer was displayed through consumer applications (Subscription Panel and SubCon Site). Instead of the Exception Terms & Conditions content, the original Terms & Conditions content appeared on the checkout page. This issue has been resolved now.
This fix is also merged to 3.16.3.5.
Application Covered:
API, Subscription Panel, Self-Service, SolCon
Attention: Enhancement
SS - Support tab selection on both Auth0 ULP Classic and New
The Identity provider Auth0 has introduced a new Universal login experience for its clients. Starting from this version, Subscribe clients will have access to this new Universal login experience through the Self-Service portal. However, there will be no visual changes for the user.
This enhancement is also merged to 3.16.3.9.
Application Covered:
SubCon Site
This release is in its beta version now.
Attention - Enhancement
Enhanced Sign-In Mechanism of Landing Application
Recently, major browsers have introduced additional security measures and constraints related to third-party cookies, as well as cross-domain data transfer and communication. The latest release of Chrome no longer supports third-party cookies. These were impacting the functioning of the Landing application and user experience negatively. Despite the implementation of workarounds, users were encountering issues in the sign-in flow at times.
Therefore, the sign-in logic for the Landing application has been revised without significantly affecting the existing functionality and behavior. The previous dependency on local storage has been replaced, and a Redis caching approach is now implemented for the users to sign in on the Landing application for accessing consumer applications (SubCon Admin, SolCon & CMS).
Following the new implementation, users can access any consumer application only through the Landing application.
If a user has opened different consumer applications on different tabs in a browser, logging out from one application will force the user to log out from the other opened applications as well. The user will regain access to the application only by signing in through the Landing application.
Page refresh will work as before and have no impact following the redesign.
Multi-Factor Authentication (MFA) with Okta will also work as intended if the feature is turned ON for the specific client.
There is no dependency on third-party cookies related to the Landing application, and the landing works perfectly fine on Safari, Firefox, Chrome, and Edge browsers.
Consumer applications are no longer dependent on Local storage to fetch data.
The CMS Idle Time functionality, which notifies the user if they have been inactive on a CMS page for an extended duration and provides the option to either continue or exit from the page, is working as before.
For a seamless user experience and as a best practice, please do not disable cookies in your browser.
This fix is also merged to 3.16.0.15, 3.16.1.10, 3.16.3.13 & 3.17.0.3 releases.
3.17.1 Minor Release
This page has high-level Release notes for the minor 3.17.1 release.
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Release Prerequisites
Integrations
Minimum Version
ENGAGE
2.8.7.2
NCS Circ
2020-6.3
Subscribe Extracts
Australian Clients - Extract Version 6
Other Clients - Extract Version 5
Sync Jobs
3.17.1
Matrix Circ
38.00.034.ITSP9
Circ Pro
2023-2.0
DSI (Saxo Circ)
NOT SUPPORTED
Naviga Pay
2.2
Key Features
In the 3.17.1 minor release, a new Country-Only-Start flow has been introduced specifically for NCS Circ clients. To support ApplePay MPAN transactions via Payway, a new Billing Agreement section has been added to the SolCon application. Subscribe has integrated with two payment vendors, Eigen and FluidPay via NavigaPay in this release. This release also introduces ZIP code validation for digital offers on Landing Tiles.
There are a variety of enhancements to the Self-Service (SubCon Site), One-CSR Portal, Solicitor Concierge (SolCon), CMS Content, and Subscription Panel modules, along with the a few enhancements in some APIs in this release.
Additionally, this release addresses important bug fixes across various modules of the application.
1. Country Only Starts
A new enhancement ‘Country Only Starts’ will be available for NCS Circ Digital Subscriptions. With this enhancement, NCS Circ client subscribers can now subscribe to digital subscriptions by simply providing their name, an email ID, and selecting a country name from the drop-down, without needing to provide a zip code or any other address details in the Subscription Panel.
CMS - New Properties in the ‘IndependentAddressV3’ component
To accommodate the Country only starts, Country and State-specific properties have been added to the IndependentAddressV3 component of CMS. Refer to the table below:
State Specific Properties
Type
State.OptionalNextToPlaceholder
String
State.OptionalNextToTitle
String
State.Placeholder
String
State.Show
Bool
State.Title
String
State.Validation.Required.Apply
Bool
State.Validation.Required.Message
String
Country Specific Properties
Type
Country.OptionalNextToPlaceholder
String
Country.OptionalNextToTitle
String
Country.Placeholder
String
Country.Show
Bool
Country.Title
String
Country.ValidateOnFocusLost
String
Country.Validation.Required.Apply
Bool
Country.Validation.Required.Message
String
The Purchase API has been modified to support Country Only Starts from SP for NCS Circ Digital Subscriptions. NCS Circ accepts any country (country code) as part of the address.
With this new enhancement, NCS Circ now supports subscriptions that include only country information in their addresses. Consequently, sync processes have been modified to handle these addresses appropriately, ensuring no changes or overrides occur in the address information for subscriptions with ‘Country Only Starts’.
Country code in NCS Circ must match the respective Country code in Subscribe. If there is any difference in the setup, the sync process will not work correctly.
Prerequisites:
Circ System & Minimum Supported Version: NCS Circ, 2020-2.3
Implementation Notes:
To enable the Country Only Starts,
* The isInternational field must be turned ON in the CMS Presentation.
(CMS >Subscription Panel > Presentations > Select a Presentation > Presentation Properties V3 > isInternationalfield)
* The Country field should be turned ON from the CMS.
(CMS > Subscription Panel > Presentations > Select a Presentation > Page V3 > Step V3> Independent Address V3 or Billing Information V3 > Countryfield)
The MG2 Control App setting key RealTimeUpdateOccupantFlowshould be turned ON to reflect addresses in SubCon Admin in real-time.
Note:
The Country-Only flow is available for NCS Circ clients that are using Payway and Cybersource payment vendors.
On the NCS Circ side, the value of the Digital Address property "Country" should be set to "Required."
When providing a Country Only Start, the Zip Code field must not be included in the CMS presentation. If the Zip Code field is present in the CMS presentation, even with the isInternational flag turned ON, the zip code flow will take priority.
2. ApplePay MPAN via Payway
New ApplePay Billing Agreement section in SolCon
With the integration of ApplePay MPAN, the Billing Agreement screen within the Apple payment flow now requires additional details, such as the auto-renewal amount. This enhancement is essential in scenarios where the renewal amount differs from the initial payment made by the subscriber (e.g., an introductory rate of $0.99 for the first 3 months, followed by $14.99 per month thereafter).
To support this, a new sub-section titled "ApplePay Billing Agreement" has been introduced under the SolCon Price Setup. Within this section, a new field called "Auto-renew Price" has been added. This field allows users to specify the auto-renewal price for subscriptions. By default, this field will be blank.
The auto-renewal price defined in this field will be included in the Offer API response across all relevant endpoints. This ensures that accurate pricing information is consistently communicated to the consumer application, which then relays this information to Apple during the billing process. This enhancement guarantees that the correct auto-renewal price is presented to subscribers, maintaining transparency and preventing discrepancies in billing.
An informatory note is also displayed below the Auto-renew Price field - “This amount reflects in ApplePay Billing Agreement screen. The auto-renew term & length will be displayed from Coding section.”
ApplePay MPAN transactions are available only through Payway as of now.
To ensure correct configuration, warning messages have been implemented under the following conditions:
ApplePay Auto-renew Price Not Set:
When ApplePay is selected as a payment method and EZPay is set to "EZPay required" or "EZPay optional," but the ApplePay Auto-renew price is not set, a warning message will appear on saving/updating the offer:
"ApplePay Auto-renew Price under Price section is not set. The renewal price will not reflect in ApplePay Billing Agreement."
ApplePay Auto-renew Price Set Without Proper Configuration:
When the ApplePay Auto-renew price is set, but ApplePay is not selected as a payment method, EZPay is set to "No EZPay”, a warning message will appear on saving/updating the offer:
"You have set the value for ApplePay Auto-renew price, but it will not reflect anywhere if ApplePay is not selected as a Payment Method and EZPay is set to No EZPay."
ApplePay Auto-renew Price Missing:
If the EZPay is already set to required/optional and the Payment Method is selected as ApplePay, or if the Payment Method is already ApplePay and EZPay is set to either "EZPay required" or "EZPay optional", a warning message will appear even before saving/updating the offer:
"Please set the ApplePay Auto-renew price in all the price plans."
The price plan counts will be highlighted in Amber wherever the ApplePay Auto-Renew Price is null or set to 0, ensuring that users are aware of incomplete configurations. This enhancement ensures that all ApplePay configurations are properly set, preventing potential issues in the payment flow and improving user experience.
An MG2 Control setting EnableApplePayBillingAgreement has been introduced to control the display of the ApplePay Billing section in SolCon. This section will be available in SolCon only if the key ‘EnableApplePayBillingAgreement’ has a value of 1. When the setting key value is 0, the ApplePay Billing Agreement section will not be visible in the SolCon. When the section is not visible, the related warning messages will also not be displayed while creating an offer group, while updating an offer group, or while updating an offer group, and saving it as new.
Implementation Settings:
A new AppSetting key is added: EnableApplePayBillingAgreement (AppSetting - Client Components - SolconAdmin). The key should be configured at the Client Group level.
ApplePay MPAN Recurring Payment and Billing Agreement Enhancement in Subscription Panel
The ApplePay recurring payment is implemented in SP. For an ApplePay MPAN transaction, if the offer has a recurring amount that differs from the initial amount, the recurring amount and the renewal term will be displayed in the Billing Agreement in SP. If the renewal term is in weeks, it will be converted to days and will be displayed in the Billing Agreement since Apple doesn’t support weeks.
The Marketing text configured in the offer will be displayed in the Billing Agreement regardless whether it is enabled in the Presentation or not.
The EZPay checkbox (if visible on UI), will be disabled once ApplePay payment is completed.
The other payment options and ApplePay payment button are also disabled once ApplePay payment is completed.
If appleRenewPrice is zero in SolCon, the Price will be the same as the Total Price including taxes, price of base product and price of activation (if applicable) in the billing agreement section of ApplePay popup.
Billing agreement section will not be visible in the ApplePay popup, if the EZPay is not applicable for the offer or if the user has not checked Ezpay checkbox if EZPay is optional in the offer.
Implementation Notes:
The Config file should contain a BillingAgreement key.
Ex- config.ThirdPartySystems.ApplePay.Constants.BillingAgreement = "You are purchasing a news subscription".
The Config file should contain a PaymentDescription key.
Ex- config.ThirdPartySystems.ApplePay.Constants.PaymentDescription = "Payment for news subscription".
Ezpay V3 component should be set in CMS presentation.
"isEzPay Validation Validation Apply" property should be turned ON in Ezpay V3 component.
The following Ezpay component properties should contain the appropriate text messages:
a. EZPayTextWhenCheckboxAbsent
b. EZPayTextWhenCheckboxPresent
c. EZPayNotAvailableText
d. isEzPay Validation Validation Message
For ApplePay MPAN transactions, the PaymentSource sent to NCS Circ will be "ApplePayMPAN”. Consequently, the sync processes can process the new payment source ApplePayMPAN.
Prerequisites:
Circ system & Minimum Supported Version:
NCS Circ, 2020-6.3
NCS Extract Version 4+
3. Digital Offer Zip Code Validation in Landing Tiles
The Promotion Digital V3 component has been modified to include zip code-related properties, allowing users to input a zip code value at the first step of the offer or promotion tile(s). Changes will be reflected in the Subscription Panel, depending on the configurations that have been defined in these properties.
The user can configure the properties by going to:
CMS > Subscription Panel > Presentation (Choose a valid presentation) > PageV3 > Landing Tiles > Promotion Digital V3
The entered Zip Code will be validated on the Subscription Panel's landing page, depending on the configurable flag "ValidateDigitalOfferZipcode."
When the value has been set to true, the zip code entered by the end user will be validated from the list of available areas for digital offers that are displayed on the landing page for digital tiles.
The zip code will not be validated if the configurable flag has been set to false.
Implementation Notes:
The user can configure the properties by going to:
CMS > Subscription Panel > Presentation (Choose a valid presentation) > PageV3 > Landing Tiles > Promotion Digital V3
"ValidateDigitalOfferZipcode" should be added in the SP Config file of the client newspaper/publication.
In config.System, set the ValidateDigitalOfferZipcode to true or false.
If ValidateDigitalOfferZipcode has not been included in the SP Config file, the value of the flag will be automatically considered false.
4. Eigen Integration via NavigaPay
Subscribe has successfully integrated the Eigen Payment gateway via NavigaPay for payments through the Self-Service portal and Subscription Panel ensuring proper styles and a fully functional end-to-end payment flow. Post the integration, when a user initiates a payment request from the Self-Service portal or Subscription Panel, an iFrame gets rendered on the SS or SP page that captures payment details and users can submit their payments successfully.
CMS - New Component for NavigaPay Eigen Payment Vendor
A new component NavigaPayEigenV3 is now available within the Component Manager and Presentation sections in CMS along with its associated properties.
The properties of this component are as follows:
Property Name
Display Name
Data type
Summary.Name
Summary Name
String
Summary.CardNumber
Summary CardNumber
String
Summary.ExpirationDate
Summary ExpirationDate
String
Title
Tile
String
Alt
Alt
String
Image
Image
String
Due to vendor limitations, the Eigen server can only support two CSS files out of which one file is used by SP and the other by Self-Service. Since each consumer application can only have one CSS file, all themes (Default, Simple, Seamless) will share the same CSS within the iFrame.
Some amendments have been done to accommodate the End payment session endpoint not to fire the Get profile request for NavigaPay-Eigen integration with Subscribe.
Timeout Management in Self-Service and Subscription Panel
A Timeout feature has been introduced in the Self-Service and Subscription Panel Payment pages. If the Eigen iFrame remains idle for 5 minutes, the system detects the inactivity and triggers an idle timeout. A clear and informative timeout error message will also be displayed to the user explaining that the user has been timed out due to inactivity. The message will also request the user to retry. Upon displaying the timeout error message, the iFrame reloads automatically with blank input fields so that the user can re-enter the payment details.
Some amendments have been done to accommodate the End payment session endpoint not to fire the Get profile request for NavigaPay-Eigen integration with Subscribe.
Prerequisites:
Circ System & Minimum Supported Version: NCS Circ, 2020-6.3
Implementation Notes:
For Eigen integration, the key NavigaPay.Integration should have value “Eigen".
The MG2 Control keys SubscriptionPanel.NavigaPay.SiteCode and SubscriptionPanel.NavigaPay.SiteKey must be defined.
Select an appropriate presentation -> Page V3 ->Step V3 -> Payment Methods V3 -> NavigaPay Eigen V3
5. ImpressPay (now FluidPay) Integration via NavigaPay
Starting with this release, FluidPay has been integrated with Subscription Panel and Self-Service portal applications via Naviga Pay.
It is now possible for users to complete payment-related transactions such as One-time payment, Auto renew sign up, etc. using FluidPay as the payment provider from Self-Service portal. On every payment-related page, the Self-Service portal displays the FluidPay iFrame through which payment details are captured and passed to the circulation system and then processed accordingly.
CMS - New Payment Method Component
A new component, NavigaPay ImpressPay V3, has been added to the CMS to be used as one of the payment methods in the Subscription Panel.
The user can configure the properties by going to:
The Purchase API has now been updated to include a new parameter, "ExternalCustomerId", that captures the GroupID value received from NavigaPay's EndPaymentSession (getNavigaPayImpressPayData) endpoint when processing a payment using FluidPay payment vendor.
Implementation Notes:
The MG2 control App setting keys such as SubConSite.NavigaPay.SiteCode and SubConSite.NavigaPay.SiteKey must be configured.
The MG2 Control API keys SubscriptionPanel.NavigaPay.SiteCode and SubscriptionPanel.NavigaPay.SiteKey must be defined.
General Enhancements
SubCon Admin
1. One-time tip for NCS Circ subscriptions that are not on EzPay
The users can now tip the carrier with the help of CSRs for the subscriptions paid by invoice (that are not on EZPay) without any additional payment, whenever necessary. An ‘Add tip’ button will be available on the Payment/Billing tab near the ‘Make a payment' button. The 'Recurring Tip’ checkbox will not be visible on UI in this case.
Note:
Until a tip amount is entered, the 'Pay with' buttons will remain disabled. Clicking on the 'Cancel' button closes the form with no further action.
A limit of 'only one payment transaction within 24 hours' is applied. If another transaction is initiated within 24 hours of a previous payment, a warning message will be displayed, and the 'Add tip' button will be disabled, restricting the user from proceeding further.
Implementation Notes:
The MG2 Control App setting key ‘StartCallPaymentBillingTabAddTipButton’controls the visibility of the ‘Add tip’ button. The Add tip button will be visible on SubCon Admin when the key value is set to 1 in Support Viewer.
2. Offer Grid column name standardization in NewStart/Upgrade Flow
The column names of the Offer Grid in the New Start/Upgrade flows have been standardized from this release to correctly reflect the values that are being populated in the offer grid columns from SolCon. There is no change in the values being populated in the columns; the only modification is in the column header names. The Offer Grid will now have the following columns for New start and Upgrade workflows.
Offer ID will populate offer IDs from SolCon (No change in this column name)
Offer Name will populate corresponding offer names from SolCon (The previous name Internal Name has been renamed)
Offer Highlight column will have the Marketing Text > Confirmation Name from SolCon (The previous column name was Confirmation Name)
EZPAY column will populate corresponding EZPay Options from SolCon for each offer
Note: The Quantity column will no longer be available on the Offer screen as it always shows a static value of '1'.
Implementation Notes:
The value (0 or 1) of the Support viewer Key "RealTimeNewStartFlow" will have no impact on the Offer Grid column for the New Start or Upgrade Offer screen.
3. Registrations Limit for Standard Subscriptions
A new editable field Number of Registrations has been added in the Account information tab for Standard Subscriptions. Through this field, it is now possible to configure the number of maximum subscription registrations that can be associated to a subscription. However, the value in the Subscription.MaxLinks Support Viewer key cannot be overwritten from UI.
The value being entered or edited in the Number of Registrations field should always be less than the Support Viewer key setting value.
If the CSR/Admin user enters a value in the Number of Registrations field that is less than the value set in the SV key, a success message will be displayed. However, if a value larger than the one set in the Support Viewer key Subscription.MaxLinks is entered, the user will receive a notification message.
Implementation Notes:
The value of the 'Number of Registrations' field should not exceed the limit set for the Support Viewer key Subscription.MaxLinks.
SolCon
Swapping the position of Product + Price block with Division block
For a better user experience, the position of Product + Price block has been swapped with the Divisions block on the Offer Groups and Offers pages while creating a new offer or editing an existing offer.
The Division selection happens first and then the Products are filtered based on the selection. Hence it is more appropriate to give the option to select the Division first. However, there is no change in the existing functionality or behavior.
API
1. Subscriptions - Validation check for the RegistrationCount while updating a subscription
A validation check has been introduced to ensure the new value for Registration Count will not be less than the number of existing links (between actual links and invitations), as well as to prevent the user from changing the value to 0.
When entering a number that exceeds the maximum value defined in the MG2 Control setting "Subscriptions.MaxLinks," the error message will now display "Registration count cannot be greater than {{Subscription.MaxLinks}}".
In addition, when entering a number less than the total number of Pending invitations and Active Registrations, the error message will now display "Registration count cannot be less than <Active+Pending>".
2. Removal of unnecessary special characters
When making a subscription/subscriber-related API call to NCS Circ, special characters in the following parameters will be removed before sending the request, with the exceptions listed below:
Serial Number
Field Name
Allowed Special Characters
1
First Name
' - & / .
2
Last Name
' - & / .
3
Email
@. + - _ ,
4
Cardholder Name
' - & / # .
5
House number
/ -
6
Unit number
No Special Chars.
7
ProductID
_ - $ + ( ) & ^ . / ,
8
SourceCode
_ - $ + ( ) & ^ . / ,
9
SubSourceCode
_ - $ + ( ) & ^ . / ,
10
ReasonCode
_ - $ + ( ) & ^ . / ,
11
DeliveryMethod
*
12
DeliverySchedule
_ - $ + ( ) & ^ . / ,
13
MerchandiseCode
_ - $ + ( ) & ^ . / ,
14
BillingMethod
_ - $ + ( ) & ^ . / ,
15
RateCode
_ - $ + ( ) & ^ . / ,
16
ARTerm (Auto Renew Term)
_ - $ + ( ) & ^ . / ,
17
BillPeriod
_ - $ + ( ) & ^ . / ,
18
SSOEmail
@ . + - _ ,
19
Remarks
_ - $ + ( ) & ^ . / , @
20
TokenID
_ , -
21
UniqueCustomerID
_ , -
22
PaymentSource
_ - $ + ( ) & ^ . / ,
23
PymtPaymentSource
_ - $ + ( ) & ^ . / ,
24
CreditCardNumber
*
25
CreditCardExpire
/
26
CardHolderName
' - & / # .
27
BankHolderName
' - & / # .
28
PayPalBAID
-
29
PayPalEmail
@ . + - _
30
PayPalHolderName
' - & / # .
31
Term
_ - $ + ( ) & ^ . / ,
32
PaymentTokenID
_ , -
33
PaymentUniqueCustomerID
_ , -
34
PaymentCreditCardNumber
*
35
PaymentCreditCardExpire
/
36
PaymentCardHolderName
' - & / # .
37
PymtPayPalEmail
@ . + - _
38
PymtPayPalHolderName
' - & / # .
39
EbillEmail
@ . + - _
40
PayAdjustmentCode
_ - $ + ( ) & ^ . / ,
41
AdjustmentCode
_ - $ + ( ) & ^ . / ,
42
TrialTerm
_ - $ + ( ) & ^ . / ,
Prerequisites:
Circ System & Minimum Supported Version: NCS Circ, 2020-6.0
3. UserOrchestrator - Enhanced Error Messaging for Invalid Input
Previously, the UsersOrchestrator APIs would return a generic error message "Invalid InputModel" if an invalid value was entered into any of the input parameters. Changes have now been made by implementing detailed error reporting, such that invalid input errors now include the name of the parameter containing the invalid value: "Invalid InputModel - {Message}".
4. Address - Matrix tenant for Get Countries endpoint
The list of countries displayed in SP was not governed by the Matrix Country-Only rule. If the Country-Only rule was not enabled for a country in Matrix but that country was included in the list shown in SP, the subscription would result in an error during processing on the Matrix side, while no error would occur on the SP side during the purchase process.
Changes have been made so that the GET /Countries endpoint now retrieves the list of countries applicable under the Country-Only rule in real-time and displays it in the Country drop-down menu in the Subscription Panel, instead of displaying all countries in the Subscribe database.
Prerequisites:
Circ System & Minimum Supported Version: Matrix, M 38.00.034.ITSP9
Subscription Panel
1. Credit card data corrections in the Payment and Purchase APIs
The input parameter, NumberLastFourDigits, of the Purchase API will now be sending the last four digits of the credit card instead of the first four digits of the card to the AddSubscription endpoint.
When the circulation system is CircPro, the AddSubscription event now concatenates the original token with the last four digits of the credit card number, separated by a pipe (|) and the text 'LAST4='.
Changes have been made to the Payments API to enhance the process for EZPay sign-ups, subscription restarts, one-time payments, and credit card information updates. The process event types—16 (EZPAY), 24 (CHGCC), and 27 (RESTART)—will now include the last four digits of the credit card in the CardToken parameter when sending to CircPro, formatted as '<token>|LAST4=<last four digits>'.
For one-time payments, event type 970 (ToOneTimePayment), the last four digits will be removed, and only the original token will be sent to CircPro.
Prerequisites:
Circ System & Minimum Supported Version: CircPro, 2021-3.0
2. Incorporate API changes for last four digits of Credit Card
While making a payment from the Subscription Panel if the payment vendor is Cybersource, the last four digits of the Credit card number will be sent to the Purchase API endpoint. The subscription workflow will not have any impact. The subscription will then be processed at the Circ side.
3. Accommodating Engage G3I plugin in SP
A new plugin setting has been added and initialized along with DL and FP plugin on the Checkout page (Subscription Panel). The new plugin settings will accommodate the changes related to the new Engage G3I plugin. The name of the new plugin settings is configurable from SP Config. SP config has an on/off for each plugin that controls the availability of each plugin for a specific client.
Implementation Notes:
The following keys are used to utilize the G3I plugin under the NewMG2Insights key along with ‘MG2Insights’ in config.MG2Loader:
Name: "DLNew",
Enabled: true,
Version: <specify the version>
ContainerId: <specify the Container ID> for ex: "GTM-5ZBPF7G"
Bug Fixes
Self-Service
1. Stop Saver flow without a successful cancellation message
When a customer follows the Stop Saver flow and chooses to cancel, a success message was not appearing after completing the cancellation. This issue has been resolved. After the fix, when a subscription is successfully canceled from the Stop Saver page, the success message is now displayed, and the user is subsequently redirected to the Dashboard page.
2. Error message while entering wrong year in the Expiration year field
While making a credit card payment in SS, Cybersource clients were not receiving an error message if the expiration year entered was in two digits. Although most payment vendors accept the last two digits for the expiration year, Cybersource requires four digits. When users entered only two digits in the expiration year field, the payment process was unsuccessful, and they did not receive a clear error message indicating the issue.
This issue has been resolved by adding a placeholder (description) for the expiration year field. The new placeholder is configurable from the CMS and clearly indicates that the expiration year must be entered as four digits.
Implementation Notes:
Two new CMS segments, Placeholder.ExpirationMonth and Placeholder.ExpirationYear, have been introduced. These segments can be added to any payment page to correctly indicate the expiration month and year format to the user.
3. Restriction on EZPay Sign-Up Page Access for Existing Subscribers
When a user already enrolled in an EZPay subscription tried to access the EZPay sign-up page, the system was allowing it, which was not the expected behavior. This issue has been resolved. After the fix, if a user already on EZPay tries to access the EZPay sign-up page, the system will display a message informing them that they cannot access the sign-up page. If they wish to proceed, they will need to cancel their existing EZPay program.
4. 'Vacation Holds' Button label display issue
When the user clicks on the 'Vacation Holds' button on the Dashboard page, they are navigated to the temporarystop page. The text 'SUBMIT PAUSE REQUEST' was previously displayed outside the button border on the temporarystop page. This issue has now been resolved.
5. Credit Card Expiration details not getting captured in the CircPro Circulation system
While updating the payment method or signing up for Auto pay, the expiration details of the end user’s credit card was not getting captured by the Circulation system. This issue was specifically observed with the CircPro circulation system and has been resolved.
SubCon Admin
User not getting logged out from other Subscribe application on logout
When Subscribe applications (SubCon Admin, CMS or SolCon) were opened in multiple tabs on a Safari browser, logging out from one application in a tab didn't log out the user from other applications opened in different tabs, until the respective pages were refreshed. This issue has now been resolved.
CMS
1. End Date is displayed as Invalid when creating a scheduled slideshow
CMS > Slideshow > Add > Enter the details > Submit
When creating a new slideshow that was scheduled to appear at a specific date range, the issue with the end date being displayed as "Invalid Date" after submitting has now been resolved.
2. Incorrect error message while overriding message under notification new section
CMS > Notifications New > (Navigate to the desired notification) > Edit (update the message field) > Save > Remove Override
When removing an override of a notification after modifying the notification message, the incorrect success message "Message successfully deleted" was displayed instead of the correct message "Override successfully removed". This issue has now been resolved.
3. Incorrect Error message while overriding Benefit order
When overriding the Benefits order, the system was displaying an incorrect error message, such as 'Benefit order successfully deleted,' instead of the expected message, 'Override successfully removed.' This issue has been resolved. After the fix, whenever a user overrides any Benefit order (CMS > Benefits > Select a Benefit > Display Order > Remove override), the system performs the override and displays the correct message: 'Override successfully removed.'
API
1. Expiration date not populated for inApp Subscriptions
The issue of Expiration Date appearing null for subscriptions purchased through Google has been resolved.
2. Mismatch in Subscription Statuses
There was a mismatch between the subscription status (Subscriber status) displayed in SubCon Admin and the status shown in the NCS Circulation system for a subscription purchased through the Subscription Panel. This issue has been resolved.
After the fix in this release, the NCS Circ subscription status will be synced with the Subscribe database, ensuring that the Subscriber status displayed in SubCon Admin matches with the status displayed in the NCS Circ system. Note that this change has no impact on the Self Service.
Note:
The syncing of NCS Circ subscription status with the Subscribe database will be as outlined in the table below for subscriptions that are not Lite, In-App, or PaidPass.
Subscription Status in NCS Circ
Subscriber Status in Once CSR Portal
ACTIVE
ACTIVE
IN GRACE PERIOD
IN GRACE
TEMP STOP
PAUSED
VAC–ONLINE
PAUSED
ON VAC PACK
PAUSED
PERM STOPPED
STOPPED
EXPIRE STOPPED
STOPPED
NOT STARTED
FUTURE
Refactor
SubCon Admin
Append parameter to NavigaPay Iframe URL
Once CSR portal has appended a new parameter, ‘operation=CreateProfileRedirect’ while making call to the iframe URL of NavigaPay. This is a refactor without impacting the application workflow. The iFrame URL is received as a response from the microAPI with parameters sitecode & sitekey. This is a refactor and no changes to the end-user.
Note: Since SubCon Admin is not using ApplePay, the value of the operation parameter remains static as ‘CreateProfileRedirect’ for SubCon Admin.
Self-Service
1. Angular Upgrades
Self-Service portal has been upgraded to Angular version 15.2.10. The necessary changes to ensure proper builds have been implemented. It has been ensured that all packages (dependencies) are upgraded in parallel.
2. Deprecation of Themes ThemeC and ThemeD
Starting from this release, ThemeC and Theme D have been deprecated. This change is completely transparent to the users.
3. Simplification of Backend workflows
After a comprehensive review and analysis, a list of all Circ-specific modules were listed and Circ-specific components have been eliminated. Alongside the front-end analysis, the SS backend was also examined to identify potential enhancements. A common workflow for each feature has been established. A Circ-system can override the common workflow, only if necessary, by following specific additional steps.
The following modules were simplified through this approach:
Address
Billing
Transactions
Invitation
Subscription Cancel
Subscription Link
Subscription Update
Temporary Stop
However, this refinement has no visual implications.
4. Structure Consolidation of Self-Service Pages
The appearance of Self-Service webpages has been based on one of two structure styles: Type A or Type B. While these structures were mostly identical, with only slight differences, an initiative has been undertaken to unify these structure styles for the following pages:
Note: Moving forward, a common design (structure) will be uniformly applied to the below mentioned pages, ensuring a cohesive and streamlined visual experience.
4.1 Access Page
The styles of Type A and Type B were very similar for the Access page, with the exception of the AccessAskQuestionBoxText CMS content, which was present in Type A but not in Type B.
Nevertheless, there is a generic HelpText content already available to serve the same purpose. Hence, moving forward, the Access page will adopt a generic Structure, and the AccessAskQuestionBoxText has been removed from this generic structure.
4.2 Activate Page
Type A and Type B structures of Activate page were nearly identical. Moving forward, Type B will serve as the generic structure for Activate page.
4.3 eBill Sign up Page
Type A and Type B styles were very similar for the eBill Sign Up page. The only difference was that the Type A eBill Sign up page displayed the subscription’s full name and current date, while Type B did not.
The eBill Sign up page will adopt Type B as the generic structure and regardless of the configured Theme for the Tenant (Theme A or Theme B), the page will display elements in accordance with Type B.
4.4 eBill Manage Page
Type A and Type B styles were nearly identical for the eBill Manage page. To streamline and simplify, starting from this release, the eBill Manage page will adhere to Type B as the generic structure regardless of the theme configured for the page.
4.5 Feedback Page
While there were some differences between Type A and Type B for the Feedback page, starting from this release, Type B will serve as the generic structure for the Feedback page. The MailingAddressLabelText and MailingAddressText CMS contents, exclusive to Type A, have been removed from the generic structure.
4.6 MyProfile Page
Both Type A and Type B displayed the same sections on the My Profile page. While Type A used accordions, Type B employed Boxes to showcase these sections. Starting from this release, the My Profile page will adopt the Box approach from Type B for section display regardless of the theme configured for the page. Organized in columns and configurable for hiding, each box provides enhanced flexibility.
Note:
On the My Profile page, the Login Information, Change Password and Profile Information boxes will be organized in columns:
If 2 boxes are to be displayed, they will appear side by side as displayed below.
If 3 boxes are to be displayed, the first two boxes will appear side by side, while the third one will be positioned below the first as displayed below.
4.7 Subscription share Page
Type A and Type B were almost identical, with the only difference being the absence of a page description in Type A. Type B will serve as the standard structure for the Subscription Share page regardless of the theme configured for the page.
4.8 Unsubscribe Page
Type A and Type B were nearly identical. Therefore, Type B will be used as the generic structure for the Unsubscribe page regardless of the theme configured for the page.
4.9 Verify Account Page
Both Type A and Type B had almost the same content and styling. The only difference was that Type B had “Left Panel” and “Right Panel” above the form, while Type A had only the “Right Panel.” Their styles also varied slightly, but the form itself was identical for both. Therefore, Type A will be used for the VerifyAccount page as the generic structure regardless of the theme configured for the page.
5. Activate - Changing the SiteCode without causing a Postback
Some enhancements are in place in the Navigation Service to perform a "Site code change" without performing a redirect on the Activate page of SS. This development has no impact for end users, it's just to maintain the concept of Single Page Application.
Instead of a Browser page refresh, the user would now see a controlled redirect handled by the Application on the Activate page.
6. Deprecate Manifest.json files
With this release, the option to download the Self Service as a desktop application has been deprecated. This decision was made due to the lack of client utilization of this feature and the considerable workload it imposed on the implementation team during the onboarding of new clients.
Implementation Notes:
The Manifest.json file has been removed from every client.
The references to Manifest.json (in the web.config file) has been removed from every client.
The new “title” property has been populated in every client’s Subcon.Config with the value that the manifest.json used to have as “name”.
Note: For future clients, it is recommended to consider this approach to avoid the creation of new Manifest.json files for the client.
7. Removing the duplicate code on Activate page
The Activate page will now use Forms components. The duplicate code in the Activate page has also been removed. The logic behind the calculation of the User Access level has also been centralized and is implemented as a single invisible step between the Verify and Upgrade steps.
Implementation Notes:
New property introduced in Subcon.Configuration: "VerifyAccountForm". It is exactly the same as of the VerifyAccount module, but it was moved to this property to be reused in Activate module.
8. Datepicker Improvements
The code for calculating dates in input date picker will be the only one effective on SS pages from this release. All the other code that calculates the first date has been removed from SS pages. The input date picker will be used in the Restart page as well from this release. The duplicated code regarding date calculation in the Restart page has also been removed.
The changes are transparent to the user.
9. Renaming the Authentication token
When an end user logs in to the Self-Service with valid credentials, a cookie namely X-AuthToken gets generated. The name of this authentication cookie was too generic. Hence, starting from this release, the X-AuthToken authentication cookie has been renamed to “nav-ss-authorization”, which is something more specific to Naviga Self Service. From this release, after performing an authenticated login, nav-ss-authorization cookie will be generated.
This change is completely transparent for end users.
10. Recovering sessions for MG2Auth clients in Self-Service
Self-Service will no longer decrypt the igmRegID cookie value for MG2 Auth clients. The cookie value will be used as is in the GET /Users endpoint call (UsersOrchestrator API) to fetch user details for session recovery in the event of a page refresh.
This change has no impact on end users. A logged-in MG2 Auth end user will remain logged in on SS even when the SS page is reloaded.
API
API - Purchase
Internal Enhancement: Steps Lists, Code clean up
As part of the 3.17.1 Refactor, a code cleanup has been made in the Purchase API to minimize complexity related to handling the list of steps in each integration during a Newstarts flow due to the number of classes involved in the process.
Future Enhancements
CMS
Payment Method Component - ApplePay
A new component, NavigaPay ApplePay Payway V3, has been added to the CMS to be used as one of the payment methods in the Subscription Panel.
Implementation Notes:
The user can configure the properties by going to:
This page containes the description of the hotfixes related to 3.16.0 version
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Please note that all the 3.16.0.X hotfixes are by default included in both the minor and major versions being in development, which are 3.16.1 and above and 3.17.0, respectively
If you want the fix to be applied please input a Salesforce case
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Cancellation options for Account Management
In the scope of 3.16.0 we added three cancellation options for Account management: Cancel immediately, Cancel next billing cycle and Cancel at a future date. However, we realised that there was no way to manage these options' visibility, and also they were sending the wrong StopType. Those two issues were fixed in scope of this hotfix.
The ability to manage the visibility of the cancellation option through Account Management settings was added. The following settings can be set to either true or false:
DisplayImmediateOption
DisplayNextCycleOption
DisplayScheduleDateOption
To manage CancellationTypeId for each option in addition to already existing SubCon.Cancel.DefaultStopType API setting in MG2 control the three new API settings were created:
SubCon.Cancel.NextBillingCycleStopType
SubCon.Cancel.ImmediateStopType
SubCon.Cancel.ScheduleDateStopType
The setting value should be sent to the following:
for the cancellation on the next billing cycle = 1
for the immediate cancellation = 2 4
for the cancellation at a scheduled date = 3 2
Areas Covered: Subcon Site (Account management), API
For the fix to work correctly please apply the 3.16.0.6 hotfix that contains mandatory scripts
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Backward compatibility for inApp starts
Starting from 3.16 onwards Purchase API must be for all the new starts. There are two endpoints /Purchases (to receive Standard, Comps, PaidPass, Gifts, etc for all Circs) and /Purchases/InApp (to receive InApp and SwG).
/Purchases/InApp is prepared to redirect to Subscriptions API or Pu
rchase API based on an MG2 Control setting. This works for consumer apps but it is going to be a problem for all the clients using InApp today since they were not notified they need to switch the endpoint. Since we want to have backward compatibility with our external InApp consumers, re-add the POST /Subscription endpoint with a condition that it can be used only for InApp new starts.
In the scope of this hotfix, we also fixed the issue with the Payway form not being loaded in the Edge browser in Account Management.
Areas Covered: API, Account Management
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
CircPro related fixes
This hotfix is dedicated to CircPro-related issues. The following issues are covered:
wrong redelivery issue dropdown options when submitting a complaint in Account Management
unit designator not being sent in CircPro for a new start
scheduled vacation not being synced during overnight database sync
new start with ApplePay or Google Pay passing zero amount to circ
displaying negative balance in Account Management while it's actually positive
Areas Covered: Account Management, API
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Auth0 issue fix
For Auth0 we had a problem with ProcessLogin failing because the Auth Endpoint was using the User ID instead of Internal_id for Advance Tennant. The issue was fixed in scope of this hotfix. Now for Advance Auth endpoint uses Internal_id.
Areas Covered: API
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Digital payments issues: ApplePay with Payway, GooglePay
Some ApplePay starts with Payway were failing due to ApplePay Payload not having the ECI Indicator. The issue was fixed in scope of the current hotfix, new MG2Control's Setting (API Setting) was added:
The old GooglePay watermark image is now replaced with the new watermark in the checkout flow
Fixed the error of GooglePay icon still being visible in checkout flow even if unchecked in Solicitor Concierge
Areas Covered: API, Subscription Panel
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Database focused
This fix contains the scripts that populate CancellationTypes and NewspaperCancellationTypes in subsvc database as part of the dacpack. These scripts are required for the cancellation options for Account Management to work correctly
The fix also includes some optimisation of the subsvc database used by One CSR Portal:
ApiGetUserEmailPreference and ApiUpdateRegistration stored procedure optimised.
The new index in the Registration table is created; EmailAddressId column is included in the existing index of the EmailAddress table.
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Seamless flow with Independent Address fix
Previously, a bug was introduced that caused the user to have to click twice instead of a single click to purchase the subscription after entering billing details when the seamless presentation was configured with the Independent Address component. The issue was fixed in the scope of this hotfix.
Areas covered: Subscription Panel, CMS Admin
This fix was also merged to 3.15.3.4 and 3.15.2.3.
Updated on June 26th, 2023
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Braintree SDK update
Braintree is sunsetting their API on python platform. Hence, as per Braintree's recommendation, the backend Braintree SDK has been updated to version 4.18.1.
Areas covered: API
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Logging out when switching between .com and Self-Service
Due to the cross-site validation, Auth0 was deleting the cookie when visiting Self-Service after .com and vice versa. This was fixed by ensuring that the cookie is deleted only when the user actually clicks the Logout button.
Areas covered: Self-Service
This fix was also merged to 3.16.1.5
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
PayPal via Braintree Renewals fix
Paypal via Braintree Renewals have been getting declined in circulation. It was identified that the PaypalBAID parameter while purchasing the subscription on EZPay was not being sent accurately to Circ. The issue has been fixed by passing the appropriate parameter from the payment vendor to the circulation system.
Areas covered: Self-Service
This fix was also merged to 3.16.1.6 and 3.16.2.1
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Logout and access issues related with 3rd party cookies
The following issues were fixed:
Not being able to access downgrade page or logout when 3rd party cookies are blocked
Not being able to logout when 3rd party cookies are blocked
Logout after browsing to Newsletter page
Auth0's Integration was fixed and defensive code was added to APP_INITIALIZER flow. Inconsistent logic from auth0.service.ts was removed
This document is currently in progress
Areas covered: Self-Service
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Subscription Panel now recognizes existing users even after logout
When a subscribed user logs out from the Subscription panel and then tries to buy a new Subscription with his existing account, the user was not recognized as an existing user by SP. This was because the Customer Registration ID of the user was not available and hence the user was treated as a new user.
To overcome this issue, it is ensured that even if the user logs out, the system will make sure to fetch the Customer Registration ID that recognizes the user.
SP - User registration after third-party authentication
When a user was trying to buy a subscription after getting registered via a third-party authentication system (e.g., a user on newspaper site clicks on a link ePaper-->Auth0-->Subscription Panel), even after the successful authentication by Auth0, the registration was not created in the Subscribe database. This issue has been resolved now.
The fix was also merged to 3.16.1.5 and 3.16.2.2.
Transport Layer Security (TLS) Upgrade to Version 1.2
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket.
The Hotfix 3.16.0.13 documentation was updated on June 12th, 2023.
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
This fix was also merged to 2.39.1, 2.39.1.0, 3.15.3.1, 3.15.2.1, 3.16.1.7, 3.16.2.4, and 3.16.3.
Issue with 'Mark as processed' button
The issue with the 'Mark as processed' button in SubCon Admin has been resolved.
This fix is also merged to 3.16.1.8, 3.16.2.5 & 3.16.3
Seamless Flow updated for Credit Card Edgil Payment Method
In the seamless flow, if the Independent Address component for the payment page has been enabled, users could purchase or subscribe to a subscription with a single click after entering their credit card information. The issue occurs when the credit card details have been validated, the Submit button disappears, and the user is taken directly to the payment options, even if the fields, First and Last names, Phone, and Zip Code, have not been filled. This resulted in the AddSubscription call being triggered with incomplete information, and since the Submit iframe button is from a third-party payment site, it does not validate whether the aforementioned fields have been filled, resulting in no error warnings being displayed.
Changes have been made to allow the submission of incomplete fields if the credit card has already been validated in the seamless flow by introducing a delay time after each keystroke while filling the fields under the independent address component.
A key, "SeamlessInputDelayTime", must be added to the SP Config file with any numerical value. The value indicates the delay time in milliseconds, with the default value set at 1500 milliseconds (1.5 seconds).
For example, after entering the first name, it will wait 1.5 seconds and then call AddSubscription if no additional keystrokes have been detected. When the user starts entering the following fields, such as Last name, phone number, and zip code, the timer is reset after each keystroke, and the AddSubscription call is triggered only after a 1.5-second delay.
This fix was also merged to 3.16.1.9, 3.16.3.1, 3.15.2.4, 3.15.3.5, 3.16.2.5
This release is in its beta version now.
Attention - Enhancement
Enhanced Sign-In Mechanism of Landing Application
Recently, major browsers have introduced additional security measures and constraints related to third-party cookies, as well as cross-domain data transfer and communication. The latest release of Chrome no longer supports third-party cookies. These were impacting the functioning of the Landing application and user experience negatively. Despite the implementation of workarounds, users were encountering issues in the sign-in flow at times.
Therefore, the sign-in logic for the Landing application has been revised without significantly affecting the existing functionality and behavior. The previous dependency on local storage has been replaced, and a Redis caching approach is now implemented for the users to sign in on the Landing for accessing consumer applications (SubCon Admin, SolCon & CMS).
Following the new implementation, users can access any consumer application only through the Landing application.
If a user has opened different consumer applications on different tabs in a browser, logging out from one application will force the user to log out from the other opened applications as well. The user will regain access to the application only by signing in through the Landing application.
Page refresh will work as before and have no impact following the redesign.
Multi-Factor Authentication (MFA) with Okta will also work as intended if the feature is turned ON for the specific client.
There is no dependency on third-party cookies related to the Landing application, and the landing works perfectly fine on Safari, Firefox, Chrome, and Edge browsers.
Consumer applications are no longer dependent on Local storage to fetch data.
The CMS Idle Time functionality, which notifies the user if they have been inactive on a CMS page for an extended duration and provides the option to either continue or exit from the page, is working as before.
For a seamless user experience and as a best practice, please do not disable cookies in your browser.
This fix is also merged into 3.16.1.10, 3.16.2.8, 3.16.3.13 & 3.17.0.3 releases.
3.16.0
This page has high-level Release notes for the major 3.16.0 Release
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Please note that this is a complete document. The last changes made Sep 21st 2022.
The major 3.16.0 Release introduces several new features like new In Grace subscription status (NCS only), Restarts of stopped subscriptions for Matrix and CircPro circulation systems, import/export of selected Offer Group(s) in Solicitor Concierge etc. The Release also contains security and password improvements and search improvements. Several more use cases are now supported for upgrade/downgrade for NCS circ: upgrade/downgrade from Digital to Print with address update and upgrade/downgrade with opting in/out of ezpay.
Please note that due to the critical issues found we can not guarantee upgrade/downgrade from Digital to Print with address update and upgrade/downgrade with opting in/out of ezpay working correctly. We recommend waiting for the next version and apologize for any inconvenienceNote added Jul 5th 2022
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Starting from 3.16.0 Release PurchaseAPI must be used for all new starts instead of SubscriptionsAPI
IF you're currently using our SubscriptionsAPI, please input a Salesforce case requesting a new token for the PurchaseAPI
General Subscribe
Feature
Description
Notes
"In Grace" Subscription Status
New Subscription status In Grace is now supported in Subscribe. Subscription is assigned status In Grace when its balance becomes negative, but it is not considered as expired and can be used for the duration of grace period. Whether Grace is supported or not and the amount of grace days are set up in NCS Circ
NCS circ only
New phone for the Occupant
NCS circ only
Password and security improvements for Client Users
Minimum password length is 8 characters. Must include at least one lower alpha, 1 upper alpha, 1 digit, 1 special character
Ability to manage password settings (length, special characters, max password age, password history etc) was introduced in Landing app. Every time the password is reset the link is forced to the users to update their passwords
Report functionality was added to export the list of users with their Role and last activity date. Reports are available in One CSR Portal, Solicitor Concierge, CMS and Landing applications
Ability to manually lock/unlock users is introduced in Landing app. For example Client Admin can now manually unlock the user that was locked automatically due to multiple failed attempts to login
Ability to disable/enable users is introduced in Landing app to prevent access on users that are no longer relevant (e.g. retired) but keep their access record. Disabled users are not able to login and refresh tokens
Storing dates in UTC
All the dates used across One CSR Portal and Solicitor Concierge applications are now stored in database in UTC format. The dates are converted to local client date during GET requests
Restarts enhancement
Requires minimum 2020.4 version of NCS CIrc
Real-time Occupant lookup during new start
NSC Circ only
PurchaseAPI for DSI circulation system
DSI circulation system only
PurchaseAPI inApp
Ability to select between PurchaseAPI and SubscriptionAPI during inApp subscription purchase was added. The new setting isFlow.Purchase.InApp.Redirect
PayPal Auto-Renew Payments not authorizing fixed
The issue of auto-renew payments with PayPal being not authorized in PurchaseAPI was fixed by sending the correct Billing Agreement ID = B for auto-renew payments into Circ. The issue was caused due to the wrong value Billing Agreement ID being sent: EC, for one-time transactions
Note added Sep 21st 2022
One CSR Portal a.k.a. SubCon Admin
Feature
Description
Notes
Upgrade Digital to Print with Address update
Requires minimum 2020.2.1 version of NCS CIrc
Upgrade/downgrade with opting in/out from EZpay
NCS circ only
Search improvements
Search criteria was updated. The following fields are required to perform search: Email only OR Account number only OR Phone number only OR a combination of minimum three other fields.
Also the toggle was introduced to specify if the search should be done against delivery or billing address.
The changes were applied both to Subscription search section and search when linking a subscription under User accounts section.
Restarts for Matrix
Restarts of stopped subscriptions from One CSR Portal are now supported for Matrix circulation system
Requires minimum 38.0.34 version of Matrix
Restarts in CircPro
Restarts of stopped subscriptions from One CSR Portal are now supported for CircPro circulation system
Requires minimum version 2021-3 version of CircPro
Solicitor Concierge
Feature
Description
Notes
Import/Export of Selected Offer Group(s) only
During Export it is now possible to select offer groups you want to export. The offer group(s) selected will be exported will all the related entities required.
Exported file can be successfully imported.
Offer Group is not allowed to have more than One Base product
Trial renamed to Comp
DSI circulation system,
CircPro circulation systems
Subscription Panel
Feature
Description
Notes
GooglePay for Braintree+NCS
Requires minimum 2020.2.1 version of NCS CIrc
PayPal for frictionless ZIP only starts
NCS circ only
Gifting in NCS
Subscribe now allows end-users to purchase gifts for friends, family or self. The gift purchaser can send a gift immediately or on a certain date, e.g. to send on someone’s birthday. The person receiving gift should be able to redeem by clicking on the link in the gift email or manually entering the code. Clients would need to work with their email management team to send gifts on a specific date.
The gift flow issues have now been resolved for NCS Circ clients.
Available for NCS Circ version: 2020.2 Plus SP1 and above.
Available for NCS Circ version: 2020.2 Plus SP1 and above.
iFrame in liveMode for Authorize.Net
LiveMode for the iFrame in Authorize.Net was enabled in all environments for all the clients instead of testMode
Note added Jul 5th 2022
Authorize.Net
Seamless theme updated
The following changes have been made to the Subscription panel's payment checkout page interface:
Seamless Presentation Title Text
The title text of a Seamless presentation can now be defined in CMS through the Sticky Notes V3 component.
The issue with the floating label of the Password input box being distorted when focused has been resolved.
Note updated on June 29th, 2023.
Updated PayPal Button Style in the payment checkout page
The PayPal button's default style has been set to responsive from the Subscription Panel.
As a result, the button's size will automatically change and adapt to various screen sizes and devices.
Note updated on June 29th, 2023.
Account Management a.k.a. SubCon Site
Feature
Description
Notes
Upgrade/downgrade with opting in/out from EZpay
NCS circ only
Cancellation options
Similar to One CSR Portal, three cancellation options are now supported: Immediate cancellation, Next billing cycle, Future date
Note added Aug 15th 2022
For this feature to work correctly we recommend to upgrade to 3.16.0.1 patch or 3.16.1 version
3.16.1 Minor Release
The document contains the major new features and changes in the minor 3.16.1 release. It also documents known problems and workarounds, if any
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
This is a complete document. The last changes were made Oct 11th 2022.
3.16.1 is a minor release hence it does not contains any breaking changes, but mostly enhancements, bug fixes and several small new features. The new features supported are related to corporate subscription and registrations, localization and the Landing app.
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
New features
The following new features appear in this release
Feature
Description
Notes
Registration not required to send an Invitation
Until this release, for an invitation to be sent at least one registration linked with the subscription used to be required. Starting from this release an invitation for registration can be sent even without having an existing linked registration.
The visibility of the button is configured by UserAccountSearchDetailsInviteButton APP setting. To enable the feature, set the key to 1. The setting also controls the usual Invite button in the registration grid visibility.
Pre-requisites: N/A
Sign in through Invitation email
The user invited to join a corporate digital subscription can now accept the invitation received via their email and sign in to access the newspaper.
The recommended setup is:
in One CSR Portal go to Event Management tab -> Event Types -> Even Type Emails
select the Invitation Send Event Code and click Edit
in the Update Transaction Email Id window go to the Customer Email tab and select the Subscription Share Invitation option in the Template dropdown
Add the newly created CMS Attribute to the email text and Save
Pre-requisites: N/A
Account Management localization
The following items are now manageable via CMS and hence can be translated to the local language:
The payment gateway setup. Please note that a specific page has to be created for each payment provider (e.g. StripeIframe, SpreedlyIframe etc)
The error message/notification for the unsuccessful payment/invalid payment - a customized page dedicated to every external payment gateway has to be created
Placeholder content for the following Account Management pages can now be created via CMS: Complaint, Address, Feedback, Verify Account, Share Subscription, Phone number, and Cancel Subscription pages:
Placeholder.ZipCode Pages: Address
Placeholder.SelectOption Pages: Activate, Feedback, VerifyAccount, SubscriptionShare, Address and CommonIframe (recently created for bank account iframe) pages
Placeholder.CCName Pages: BraintreeIframe. Please note that a specific page has to be created for each payment provider
Placeholder.SelectReason Pages: StopSaver, SubscriptionCancel and TemporaryStopTransfer
Placeholder.SelectCategory Pages: Preference
Placeholder.SelectIssue Pages:Complaint
Placeholder.EnterAddress Pages: Address and TemporaryStopTransfer
Placeholder.EnterCity Pages: Address and TemporaryStopTransfer
Placeholder.EnterZipCode Pages: Address and TemporaryStopTransfer
Content: There are no Transfers Segment: TemporaryStopTransfer.NoTransfersTe
Content: Enter your email address to create a new password. Segment: ForgotPasswordForm.Description
Pre-requisites: N/A
Subscription Panel localization
The following items are now manageable via CMS and can be translated to the local language:
the error message for the unsuccessful payment/invalid payment; the error generated by the external payment gateway is overridden
Pre-requisites: N/A
Access to Support Viewer via Landing
The user who is authenticated to access the Support Viewer application now can access it via Landing.
Support Viewer being visible on the Home page of the Landing app does not imply that the user has access to the application. If access is needed, it has to be requested from Admin. If the user is not authenticated and tries to access the Support Viewer app, then the Login credentials are deactivated. For the user to be able to access Subscribe applications again the credentials have to be re-activated by the Admin user.
Please note that for now Support Viewer is meant for Naviga support only. More functionality is expected in future releases
Pre-requisites: N/A
Upgrades & enhancements
The following enhancements were introduced to the existing features
Feature
Description
Notes
Complaints when on Vacation
Pre-requisites: NCS circ, all versions
Tested on: NCS Circ 2020-3.0
Initial Auth0 Screen modification for Account Management
When a user wants to subscribe/activate his Digital account, initial authentication is made easy by enabling the Register tab for the users.
If the user already has a digital subscription, then the Login tab would be active by default instead of the Register tab.
Pre-requisites: N/A
Special characters removed from certain parameters
No special characters are supported in the name fields, address 2 fields, or cardholder name fields. All the exceptions are listed below:
First Name: ' - & / .
Last Name: ' - & / .
email: @. + - _ ,
Cardholder Name: ' - & / # .
House number: / -
Unit number: No Special Chars
Pre-requisites: NCS circ, all versions
Tested on: NCS Circ 2020-3.0
Payment Terms for Comp Subscribers
As comp (complimentary) subscriptions are meant to provide free access to the content for the employees and other support staff of a Newspaper publication, events are configured in such a format that for Subscription Kind of ‘Comp’ category, are not fired for payment purpose
Pre-requisites: NCS circ, all versions
Tested on: NCS Circ 2020-3.0
Restart events order rectified
RESTART PAYMENT event meant for Payment activation for stopped subscriptions used to fire before the occurrence of RESTART SUBSCRIPTION event. The wrong order of firing events is rectified
Pre-requisites: Matrix, all versions
Tested on: Matrix 38.0.034.ITSP5
Carrier Collect restriction for Billing method in CMS
Carrier Collect restriction is present in the Hide links for dropdownin the Links section of the Navigation tab
Pre-requisites: N/A
Hardcoded Message about Software Update removed
There used to be a Modal (Message) window for an API with new functionality to notify the user about the new software update. When the system is up and running, the notification serves no purpose so that was removed.
Note: The hardcoded message can be configured from CMS for SWUpdate.Text and SWUpdate.Title segments for Layout (Filter by page drop-down) page. Note updated Oct 4th 2022
Pre-requisites: N/A
Close button added in Solicitor Concierge
A close (x) button is added to the top-right corner of the Offer group
Pre-requisites: N/A
American Express card logo removed
On the payment page in Account Management the Card logos for American Express and related card logos were removed (AmericanCardImages setting set to false. Hiding images setting set to false)
Pre-requisites: N/A
Bug fixes
The following bugs were fixed in this release
Fix
Description
Notes
Encoded Subscriber’s Email not accepted
When the user creates a new subscription through Subscription Panel the PurchaseAPI is being called to process a new subscription start. One of these steps is CreateSubscriber in DTI Circulation System. Purchase API was sending an encoded email and DTI API cannot process the same as special characters are not accepted by DTI Circ which caused an error that has been fixed.
Pre-requisites: NCS circ, all versions
Tested on: NCS Circ 2020-3.0
Invalid Input for a New Subscription
The PurchaseAPI was not sending proper input for Address and no subscription id was created. As for the new subscription, the system has to generate the Subscription Id by default. This type of subscription is said to be a billed one which means no payment details are required as this is for internal staff of the client or publication.
Pre-requisites: Matrix, all versions
Tested on: Matrix 38.0.034.ITSP5
Create Reward returns an unexpected error
An unexpected error was shown when adding a new Reward if there was already at least one Reward. The error message is fixed, a friendly validation message is displayed
Pre-requisites: N/A
Creating a scheduled reward with a start time before the end time
While creating a new reward for a Newspaper client, the Start time later than the End time was acceptable by the system. This behavior is rectified and the system is functioning fine. While creating the reward, if a later date was entered for the start time compared to the end time, the API is giving out an error to notify the user. This is further rectified to give out an appropriate or clear message as “Error! start date can not be greater than or equal to end date”
Pre-requisites: N/A
Error message when a Reward is saved successfully in CMS
While creating the reward, if a later date was entered for start time compared to end time, the API is giving out an error to notify the user. When the error is rectified by entering the correct dates, the Reward details are saved but still, the validation error continues to appear. The only difference it disappears after a few seconds.
Pre-requisites: N/A
The credit card number not encrypted in PurchaseAPI
In Subscriptions API the credit card number is encrypted (does not matter if it is masked) but in Purchase API this functionality was deprecated in 3.16.1 due to being moved to Payments API during its refactor, which is planned for 3.17.0. Still, we need to encrypt the credit card number in the 3.16.X Releases, because otherwise the masked credit card number will not be displayed in the subscription account. In scope of this fix we added credit card number encryption to PurchaseAPI. Note updated Oct 11th 2022
Pre-requisites: N/A
EZPay payment method update resets recurring tip - bug fix
Prior to the fix sometimes when a payment method used for ezpay was updated, the recurring tip was reset. To fix that now TipAmount=null is allowed in case tip amount was not updated during the call. Note updated Oct 11th 2022
Pre-requisites: NCS circ, all versions
Tested on: NCS Circ 2020-3.0
Paypal direct integration change to Auth and Capture - bug fix
Paypal Do Express checkout was failing because the API was performing a Sale transaction (TRXTYPE=S). In scope of this fix we updated integration to have Authorize (TRXTYPE=A) and Delayed Capture (TRXTYPE=D) types of transactionsNote updated Oct 11th 2022
Pre-requisites: N/A
Stop options not being displayed when scheduling a Permanent Stop in One CSR Portal - bug fix
When trying to schedule a Permanent Stop in One CSR Portal an error message “There are no stop options available for this subscription“ was thrown instead of “Schedule cancellation without refund“ and “Schedule cancellation with refund“. To fix that missing dependencies were added to the component constructor. Note updated Oct 11th 2022
Pre-requisites: N/A
The routable check adds Addresses that do not exist in NCS Circ
New starts were blocked by the Routable check when using addresses that do not exist in NCS circ. The routable check flow was reworked to add Addresses that do not exist in NCS. Note updated Oct 11th 2022
Pre-requisites: NCS circ, all versions
Tested on: NCS Circ 2020-3.0
Upgrade/Downgrade not allowed with Temporary stop settings - bug fix was moved to 3.16.2Note updated Oct 11th 2022.
2025.1
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
This release is currently in its Beta version.
Subscribe 2025.1 introduces a key feature of Email verification during New Starts using Auth0. The release also includes some minor enhancements and bug fixes.
Release Prerequisites
Integrations
Minimum Version
ENGAGE
2.8.7.2
NCS Circ
2025.0.0 (If using Variable Pricing)
2020-6.3 (if not using Variable Pricing)
Subscribe Extracts
Australian Clients - Extract Version 6
Other Clients - Extract Version 5
Sync Jobs
2025.1
Circ Pro
2023-2.0
DSI (Saxo Circ)
NOT SUPPORTED
Naviga Pay (if using)
2.2
Key Feature - Auth0 Email Verification
With this new enhancement, all users accessing the Subscription Panel to purchase a new subscription will undergo an email verification process managed by Auth0. This verification acts as a vital step before the payment stage, which can reduce the recent rise in carding attempts.
The process works as below:
New Email Address:
If the end-user enters an email address not found in the database, Auth0 creates a new user profile, verifies the email and the user will be allowed to continue with the subscription purchase.
Existing Email Address:
If the email entered by the end-user already exists in the database, it can be either a verified address or an unverified address:
Verified Email address: The user can proceed with the purchase flow.
Unverified Email address: Auth0 prompts the user to complete the email verification process first, before proceeding to the purchase flow.
This enhanced purchase flow ensures that only verified users proceed to the payment step, improving system security and preventing carding attempts.
This is a configurable feature that is turned off by default. Clients can enable it at the presentation level through the CMS.
General Enhancements
Subscription Panel
1. New GIF loader image
A new provision has been added to the Subscription Panel, allowing clients to load a custom GIF image to display to end users if the SP takes longer to fetch and display offers on the page. Currently, a generic spinner is shown. To make the loading experience more engaging, clients can replace this spinner with a GIF image uploaded via the config file. This helps effectively communicate to users that the application is fetching suitable offers for them.
Refer to the GIF given below for your reference:
Implementation Notes:
The Config file must be placed at the Publication level and should contain the following keys in the below specified structure to ensure the loader GIF is visible to end users.
config.Loader = {
ImageName: "/img/<imagename>.gif",
LoaderText: {
Enabled: true,
Text: "Loading best offers for you..."
}
};
The config.Loader key must include both the ImageName and LoaderText to display the loader image and message.
The loader image must be placed in the /client/img folder of the project structure, following the above-specified naming convention.
The loader text is displayed as plain text. HTML formatting (such as color or font size changes) is not supported. The font size and color of the loader message are fixed by design.
2. New Data Layer Variable for GTM Container
A new data layer variable has been introduced for the internal GTM container in SP. This data layer variable can be included in the GTM.js script call from layout.pug for all clients, based on a configuration key. The client's GTM.js will load with the data layer variable if it is defined in the publication-level config.
Note: Changes have been implemented for all client containers.
Implementation Notes:
Add the key DataLayer inside config.Tracker.GoogleTagManager with any string value that maps to the client's data layer variable name.
The data layer addition now supports multiple container options, each added within individual container arrays.
API
Saving Encrypted Registration IDs up to 150 characters
Registration records can now store encrypted Customer Registration IDs of up to 150 characters in the database when creating new registrations.
Bug Fixes
SubCon Admin
1. Unlinking registration changing user type
When the CSR unlinked the registration of a subscribed user from a stopped subscription, the ‘Owner’ status of another existing active subscription of the user got changed to ‘Guest’, which was not expected. This issue has been resolved now. After the fix, if the subscribed user has multiple subscriptions, unlinking a registration from a subscription does not affect the status of the remaining subscriptions.
2. Title “Search result” missing from the Event Processor Responses page
The issue of the “Search result” title missing from the Event Processor Responses page (Event Management > Event Processor Responses) has been resolved. After the fix, the title now correctly appears above the search result table.
3. Empty drop-down for REDEEMGIFT event
The ‘Events’ drop-down displayed while clicking the ‘Send Sample’ button on the ‘View all emails’ tab (Event Management > Event Types Emails > Filter by (Event Type Id), Contains (1101) > Search > Edit > View all emails > Send sample > Events) was blank. This issue has been resolved. After the fix, the drop-down now correctly lists the event data as expected.
4. Reason for cancellation/Downgrading not displayed in SubCon Admin
When a subscription was canceled or downgraded through the Self-Service portal, the selected cancellation reason was not reflected in SubCon Admin for the corresponding subscription. This issue has been resolved. Now, when a subscription is canceled or downgraded via the Self-Service portal, the reason is correctly displayed in SubCon Admin for the associated subscription.
5. Spinner display on Email Preferences tab
The issue of a persistent loading spinner appearing when accessing the Email Preferences tab has been resolved. After the fix, if no email preferences are set for a particular newspaper, an appropriate message ("There is no data to display") will be shown upon accessing the Email Preferences tab; otherwise, the corresponding email preferences data will be displayed.
6. Tip Amount not considered during Autopay Sign-up
While signing up for Autopay, if the end user included a tip amount, it was not captured or reflected in the EZpay events and NCS records. This issue has been resolved. After the fix, the tip amount paid during Autopay sign up-is correctly captured and reflected in both the EZpay events and NCS records.
Self Service
1. The unresponsive Cancel button
The Cancel button on the “Manage AutoPay” page was unresponsive while editing the current payment method for an active subscription of an NCS client. Clicking the Cancel button did not close the ‘Edit’ section as expected. This issue has now been resolved. After the fix, clicking the Cancel button properly closes the editing section on the “Manage AutoPay” page.
2. Issue with the Cancel button
The Cancel button on the AutoPay Cancelation (/autopay/signout) page was not working. To address this, it has been replaced with a Go to Dashboard button. When users click this button, they are redirected to the Dashboard page, as indicated. See the image below for your reference.
Implementation Notes:
In CMS, the content "RejectCancel.CancelButtonText" is removed for the AutoPaySignOut, and instead, "ButtonGoDashboard" has been added.
3. Issue in Sharing Subscription
When a subscriber sent an invitation to a recipient's email ID for sharing the subscription, the recipient was unable to log in to the Self-Service portal using the email ID (the one on which the invitation was received). An error message was displayed stating that the email was already registered.
The issue was due to a case mismatch between the email IDs stored in Auth0 and the Subscribe database. This issue has now been resolved. After the fix, the Self-Service portal will ignore case differences between email IDs stored in Auth0 and the Subscribe database. As a result, users can log in successfully regardless of case variations in their registered email addresses.
5. Updating Email with an existing Email ID
Previously, end users were able to update the Email ID field with an existing email ID through the /myprofile page of the Self-Service portal. After this fix, the SUBMIT button on the /myprofile page will be enabled only if there is a change in the existing Display Name or Email ID.
6. Missing Options in the Dashboard
When navigated from the Manage Subscriptions (/selectaccount) page to the Dashboard page, some of the hyperlink options were missing. This issue has been resolved.
After the fix, when navigating to the Dashboard, the papercode in the URL updates based on the selected subscription. The Dashboard options are available as per the configurations in the CMS as expected.
7. Incorrect Phone Number Format on Initial Load
When the Subscriber Update (/update) page was accessed for the first time, the Phone number was displayed in an incorrect format. However, upon refreshing the page, the phone number displayed correctly. This issue has now been resolved.
8. Label alignment issue on Dashboard
The misalignment of the frequency of delivery (day names) labels on the SS Dashboard has been resolved.
API
1. Start call in SubCon Admin updating the House-hold level
The logic that updated theHouseHoldLevelIdto the default value set against the ApiKey "DefaultHHSubscriptionLevel" for active subscriptions in the HouseHoldLevelstable during a 'Start call' from One CSR Portal been removed. It is now ensured that theHouseHoldLevelIdis no longer overridden by default values from the database during Start call from SubCon Admin.
2. Not able to access Autopay Signup page and missing ‘Pay now’ button
Accessing the Set up Autopay (autopay/signup) page from the SS Dashboard resulted in an error message stating, “The subscription was unable to be opened as it is in an invalid status.". On the Payment page, the Pay Now button was absent, preventing users from completing payments. These issues have been resolved.
This issue occurred because the selected subscription did not have a Phone number. After the fix, it is now possible for the end user to sign up for Autopay or make payments even if the Phone number is empty or has a value NULL.
3. Duplicate Subscription creation issue in Kiosk (LTE Starts)
It was observed that while purchasing a new subscription using the Kiosk (LTE Starts), end users could navigate back to the previous page and resubmit the purchase request again. This issue was occurring specifically for future subscriptions where the start date is a future date. This resulted in multiple duplicate subscriptions being created. This issue has now been resolved. After the fix, the user will be restricted from creating duplicate subscriptions for future start dates.
Precondition: To invoke Active Sub-check in the backend for new starts, it is recommended to switch on the SolCon flag ‘No Existing Subscription’ (Offer Groups > Additional Options > Subscription Validation) while creating the SolCon offer group.
4. All Offers not returned
The issue where all offers were not being returned in the API response from SolCon for the /Offers API endpoint — regardless of the source system (such as SubCon Site, Subscription Panel, Direct Sales, SubCon Admin, Engage, In-App, or any other external platform) — has been resolved. After the fix, all valid offers configured in SolCon are returned correctly, irrespective of the source system.
SolCon
1. Error while Saving as New
Clicking the "Save As New" button to create an Offer Group from an existing one triggered a UI validation error without displaying an error message. This issue has been resolved.
After the fix, while creating a new Offer Group from an existing one using the "Save As New" button, the Offer Group name field will be cleared, allowing the user to enter a new, unique name for the group. The entered name will also automatically populate the Offer Group Code field under Additional Options by default.
If the user attempts to save the new Offer Group as a Draft or Publish without a name or with an invalid name, both the name and Offer Group Code fields will be highlighted, and focus will be set to these fields. An error message stating “Name is required” will appear below the Offer Group name field. Additionally, another message, “Offer Group Code is required. By default, the application generates this value based on Offer Group Name.” will display below the Offer Group Code field in Additional Options.
2. Issue with Offer Groups Auto-Selection Across Sales Platforms
While creating a new Sales Team, selecting each Sales Platform caused offer groups from previously selected platforms to be added to the current Sales platform. This issue has been fixed. After the fix, when creating a new Sales Team, the offer groups selected for a specific sales platform will not carry over to others.
3. Unable to create Offer when No Rate code available
Previously, while creating a Comp offer in SolCon, if Rate codes were not available from the Circ system, the Reason code field appeared as a blank drop-down list, preventing users from creating the offer. This issue has been resolved. Now, there is no dependency on the Circ system for Rate codes when creating a SolCon Comp offer. If Rate codes are unavailable, the Reason code field becomes a free text field, allowing users to input the appropriate reason and proceed with offer creation without restrictions.
4. Term Length field goes Editable after Publishing an Offer Group
Whenever a Rate Code is selected, the system fetches the associated Term Length data from Circ and displays it in a drop-down. Previously, after publishing the Offer Group, the Term Length drop-down was changing to an input box, giving users the wrong impression that the Term Length could be edited. This issue has now been addressed. After the fix, the Term Length drop-down remains a drop-down even after publishing the Offer Group, preventing users from editing the Term Length.
5. Unable to edit the existing offer
Previously, while adding new payment methods and saving them as a draft to an existing offer, the checkbox selections of already selected payment methods would disappear from the SolCon UI. This issue has been resolved. After the fix, all selected payment methods are displayed correctly when saving the draft.
Subscription Panel
1. Subscriber’s name displayed twice on subscription confirmation page
The issue of subscriber’s name appearing twice on the subscription confirmation (congratulatory) page has been fixed.
Implementation Notes:
Enable the PaymentInformation Show property in the Confirmation component.
2. Subscriber details captured from the Billing address instead of the Delivery address
During new starts, if a subscriber's billing and delivery addresses differed, Subscribe would capture subscriber details, such as first and last names, from the billing address. This issue has been resolved. Now, during a new purchase, if the delivery and billing addresses differ, Once CSR Portal captures and reflects subscriber details from the delivery address as expected.
3. Issue with ApplePay transaction in FullPage Display
When users selected Apple Pay as their payment method during the new start flow with the Presentation's DisplayType set to FullPage, they were unable to place the order for the new start flow. This issue has been resolved.
After the fix, the flow works as below:
Tax Calculation and Reauthorization: If the user's address requires tax calculation, the system prompts the user with a pop-up message requesting them to click the Pay button once more. This reauthorization is necessary as the total payment now includes both the subscription cost and applicable taxes.
Order Completion: After reauthorization, the user is presented with the Order Summary, where the final payment is processed.
These changes ensure a smoother and more reliable payment experience for users selecting Apple Pay in the FullPage display mode.
4. Reauthorization Message issue of ApplePay V3 Component
The Reauthorization message for the ApplePay payment method was not being retrieved from the 'Errors ReAuthorize' property in the ApplePay V3 component within the CMS, as expected. This issue has now been resolved.
5. Display of Processing Fee for Payment Methods other than Credit Card
The Processing Fee is applicable only to the credit card payment method. Previously, when the credit card Processing Fee was enabled for a client in the support viewer and the Processing Fee CMS settings were toggled ON across all Step V3 components, the processing fee was displayed for all payment methods, which was not intended. This issue has now been resolved. After the fix, the Processing Fee will be displayed only for the credit card payment method, and only if it is enabled for the client and toggled ON in the Step V3 components.
Database
Payment method of NCS clients getting captured as Credit card for all New starts
It was observed that the Payment method of new starts for NCS clients was always getting captured as ‘Credit card’ in the Subscribe database regardless of whichever payment method was used, after the nightly sync process. This issue has been resolved. After the fix, the actual payment methods opted by end-users are correctly captured in the Subscribe database after the nightly sync process.
3.13.0 and 3.13+
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
3.13.2
3.13.1.1
3.13.1
3.13.0
3.15.0 and 3.15+
This page contains Release notes for major 3.15.0 Release and minor 3.15+ Releases
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Release 3.15.3.5
Release 3.15.3.4
Subscription panel
This fix was also merged to 3.16.0.7 and 3.15.2.3.
Updated on June 26th, 2023
Release 3.15.3.1
CMS
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
This fix was also merged to 2.39.1, 2.39.1.0, 3.15.2.1, 3.16.0.13, 3.16.1.7, 3.16.2.4, and 3.16.3.
Release 3.15.3
Subscription Panel
Other
Release 3.15.2.4
Release 3.15.2.3
SubCon Site / Account Management
Bug Fixes
This fix was also merged to 3.15.0.4, 3.15.1.5, and 3.15.2.2.
Subscription panel
This fix was also merged to 3.16.0.7 and 3.15.3.4.
Updated on June 26th, 2023
Release 3.15.2.2
SubCon Site
Bug Fixes
This fix was also merged to 3.15.0.4, 3.15.1.5, and 3.15.2.3.
Release 3.15.2.1
CMS
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
This fix was also merged to 2.39.1, 2.39.1.0, 3.15.3.1, 3.16.0.13, 3.16.1.7, 3.16.2.4, and 3.16.3.
Release 3.15.2
Subcon Admin / One CSR Portal
Other
Release 3.15.1.5
SubCon Site
This fix was also merged to 3.15.0.4, 3.15.2.2, and 3.15.2.3.
Release 3.15.1
Subscription Panel
SubCon Admin / One CSR Portal
SubCon Site / Account Management
Solicitor Concierge
Other
Release 3.15.0.4
SubCon Site
This fix was also merged to 3.15.1.5, 3.15.2.2, and 3.15.2.3.
Release 3.15.0
3.14 and 3.14+
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
3.14.3 - Minor enhancements
3.14.2 - Focused on PurchaseAPI
3.14.1 - Focused on Matrix circ system integration
3.14.0 - General enhancements and NCS Circ integration
3.12
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
3.12
3.16.3.x Hotfixes
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Please note that all 3.16.3.x hotfixes are by default included in the next higher release. However, if a Hotfix branch of 3.16.3 is released after the next higher version, the corresponding Hotfix will be merged into the latest sub-version of the higher release applicable at that time.
Please input a Salesforce case if you want the fix to be applied.
API - UsersOrchestrator
The UsersOrchestrator refactor changes have been implemented in this release to achieve performance benefits as early as possible.
The UsersOrchestratorAPI has been developed in order to replace the UserAPI, which will be used for handling workflow orchestration between integration services (such as MG2Auth, Auth0, Gigya, SSOR, and Firefly) and the Subscribe Registration API.
Changes have now been made to various internal services in order to prevent breaking changes so that consumer applications can be switched to utilize UsersOrchestrator without issues.
The following changes have been made to internal services:
For ProxyAPI, the strategy has been changed in order to map the old Query String parameters to the new UsersOrchestrator parameters.
Changes to the response model of UsersOrchestrator.
Changes to the SPROC (Stored Procedure) of Subsvc Api_GetSubscribeRegistrations.
Changes to the response model of SubscribeRegistrations.
The MG2 control flow setting, "Flow.Users.RedirectToOrchestrator," has to be set to 1 for the ProxyAPI redirection to the UsersOrchestratorAPI.
Note: Make sure that the MG2 control flow setting, "Flow.UserProvider,” has been set correctly.
API - Failure of Newstart due to Invalid Email Characters
In the Self-Service Portal, when creating a start with an email address that included the special character "+" (e.g., user+1@domain.com), the new start failed to create with the error message "Child Event: ADDSUBSCRIPTION failed. Error: EbillEmail field contained invalid characters that were removed." Since the special characters in the Query String Parameter had been removed, the FindAddressOccupant method failed to find the occupants with the specified email address and returned the error "No occupant record found."
The special character ‘+’ has now been encoded in the Query String Parameter when communicating between EventsAPI and CircAPI in the FindAddressOccupant method, so that when entering an email address with the special character "+," new starts will now be created and errors will no longer be displayed.
This fix is also merged to 3.16.2.5.
Seamless Flow updated for Credit Card Edgil Payment Method
In the seamless flow, if the Independent Address component for the payment page has been enabled, users could purchase or subscribe to a subscription with a single click after entering their credit card information. The issue occurs when the credit card details have been validated, the Submit button disappears, and the user is taken directly to the payment options, even if the fields, First and Last names, Phone, and Zip Code, have not been filled. This resulted in the AddSubscription call being triggered with incomplete information, and since the Submit iframe button is from a third-party payment site, it does not validate whether the aforementioned fields have been filled, resulting in no error warnings being displayed.
Changes have been made to allow the submission of incomplete fields if the credit card has already been validated in the seamless flow by introducing a delay time after each keystroke while filling the fields under the independent address component.
A key, "SeamlessInputDelayTime", must be added to the SP Config file with any numerical value. The value indicates the delay time in milliseconds, with the default value set at 1500 milliseconds (1.5 seconds).
For example, after entering the first name, it will wait 1.5 seconds and then call AddSubscription if no additional keystrokes have been detected. When the user starts entering the following fields, such as Last name, phone number, and zip code, the timer is reset after each keystroke, and the AddSubscription call is triggered only after a 1.5-second delay.
This fix is also merged to 3.15.2.4, 3.15.3.5, 3.16.0.14, 3.16.1.9, 3.16.2.5.
API - GET /User/Encrypted
The issue with the GET /User/Encrypted endpoint not working has now been resolved.
Areas Covered
API, Subscription Panel, Database
API - Purchase
Previously, Subscribe used the Start Date as the earliest possible date (today) since the next available publish date within CircPro was not accessible. Changes have now been made to integrate the CircPro Law API, getNextPublishDate, with the Newstart flow to add a step to retrieve the Next Publish Date from CircPro before triggering the AddSubscription event. This date will be utilized as the StartDate (EffectiveDate parameter) in the AddSubscription event processing.
Note:
The date returned by the getNextPublishDate event will not be applicable for EZPay, and the StartDate will remain Today.
The MG2 Control Internal Setting, "CircPro.Law.EndpointAddress," has to be set to the correct URL.
Pre-Requisites:
Circ System & Minimum Supported Version: CircPro, 2023-2.0 (will be out in Jan 2024)
API - Purchase - Incorrect mapping of address fields for CircPro clients
Previously, if a user entered only the Billing Address while creating a new subscription in the Subscription Panel, since the Delivery and Billing addresses were the same, the Purchase API incorrectly sent the Billing Address against the mailing address fields instead of the regular address fields in the updateDataWithMailingAddress endpoint in CircPro.
This issue has been resolved, and the address fields will now be sent to CircPro as mentioned below:
When creating a new start with only a single address (delivery or billing), the address entered will be sent to the regular address fields in the CircPro application.
And if creating a new start with different addresses in the delivery and billing address fields, the delivery address will be sent to the regular address fields and the billing address to the mailing address fields in CircPro.
Landing - Client details not getting saved
While creating a user from the Landing application, client details were not getting saved. This issue was specifically observed when the Role type of the created user was Generic. This issue has been resolved now.
Areas Covered
API, Landing application
User data getting wiped out from Auth0
All the user metadata stored in the client’s Auth0 dashboard was being wiped out when the user executed a change password via myaccount/myprofile page or a CSR changed a password via Subcon Admin. This issue has been resolved now.
Self-Service - Error while changing password on myprofile page
The user was not able to change password successfully on myprofile page of Self-Service portal. The user was receiving an error message stating, ‘Could not update user’. This issue has been fixed.
Areas Covered
Self-Service, One CSR Portal
SL - Add ExternalSalesPlatform as a Sales platform
A new generic Sales Platform called ‘ExternalSalesPlatform’ has been introduced in SolCon starting from this release to manage external integrations from clients. An Offer Group can be configured now with ExternalSalesPlatform as its Sales platform. Clients can further use these offers in their external integrations for the purchase subscription flow.
Note: Offers with ExternalSalesPlatform will be returned in get/Offers response to consumer applications when the source system does not match the Sales Platform in SolCon & OfferId or OfferGroup Id are not part of the API request.
Unable to purchase offers from an external system
The user was restricted from purchasing a subscription through an external system, encountering an error notification saying “The offer does not exist or it is not available." This issue was specifically observed in clients who were upgraded to version 3.16.3. Importantly, this error did not occur in prior versions and has been resolved now.
Following the fix, a user can now purchase offers through any external system if the corresponding offer is configured with the 'ExternalSalesPlatform' option in SolCon.
The ExternalSalesPlatform can be updated against required Offers via scripts. In this case, the TnC mapped to Subcon Admin Sales Platform will be updated against ExternalSalesPlatform. Clients also have an option to update the ExternalSalesPlatform manually from UI with desired TnC.
Delayed Login in Self-Service for Publications using SSOR Authentication
The issue of publications using SSOR authentication taking too long to load SubCon Sites has been resolved. This delay was primarily because of an additional API call triggered by an internal cookie with an empty value. With the issue resolved, it is now possible to log in to the My Account pages of publications using SSOR authentication without any delays.
This fix is also merged to 3.16.1.3 & 3.16.2.5.
Areas Covered
Self-Service, SolCon
SP - Payment Completion Errors
The user received an error message stating 'The entered payment information was not accepted' when attempting to complete a payment from the Subscription Panel. This issue has been resolved now. The root cause of the issue was missing billing information provided to the payment gateway. The issue was resolved once that information was provided.
Implementation Notes:
A new Api setting key has been added, ‘CyberSource.DefaultCurrencyCode’ with USD as default value (Mediagroup Null, Clientcode Null, PaperCode Null). ->This setting will be used as a fallback if no CurrencyCode is being sent from the consumer application to the API.
The Api setting key ‘UpdateProfileForThridPartyPurchase’ should have the value 0. (For CyberSource integration there is no need to update the payment profile as part of the purchase flow. With this setting, profile update step can be skipped.)
SP - User unable to redeem Coupon Codes
The issues with redeeming Coupon Codes (One-time and Multi-use) in the Subscription Panel have now been resolved.
Implementation Notes:
The "Require Code for Access" checkbox should be unchecked in versions higher than 3.16.3.
This fix is also merged to 3.16.2.6 and 3.17.0.
SL - Terms & Conditions under Exception not displayed
The Terms & Conditions content added under Exception (SolCon > Offer Group > Terms & Conditions > Exception) for publications was not displayed correctly wherever the offer was displayed through consumer applications (Subscription Panel and SubCon Site). Instead of the Exception Terms & Conditions content, the original Terms & Conditions content appeared on the client pages. This issue has been resolved now.
This fix is also merged to 3.16.2.6.
Application Covered:
Subscription Panel, SolCon
Attention: Enhancements
InApp Subscriptions
The Newstart InApp flow has been modified to allow new Subscriptions created on external consumer applications to send a StartDate in the past. Validation checks have been implemented so that the InApp newstart flow will accept past dates but not null values.
Implementation Notes:
For each client, the MG2 Control flow setting, "Flow.Purchase.InApp.Redirect," must be set to "0" in order to process any InApp purchases.
Previously, when creating InApp purchases, only FirstName and LastName were included in the input model as part of the GoogleInfo object.
Since not all external consumer apps provide these two fields, changes have been made to include the Subscriber object in the input model, exactly as the regular Newstarts in Purchase API does.
The Subscriber object will include the following fields:
FirstName
LastName
Email
Title
CompanyName
CompanyType
Country
Phone
For InApp subscriptions, the "AutoRenewing" property of the external market receipt (Google, AppleV1, or AppleV2) will now be used to populate the EZPayFlag column when creating a subscription record.
Note: Regardless of the EZPay value that is defined at the Offer level in SolCon, the EZPayFlag value for InApp will be completely based on the external market receipt.
SubCon Admin - New endpoint to fetch Subscription status
A new endpoint, Subscriptions/{SubscriptionId}, has been introduced in this release to fetch subscription statuses. Previously, the status was retrieved through the microAPI endpoint -subscriptionLive/{SubscriptionId}, which could only return statuses for subscriptions in circulation systems and would return a blank status for inApp/SwG subscriptions without circulation system dependencies.
The new endpoint, Subscriptions/{SubscriptionId}, retrieves the status from the circulation system or, when applicable, from Subscribe DB. This ensures that, during a Subscription search Start call, the Subscription Status is consistently returned and displayed in SubCon Admin, even for subscriptions not part of any Circ System and only available in Subscribe DB.
The field 'Subscriber status value' in the Account information tab of SubCon Admin will now derive its value from the "Subscriptions/{SubscriptionId}" microAPI after clicking Start call on the Subscription search screen.
SL - Removing dependency from Subsvc tables while creating/fetching SwG Offers
Creating new offers with the payment method 'Subscribe with Google,' (offers with a product do not present in the Subsvc Google tables) used to result in validation errors. To streamline the process and remove the overhead, the dependency on Subsvc tables during the creation or retrieval of Subscribe with Google (SwG) offers has been removed, as these tables are not utilized elsewhere in the current workflow.
Users can now create new SwG Offers without relying on SubCon Google tables (GooglePublication, GoogleProduct, and Product_GoogleProduct) in Subsvc. The SwG carousel shows these offers and end-users can successfully purchase the subscription.
Note: If an offer has been published and additional divisions have been added later, the SKU for the newly added divisions will not be saved. As a result, before publishing an offer, please make sure that all of the required divisions have been added.
Subscription Panel - Implemented MPANs for ApplePay Payway Integration
Payway now supports secure tokenization of Merchant Tokens (MPAN—Merchant Pay Account Number) for Apple Pay transactions. Since Device Tokens (DPAN—Device Personal Account Number) are associated with the user's device, when the subscriber upgrades their Apple device, the DPAN changes, and the existing EZPAY tokens registered to the old device become invalid, resulting in the failure of renewals. MPANs offer a solution to the issue with the DPANs. Since tokens are associated with the merchant rather than the device, subscriber device upgrades do not affect the validity of the tokens, and renewals can be processed successfully.
Changes have now been made to the Subscription Panel so that when purchasing a subscription through ApplePay Payway, the request to ApplePay will now be submitted as Merchant Tokens (MPAN) instead of Device Tokens (DPAN).
The PurchaseAPI has been modified to support the usage of Apple Pay Merchant Tokens (MPAN) in addition to Device Tokens (DPAN).
Note: Currently, the MPAN identifier is not sent to circulation systems. The transaction will work as MPAN but won’t be identified as one. This feature will be made available in a future release.
Pre-requisites:
To utilize MPAN transactions with Apple Pay, make sure that the system meets the following requirements:
macOS: Version 13 or above is required.
iPadOS: Version 16 or above is required.
iOS: Version 16 or above is required.
Implementation Notes:
The following key can be configured if a client prefers for ApplePay to display a localized billing agreement and a description of the recurring payment on the payment page before the user approves the payment. If the value has not been defined for the key, it will consider the specified default value.
A new "Constants" key has been added under the "ApplePay" key in the SP config file for implementing the MPAN.
config.ThirdPartySystems -> ApplePay -> Constants
Under this key, customers can set the values for the two string key objects based on their requirements. The keys are as follows:
PaymentDescription: 'String value'
A description of the recurring payment that Apple Pay displays in the payment sheet.
Default value: "Billing Message"
BillingAgreement: 'String value'
A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment.
Default value: "Billing Agreement"
Self-Service - Auth0 changes to bypass Intelligent Tracking Prevention on Safari
Recent versions of the Safari browser introduced a new feature called Intelligent Tracking Prevention (ITP). ITP is designed to prevent websites from tracking user activity across multiple websites. By default, ITP is active or enabled on the Safari browser. These advancements in user privacy controls of browser adversely impact the user experience by preventing access to third-party cookies. Following this update, the Mac users on Safari browser were experiencing issues while logging into the self-service portal. Auth0 integration was not working on Safari browsers when Intelligent Tracking Prevention was enabled.
To overcome this issue, starting from this release, the Self-Service portal has successfully upgraded the Auth0 SDK from 1.8.0 to 2.1.3. Changes have been made in SS to accommodate Auth0 2.1.3 SDK.
After the enhancement users now have a smooth login process ensuring a better user experience even if the Intelligent Tracking Prevention is enabled on their Safari browsers of Mac systems.
This fix is also merged to 3.16.2.6.
Bug Fixes
SubCon Admin - Failure to display Subscriber Status
When searching for an account number in the SubCon Admin, the Subscriber Status was not displayed, and a Subscribe API error message "Get subscription's information failed" was returned. This occurred because the Get Subscription Live API received the expiration date information from the Circ system in the dd/mm/yyyy format, when the Subscribe expected the format to be mm/dd/yyyy.
This issue has been resolved, and the date format used while parsing the expiration date returned in the Get Subscription Live endpoint will now be determined by the value defined in the MG2 Control API Internal Setting InputMonolithDateFormat.
Note: For versions 3.17.0 and above, the date format will be taken from the MG2 Control API Internal Setting DTI.Monolith.InputDateFormat.
SubCon Admin - Getting Subscriber status as 'In Grace Period'
When the CSR user clicked on the Start call button, the Subscriber status brought by getsubscriptionbyid micro-API was In Grace Period instead of In Grace. When the same action was repeated once more after closing the screen, the response was updated correctly in the 'Subscriber status' field. This behavior has been corrected now. After the resolution, if a subscription is Active in Subsvc, but in Grace period in NCS circulation system, the micro-API now correctly returns "In Grace" instead of "In Grace Period" as Subscriber status.
SubCon Admin - Incorrect subscription start date for the Google subscription purchased from Engage
When a subscription was purchased through SwG, the Start Date displayed in SubCon Admin (Subscription search > Start call > Account information tab > Subscription start date) did not match the Start Date in the database. This issue has now been resolved.
InApp Subscriptions
The issue with the scheduled tasks failing to run to either retry the notifications or change the subscription status, even though set up to run every day for InApp, has now been resolved.
Task Client and Hangfire server schedules, as well as process tasks, will now be filtered according to the queue name. In addition, automatic startup and processing of tasks have been implemented on the Hangfire server in the OnPremise API.
Payment Gateway
The issue with the Cybersource gateway rejecting payment authorization attempts due to ApplePay integration not sending CountryCode to CyberSource has now been resolved.
Self-Service - Newstart Error
When creating a new start for an Australian address in the Self-Service Portal, the addSubscription failed with the error message "Child Event: PAYMENTNEWSTART failed." No value was given for the mandatory field, TranDate." This occurred because the date format sent to the Circ system was in American (mm/dd/yyyy) instead of Australian (dd/mm/yyyy).
This issue has been resolved, and the date format for the TranDate will now be determined by the value set in the MG2 Control API Internal Setting InputMonolithDateFormat for versions up to 3.16.3. For Australian addresses, the value of the InputMonolithDateFormat should be set to dd'/'MM'/'yyyy.
Note: For versions 3.17.0 and above, the date format for the TranDate will be taken from the MG2 Control API Internal Setting DTI.Monolith.InputDateFormat.
Affected Endpoints:
POST Payments/CircAPI
POST Billing/{subscriptionId}
POST DeliverySchedules
Self Service - Issues in Autopay Sign up
On the Autopay signup page, when attempting to sign up for the Autopay payment option, the ‘Complete EZ-Pay Sign Up+’ button remained disabled even after entering the credit card details. Consequently, users were unable to proceed with the Autopay sign-up process. Additionally, the Amount field displayed a message stating, “There are not autopay options”. This issue has now been resolved.
Self-Service - Myaccount shows data of logged out user
When a logged-in user navigated to the Myaccount page in the Self-Service portal, they were unable to see their own account information. Instead, the Myaccount page displayed information from the previous logged-out user. This issue has been resolved now.
This fix is also merged to 3.16.2.6.
Self-Service - Unable to maintain login state from .com to MyAccount when redirected
Post client upgrade to version 3.16.2.4, the logged-in user from .com site was unable to navigate to the Myaccount page in Self-Service portal in the logged-in state. The user could only login at the self-service portal when the value of cookies/cache was cleared. This critical issue has been resolved now.
This fix is also merged to 3.16.2.6.
Self-Service - Error in Autopay manage
The user was displayed with error messages when trying to make payments with a credit card for Autopay manage after entering the payment info and clicking on the Save button. This issue has been resolved now. After the fix, the user is now able to complete payment flows successfully without encountering any error messages.
Self-Service - Address change error
The user was receiving an error message stating “Address Second Pass” while changing the address from SubCon Site. This issue has been fixed now.
Self Service -Error while updating address
While updating the address from the SubCon Site, users were encountering an error message stating, “Failed to get external address id.” This issue has been resolved.
After the fix, the user now receives the validation message, “Address has been successfully changed”. The pending address moves are also displayed under Scheduled Moves section correctly.
SL - Ratecodes not being stored after selection
Previously, certain predefined Rate codes in SolCon were not being stored or displayed in the corresponding field after selection from the drop-down. This issue caused the drop-down field to go blank, specifically for rate codes that contained special characters. Following the fix, users can now successfully select Rate codes and display them in the field, enabling their use in offers.
SL - Issues with action buttons when editing T&C of Exceptions
When editing an Offer group, if the new Terms & Conditions content was added under Exceptions (SolCon > Offer Group > Terms & Conditions > Exception) after unlinking the original Terms & Conditions, then the ‘Cancel’ and ‘Save As New’ buttons were not working. This issue has been resolved.
SL - Passing Incorrect Paper Code
The issue of incorrect paper code being passed to the circulation system for a Publication has been resolved. This issue was particularly observed when there was a mismatch in the values of NS_Paper_Code and paper_code of a publication.
Webhooks: Notification Processing Failure
When trying to reprocess a SUBSCRIPTION_PURCHASED notification in the Self-Service Portal, the issue that caused the Webhook API (POST /Notifications/{id}/Retry) to fail has now been resolved.
Webhooks: Subscription Status and Date Stopped not updated correctly
The issue with the delayed synchronization of subscription status between SubCon Admin and Google Play Console has been resolved. Now, when a user refunds a Google subscription (via Google Play Console >> Order management), the Subscription_Revoked notification triggers in the SubCon DB on the same day, updating the subscription status to 'Stopped' in SubCon Admin immediately. The DateStop is correctly set to the refund date, ensuring accurate reflection of the refund status and stopped date in both SubCon Admin and Google.
API - AddSubscription Failure for ZIP-only Starts for CircPro Clients
The issue with ZIP-only subscriptions for CircPro clients not working correctly in the Subscription Panel has been resolved.
Applications Covered:
API
Bug Fixes
SolCon - Issue in adding images to the new Marketing Text Inventory
The issue where users were unable to add images in the new Marketing Text Inventory element (Inventory > Marketing Text > + (Add New) during creation) has been resolved.
Application Covered:
SolCon
Attention: Enhancement
SS - Supporting Classic and New Universal Auth0 login
The Identity provider Auth0 has introduced a new Universal login experience for its clients. Starting from this version, Subscribe supports both Classic and new Universal login of Auth0 through the Self-Service portal. However, there will be no visual changes for the user.
This enhancement is also merged to 3.16.2.7.
Bug Fixes
SS - Recurring Tip checkbox unavailable
Previously, the recurring tip checkbox was unavailable on the 'Add a Tip' page (/autopay/addtip) of the Self-Service portal. This issue has been resolved. Following the fix, the checkbox will be visible below the payment field on the 'Add a Tip' page based on the internal configuration setting.
SP - User Session Issue
The user session in the Subscription Panel was getting lost for a specific client. The issue was identified as related to a third-party JS library integration and now it has been fixed.
Note: This issue does not apply to all the clients but only to specific ones using the third-party JS Library.
Applications Covered:
SubCon Site, Subscription Panel
Attention: Enhancements
API - Removal of ExpireDate Check
Starting from this release, the validation that prevents InGrace users with ExpireDate in the past from canceling their subscriptions has been removed. The subscribers will be able to cancel their subscriptions even if their subscriptions are in a grace period regardless of the expiration date being past/future. Cancelling a subscription will not have any dependency on the expiration date.
CMS - Title property of 'ApplePay Braintree V3’ component
The Title property of the 'ApplePay Braintree V3’ component has been changed from 'HTML type' to ‘text type'.
This fix is also merged to the 3.17.0.1 release.
SS - Upgrading Braintree SDK
The Braintree-web library and other Braintree scripts have been upgraded from version 3.62.0 to the latest version, 3.100.0. There was a known issue in the Braintree SDK where the Cardholder Name field appeared as a numeric field on iPhones. This issue has been resolved in the newer versions of Braintree. The SDK upgrade has successfully addressed this issue in SubCon Site.
Bug Fix
SS - Unable to cancel subscription
The 'Cancel subscription' button was disabled and unclickable for users on the Stopsaver page, preventing them from canceling their subscription and completing the flow. This issue has been resolved. Following the fix, the 'Cancel Subscription' button is now accessible on the Stopsaver page and it is functional.
Bug Fix
SS - Account linking issue in the Gift redemption workflow
After redeeming a gift, when an existing user clicked on the 'Sign in' button and entered the previously used credentials, they were prompted to verify the account in order to sign in to the SubCon Site. This issue has now been resolved.
Updated on 17 Sep 2024.
Removal of Special Characters Encoding
The encoding of special characters has been removed due to issues arising when the rate code length exceeds 20 characters in the circulation system after encoding.
Bug Fix
Error message when subscribing via ApplePay Braintree
The transaction failed when a user attempted to purchase a subscription using ApplePay via Braintree, and an error message was displayed. This issue has now been resolved. After the fix, users can successfully complete their subscription transactions through the Subscription Panel using ApplePay via Braintree, without encountering any error messages.
Application Covered:
API
Attention: Refactor
1. SL Refactor
Updating an existing Sales Team with a large data set (such as adding many offer groups and/or team members) was causing time-out errors. The Sales Teams update functionality has been refactored to address this issue for performance enhancement.
There are no functional changes. It is now possible to successfully update large numbers of offer groups or sales team members within existing Sales Teams without encountering time-out errors. After the refactoring, the performance has significantly improved while updating the sales team.
This fix is also merged into 3.17.0.2, 3.17.1 & 3.17.2 releases.
2. Enhanced Sign-In Mechanism of Landing Application
Recently, major browsers have introduced additional security measures and constraints related to third-party cookies, as well as cross-domain data transfer and communication. The latest release of Chrome no longer supports third-party cookies. These were impacting the functioning of the Landing application and user experience negatively. Despite the implementation of workarounds, users were encountering issues in the sign-in flow at times.
Therefore, starting with this release, the sign-in logic for the Landing application has been revised without significantly affecting the existing functionality and behavior. The previous dependency on local storage has been replaced, and a Redis caching approach is now implemented for the users to sign in on the Landing application for accessing consumer applications (SubCon Admin, SolCon & CMS).
Following the new implementation, users can access any consumer application only through the Landing application.
If a user has opened different consumer applications on different tabs in a browser, logging out from one application will force the user to log out from the other opened applications as well. The user will regain access to the application only by signing in through the Landing application.
Page refresh will work as before and have no impact following the redesign.
Multi-Factor Authentication (MFA) with Okta will also work as intended if the feature is turned ON for the specific client.
There is no dependency on third-party cookies related to the Landing application, and the landing works perfectly fine on Safari, Firefox, Chrome, and Edge browsers.
Consumer applications are no longer dependent on Local storage to fetch data.
The CMS Idle Time functionality, which notifies the user if they have been inactive on a CMS page for an extended duration and provides the option to either continue or exit from the page, is working as before.
For a seamless user experience and as a best practice, please do not disable cookies in your browser.
This fix is also merged to 3.16.0.15, 3.16.1.10, 3.16.2.8, & 3.17.0.3 releases.
Bug Fixes
1. Issue with In-App Subscription Purchase
This intermittent issue was specific to Apple's in-app purchase. When users purchased subscriptions through the Apple app (V1) via in-app purchase, the corresponding transaction was not reflected in the Subscribe database, and the user was unable to access the website. The issue occurred because Apple was intermittently sending receipt tokens larger than the int32 data type could handle. This has now been resolved. After the fix, Apple V1 in-app purchases are correctly updated in the Subscribe database, and users can access the website without issues.
2. Removal of Special Characters Encoding
The encoding of special characters has been removed due to issues arising when the rate code length exceeds 20 characters in the circulation system after encoding.
This fix is also merged into the release 3.17.0.2.
Applications Covered:
API, SolCon
Attention - Enhancement
1. Merchant Password in the P12 file for Cybersource
Following an urgent update regarding the P12 merchant file for Cybersource keys, Subscribe will now send Password, Filename, and Merchant ID to ensure successful payment transactions with the Cybersource payment gateway. Previously, only the Merchant ID was included in the Cybersource request.
Note that the Merchant ID and Filename values remain the same in the Cybersource request.
Implementation Notes:
A new Api setting key CyberSource.Password has been introduced to get the Cybersource password from MG2 database.
This fix is also merged to 3.17.0.3 release.
Bug Fix
Subscription failure while using Amex Credit card with Apple Pay
When a user tried to pay the subscription amount via Apple Pay with American Express credit card, the transaction failed. This issue has been resolved. After the fix, user can successfully purchase a subscription with American Express credit card via Apple Pay.
This fix is also merged to 3.17.0.4 release.
Application Covered:
API
InApp subscribers not getting website access
Users who successfully purchased subscriptions via In-App Apple Pay and were created in Subscribe did not gain access to the website. This issue was due to the large download_id sent by Apple Pay, which led to incomplete user details being recorded in Subscribe and thus preventing website access.
This issue has been resolved. After the fix, the details of successful In-app Apple Pay subscriptions are now updated correctly in Subscribe, ensuring that subscribers gain valid access to websites as per their subscriptions.
This fix is also merged intothe 3.17.0.4 and 3.17.1.1 releases.
Application Covered:
API
3.16.3 Minor Release
The document contains the major new features and changes in the minor 3.16.3 release. It also documents known problems and workarounds, if any.
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
With the 3.16.3 release, Naviga now supports multi-factor authentication (MFA) to improve login security for users connecting to the Subscribe application. It also introduces Zip Code validation for Digital Subscriptions, MOTO transactions for Stripe in the One-CSR Portal and Subscription Panel to bypass the 3D secure authentication, as well as program changes to Bulk Registrations Import.
This release also comprises a variety of enhancements to the SubCon Site (Self-service), One-CSR Portal, Solicitor Concierge (SolCon), CMS Content, and Subscription Panel modules and introduces a set of new APIs.
Additionally, this release also contains important bug fixes in various modules of the application.
Please note that in the process of implementation, the sync job has to be updated to 3.16.2.
Discover loads must be updated to consider Registrations Metadata (Company Name, Job Title, etc.) in scope.
Note: The regional date format support for Australian clients has been introduced in the OI database. Changes have been made to the Subscribe OI Database to accommodate the dd/mm/yyyy date format in extracts from AUS region clients. However, the Subscribe will store data exclusively in the mm/dd/yyyy format.
Note added on Sep 18th, 2023.
Implementation Prerequisite - .NET Framework version 6.0 is required to support the new micro APIs introduced in this version.
Key Features
Single Sign-On with Multi-Factor Authentication
Implemented Single Sign-On (SSO) with Multi-Factor Authentication (MFA), leveraging Auth0 IdP integration. It is now possible to implement SSO and enforce MFA using any IdP that supports MFA and standard SSO protocols.
To utilize this feature, the client should have an IdP solution supporting standard SSO protocols. Auth0 can be provided by either Naviga or the client.
Prerequisites:
For a client user to be able to access the Subscribe application via SSO with MFA support, the client user must be authorized to access the Subscription application via IdP, and MFA should be enforced.
Currently Auth0 supports IdPs such as SAML, OpenID Connect, Okta Workforce, Google Workspace, Microsoft Azure AD, ADFS, Active Directory/LDAP, and Ping Federate.
If the client has their own Auth0 license, they can perform the setup themselves. Naviga can assist with the setup if required. Clients are required to provide Naviga with the ClientId, ClientSecret and the Domain.
For clients without an Auth0 license, Naviga can provide a license. To inquire about the cost, please contact your Sales Representative.
Application Functionality:
The SSO feature can be enabled for a client based on the value of the Support Viewer Api setting (MG2Control) "Auth0.Subs.IsActive". For handling Auth0 configuration, three more Support Viewer Api settings are created:
Auth0.Subs.ClientId
Auth0.Subs.ClientSecret
Auth0.Subs.Domain
If the setting value of Auth0.Subs.IsActive is 0 then the default Subscribe login page with fields Username, Password, and Sign in button will be available for the user. If the setting value is 1, then the user will be displayed the Auth0 SSO login page with a single button “Sign in With SSO”. The default fields will be hidden in this case.
Clicking on “Sign in With SSO” will navigate user to the Auth0 page of the client based on the values of Domain & Client Id parameters stored within corresponding Support Viewer Api settings against the client.
Based on the entered email address, the user will be redirected to the respective IdP page (for example, Okta page) where the email id and password are to be entered.
Once these credentials are authenticated successfully, Auth0 will check the Subscribe access level for the entered email id. Based on the access defined in Subscribe, the user will be given access to the Landing Page and appropriate options of Subscribe.
If Subscribe application does not have any active user against the entered email id, the access will not be provided regardless of IdP Authentication success.
Finally, when a user logs out from any Subscribe application (One-CSR Portal, SolCon, or CMS) the user will also be logged out from Auth0. Hence, after clicking the logout button if a user re-opens the Subscribe application, user credentials for client IdP and MFA (if enforced) may need to be re-entered. This depends on the IdP session on the user side and the client MFA configuration. The client may choose to enforce MFA for each login or not enforce at all.
Note: When the SSO feature is activated, the password settings section becomes unnecessary for the client. Consequently, if the MFA feature is enabled, the 'Settings' button will be hidden on the Subscribe Landing page for the client. (Please refer to the image above for a glimpse of the Landing page and the Settings button.)
Zip Code validation for Digital subscriptions
To comply the legal restrictions for certain clients who can sell only within a specific region, zip code validation for digital offers would be effective from this release.
Zip code validation for digital subscriptions is configurable in Subscription Panel with the help of the configurable flag “isValidateDigitalOfferZipcode” in SP Config file.
If the flag value is set to true, the zip code entered will be validated from SolCon Available areas for digital offers. The user will be able to purchase the subscription only if the zip code is available in the SolCon Available areas.
If the flag value is set to false or null, the zip code validation will be omitted.
By default, the flag value is set to false for not impacting the current behavior of the clients. The value of the flag does not impact print offers.
Get Offers API is modified to read “isValidateDigitalOfferZipcode” flag for digital offers.
Note: Digital offers usually don't require Available Areas set up in SolCon. However, to avail of this feature, it is requested that clients must add valid zip codes in SolCon Available Areas and apply those Available Areas on Digital offers. At least one valid Available Area needs to be attached to the billing/sales product for this functionality to work.
MOTO Transactions for Stripe
From this release, a new enhancement specific to Stripe Payment vendor has been implemented. The Mail Order Telephone Order (MOTO) transaction flow has been introduced in the One-CSR Portal and Subscription Panel to enable the users to proceed with the credit card transaction without the requirement for 3D Secure (3DS) authentication.
With this enhancement, users can now complete payments with both 3D and non-3D stripe cards without receiving the 3DS pop-up window for authentication. Instead, they are taken directly to the Payment Summary page. Consequently, even cards that typically require 3DS confirmation will function without the need for it.
Enable or Disable MOTO Transaction Flow
The CreditCardStripeV3 component now has a new property, MOTOTransactionValidation, which can be toggled to enable or disable the MOTO transaction flow.
The users can configure the properties by going to:
CMS > Subscription Panel > Presentation (Choose a valid presentation) > Page V3 > Step V3 > PaymentMethodsV3 > CreditCardStripeV3 > MOTOTransactionValidation
In the Subscription Panel,
If the MOTOTransactionValidation property is enabled (turned ON), the 3DS authentication pop-up for the Stripe payment method will not be displayed on the payment page.
If the MOTOTransactionValidation property is disabled (turned OFF), the 3DS authentication pop-up on the payment page for the Stripe payment method will be displayed.
Bulk Registrations Import
Subscription Search > Start Call > Digital > Registrations > Invite OR Invite Without Registration > Import from CSV
The Bulk Registrations Import functionality in One-CSR Portal is revamped such that it is much easier to Add/Append, Modify or Overwrite registration records in bulk while importing the records from an uploaded file. When a user clicks the Import from CSV button, the Bulk Import Window provides a new option 'Choose an action' with radio button options Append, Modify, and Overwrite. By default, the Append action is selected, but the user can re-select the desired option.
The Bulk Registrations Import feature was initially limited to Lite Subscriptions, but starting from this release, this is available for all subscriptions, regardless of the subscription kind. This feature can be configured from MG2 Control.
Modify Action:
With this option, a user can modify the existing registration data and pending invites. Records in the Invitation/Registration table with existing email IDs will be modified according to the uploaded file, with the exception that the User Type field cannot be modified if the data is already part of the Registration Table. User Type can only be modified when the data is in a Pending Invite state. Only existing records based on email matching will be modified; no new records will be added or deleted based on the uploaded file. Once the data is displayed in the grid, instead of the "Send Invites" button, a "Save Changes" button will be available to modify the data without sending any email invitations.
Overwrite Action:
When the user selects the Overwrite action while uploading a file, the records in the uploaded file will completely replace the existing registrations in the database. As a result, any record that exists in the system but not in the new file will be deleted from the system. Any record that exists both in the system and the new file will be stored with updated information from the upload file. Additionally, any record that doesn't exist in the system but is present in the file will be added to the system.
Instead of the "Send Invites" button, the button text would be "Update & Send Invites". An alert message will also be displayed for this action: “This action will overwrite existing registrations with new data and cannot be UNDONE. The User type cannot be updated for existing records once the invitation is accepted.”
Note:
During the Append process, the limit for uploading CSV data is determined by either the Pending Invites Limit or a maximum of 1000 records (whichever is lower). During Modify or Overwite actions, the user is allowed to upload not more than 350 records or the Maximum Subscription Limit (whichever is lower). If the number of records in the uploaded file exceeds the set limit, an error message will be displayed.
The format of the uploading file depends on the value of the SV key (MG2Control) “RegistrationAdditionalData”. If the key value is 0, the template will have only the default fields (Email, First name, Last name and User Type) and if the key value is 1, the template file will have extra fields (Company name, Position, Address, Postal Code, City, and Country) along with the default fields.
General Enhancements
SubCon Site (Self-Service)
Live Chat in SubCon Site
The client specific script for LiveChat implementation has been added to SubconSite. This can enable a live chat facility on the Self-Service portal that allows users to communicate in real-time. This helps users to receive immediate assistance and resolve any issues they may encounter while using the site. This feature enhances the user experience by providing a quick and convenient means of communication.
Note: To enable the LiveChat feature, Clients need to provide the LiveChat script that Naviga can add to the Subcon Site.
Additional Subscription Information in Subscription Management
Within the Self-Service portal, when a subscriber logs in and refers the list of subscriptions to manage, the ‘Show more’ link will now provide additional information such as Subscription Status (Active, Stopped, etc.), Access Type (Owner or Guest) along with Ezpay status and Address information.
Section updated on Sep 19th, 2023.
Subscription Kind details in Dashboard
With the latest release, users can now view their subscription kind (Trial, Complimentary, Standard, etc.) on the SubCon site Dashboard, along with the previously available information on their subscription status, base product, and delivery frequency.
Navbar links alignment on small screens
From this release, even if the size of the browser window is reduced, the navbar links will be centered both vertically and horizontally instead of being aligned to the top left corner. They will be aligned with the logo as well.
Management of Editable addresses
The Address page now dynamically loads the available editable addresses for the current subscription by calling the Availability endpoint. The visibility of addresses in the accordion is managed based on the response from the endpoint. All the existing visibility management logic is removed to ensure the business logic resides on the API side.
If the Availability endpoint indicates that no addresses can be edited, the user is redirected to the Dashboard page with an error message.
Easily manageable date-pickers
The display of date pickers on calendars of SubCon Site pages (Subscription Cancel, Update and Restart pages) has been made consistent. A new function "Get Available Dates" is introduced in the Common Subscription Workflow. This function is responsible for determining the minimum date to display in the calendar and calculates the maximum date based on an offset parameter.
Improved Visual appeal of CTA buttons in Stop Saver flow
The visual representation of the ‘Downgrade Subscription' button has been improved. When disabled, it will now feature a grey background with white font color. When enabled, it will utilize the primary color as the background with white font color. Updated the presentation of the "I'd like to cancel/upgrade/downgrade" links by converting them into buttons. Standardized the appearance of the "Back" button and the "I’d like to Cancel" button, both of which will now have a grey background. Ensured consistency by applying the same font to all button texts.
Restart date in the Confirmation UI
Added functionality to display the restart date in the Confirmation UI for subscription restarts. Now, when users restart their subscriptions, the Confirmation UI will include the specified restart date along with other relevant information ensuring a comprehensive confirmation experience.
Cardholder name a hosted field for Braintree clients
Enhanced integration with Braintree payment gateway to improve security and compliance. The cardholder name is now available as a hosted field (a part of Braintree iframe) in the user interface of SubCon Site.
Subscription Restart functionality for Matrix clients
A new Restart page has been made available for Matrix clients from this release. The user would be able to pay for the new rate for the subscription and the balance amount, if any. Highlights of this enhancement are as follows:
The user need not select any payment option and the restart date.
If the account has a subscription balance to be paid, a new field ‘Debt’ will be displayed to the user and the user will have to pay a total amount of new rate of the subscription + the debt amount.
Likewise, if the account has a positive credit balance, then a field ‘Credit’ will be displayed to the user and the user will have to pay new rate - credit. Additionally, if the new rate is lesser than the credit balance, then the user need not pay anything.
If by any chance, the system could not retrieve the credit/debt amount, the user will be redirected to the Dashboard page with an error message.
Note:
A checkbox has been introduced only for EZPay subscriptions prompting the users to indicate whether the collected credit card information has to be stored or not for future recurring payments. If the checkbox is checked, an Update Payment Method transaction will be triggered after the successful Restart transaction.
Pre-Requisites:
Circ System & Minimum Supported Version: Matrix, 38.00.034.ITSP6
New endpoint to monitor the health of SubCon Site
A new endpoint to monitor the health of SubCon Site application (whether the application is up and running) has been functional from this release. Status/Ping route is added to SubCon Site API that enables the monitoring of SubCon Site.
New CMS restriction for SubCon Site links
A new CMS restriction has been introduced that can be used in the ‘Hide Link For’ field. The restriction code to be used is ‘Corporate Subscription’. This restriction would be functional only if Subscription.RegistrationCount is not null and Subscription.RegistrationCount > 0.
When a SS link has Corporate Subscription code selected as part of ‘Hide Link For’ option, the corresponding SS link would be hidden from the SubCon Site page if the selected subscription’s registration count is not null and is greater than 0.
User details on the Subscription dashboard
The Subscription dashboard for users has been improved to display Company name (if available) along with their first name, last name, and Account number, allowing for easier reference. Previously, the dashboard only displayed the First name and last name of the user along with the account number, but this enhancement now provides additional user details on the dashboard.
Note: Company Name is an optional field.
Customized Guard messages in SubCon Site
The following new guard messages with the same look up name on the Layout page of SubCon Site have been customized using CMS.
Guard.AutoPaySignUp
Guard.RestartSubscription
Guard.StoppedSubscription
Guard.GuestError
Note: The guard messages are notification pop-ups that appear when a user attempts to access an unauthorized page.
Configurable Invitation type
Invitation type in SubCon Site has become configurable from this release. The invitation types can be set in the "InvitationType" property that comes under the "SubscriptionShare" section of SS config file. The new invitations types are “Owner“, “Guest“, or “Both”. If the setting is not defined in SS Config, the default value will be “Both” where the Invitation type drop-down displays both ‘Owner’ and ‘Guest’ option.
SubCon Site pages updated with client-specific Tag Managers
Client-specific tag managers have been implemented on SubCon Site pages to enable tracking of Accounts management.
One-CSR Portal
Hiding CSR remarks in the Show remarks grid
The CSR users can now Hide or Unhide remarks in the Show remarks grid. This feature is especially useful for Customer Service Representatives (CSR), as they can hide the irrelevant remarks that are not valid due to any errors/typo and create new ones instead. This ensures an accurate trail of remarks made and helps with auditing.
The Action column in the grid will include Hide/Unhide buttons corresponding to each row, enabling users to easily hide or unhide remarks. Additionally, a "Show hidden remarks" checkbox will be available (unchecked by default) for users to unhide hidden remarks in the grid. If the checkbox is checked, then all remarks will be displayed in ascending order (current behavior) but highlighted in grey color.
Exporting Registered users and pending invites to CSV file
A new button 'Export existing users' is introduced that allows users to download a CSV file. This file will include both active registrations and pending invites. The file will have the same format as the one used to import registrations. However, if there are no registrations or pending invites associated with the selected account, the button will be disabled.
When a user clicks on the 'Export existing users' button in One-CSR Portal, the additional registration data (for example, Company name, Position, Address, Postal code, City, Country, and Phone) that was collected during registration process and stored in the system as metadata is also included in the export file. The export data also includes details of registrations that are in pending invite state. Created one new endpoint "api/downloadRegistrationWithAdditionalData" for exporting registered and pending users with additional data.
Availability of Event 1107 in the SA
From this release, event 1107 is made available in the Event type dropdown under History Section of Research/Start Call (Show events) search. When CSR selects event Id 1107 from the dropdown and perform search, the search grid will display the event list of event type 1107. No changes in the display or behavior for the already existing event types.
Complimentary subscriptions related enhancements
For a Complimentary subscription, a text message will be displayed at the bottom of the billing address section within the Account Information Tab, stating: "Billing address is not applicable for Complementary Subscriptions."
When a comp subscription is created without an end date, clicking on the icon adjacent to the subscription kind field will display the info, "No End Date".
Saving Credit card details for easy future payments
In the One-CSR Portal of Matrix clients, if a user with stopped subscription (registered for EZPay who has credit card payment method) clicks on the ‘Pay Balance' or 'Restart' button, a checkbox with the text 'Use this payment method for future recurring payments’ will be displayed.
By default, the checkbox will be unchecked. If the checkbox is marked, and the user clicks the Save button, the payment method used for autorenewal will be updated with the entered credit card data. If updating payment method fails, an error message will be shown: “Payment posted successfully! The subscription has been restarted but failed to update the card details.”
Customizable user password length in One-CSR Portal
In One-CSR Portal, the maximum length of user passwords can now be customized. The previous restriction of password length not exceeding 32 characters has been removed. The password length can now be configured using the MG2 Control App Setting key 'Subscription.MaxPasswordLength'.
However, the minimum password length remains set at 8 characters. If a password with fewer than 8 characters is entered, the system will reject it and display an error message: "Password is missing or invalid. It should be at least 8 characters long". If a user exceeds the set password length limit, the system will provide a notification stating: "Password length limit cannot be exceeded". If the password length is not controlled through the new App setting key, the system will default the password length to a range of 8 to 30 characters.
New logic to display the Country field in SA
In One-CSR Portal, the logic to populate the Country field has been revised for NCS clients. The Country field in the Billing address data will be displayed based on the CountryCode from subscriptions API as the primary priority, followed by the Country. If both the Country Code and Country values are null, then the default value 'US' will be displayed in the Country field.
Solicitor Concierge (SolCon)
Filter removal for InApp Offers 'Google Play' & 'iTunes' from Offers API
Starting with this release, the Offer API from SolCon returns a complete list of currently active offers, that includes offers configured for GooglePlay and iTunes in addition to the existing set of offers.
API
API - Integrate Get Offer by ID
The endpoint GET /Address/Routable has been modified so that it no longer needs the SolCon database to retrieve the offer details. Instead, it uses the GET /Offers endpoint to get the data through an HTTP request.
The endpoint POST /Purchases has been modified so that it no longer needs the SolCon database to retrieve the offer details. Instead, it uses the GET /Offers endpoint to get the data through an HTTP request.
The endpoint POST /Subscriptions has been modified so that it no longer needs the SolCon database to retrieve the offer details. Instead, it uses the GET /Offers endpoint to get the data through an HTTP request.
API - Melissa
A new endpoint, POST /OnPremise/GlobalStandardize, has been developed for standardizing Australian addresses.
API - Address
The GET /Address/Standardization endpoint of the Address API has been modified to integrate the Melissa API (POST /OnPremise/GlobalStandardize) for standardizing Australian addresses.
A new endpoint, GET /Subscriptions/{subscriptionId}/MovesAvailability, has been developed to determine if a subscription qualifies for the transaction to be processed and, if it does, whether the delivery address, billing address, or both addresses can be modified in SubCon Site.
The Moves Availability rules are as follows:
For Digital Subscriptions, the Delivery Address shouldn't be modifiable.
For Complimentary Subscriptions, the Billing Address shouldn't be modifiable.
For the Digital Complimentary Subscriptions, the transaction shouldn't be eligible to be processed.
The remaining Subscriptions are allowed to process Moves.
API - TemporaryStops
The POST/TemporaryStops endpoint now includes two new input parameters: Source Code and Sub Source Code. Source Code must be provided as a mandatory input parameter, while Sub Source Code is only required if the Source Code has Sub Sources defined.
Two new MG2 control internal settings have been added to set the values for the SourceCode and the SubSourceCode:
TemporaryStop.SourceCode
TemporaryStop.SubSourceCode
The NewVacation event will have the details of SourceCode and SubSourceCode in the request field, which will be sent to the AddVacation MicroAPI.
Note: The SourceCode (mandatory) and SubSourceCode (optional) parameters for this API should be defined only when using NCS Circ version 2020-5.0 or higher. On the other hand, when clients are on NCS version 2020-5.0 (or higher) and the SourceCode value has not been defined or is invalid, NCS will return an error.
The GET /TemporaryStops/Subscriptions/{subscriptionId}/Availability endpoint has been modified to include a new input parameter, AllowStoppedSubscription, which allows the validation of stopped subscriptions to be bypassed. This end point is also used to determine available dates in other workflows, which has an impact on the restart flow.
The stopped subscription is accepted by the availability endpoint only when the AllowStoppedSubscription parameter is true. Passing the value as blank or false does not bypass the stopped subscription validation.
API - Core
The API Core has been modified such that it now gathers all the settings that were applied during the processing of a request in the SettingCollector rather than the ErrorCollector.
Details of the RequestId, SessionId, Controller Method Name, and Settings Array are included in the SettingCollector log file.
The API Core has been updated to include a stopwatch to determine the response time taken for the Low-Level APIs.
The time taken will be displayed under the Duration column of the Event_Post_Return_Html.
API - Purchase
The POST /Events endpoint now populates the Registration ID in the event log table if a valid Event_Type_ID is passed in the request.
A validation check has been implemented for the input parameter “RegistrationCount” in the POST/Purchase endpoint to limit the maximum number of registrations allowed when creating a new start. If the registration count exceeds the value specified in the MG2 control setting, a validation error will be returned.
A new MG2 control internal setting, "Subscription.MaxLinks," has been added with a default value of 100.
Previously, if a user entered both the delivery and billing addresses when creating a new subscription in the Subscription Panel, the APIs would collect the information but not send it to the CircPro application. This occurred because the updateDataWithParsedAddress method only accepted a single address and did not allow for the entry of a second address.
The purchase API has now been modified to send multiple addresses to the CircPro application by replacing updateDataWithParsedAddress with the updateDataWithMailingAddress method.
Now, when creating a new start with a single address, i.e., the same delivery and billing address, only regular address fields will be sent to the CircPro application. And if creating a new start with different addresses in the delivery and billing address fields, the delivery address will be sent to the regular address fields and the billing address to the mailing address fields in CircPro.
A new MG2 control internal setting, "CircPro.SubscribeWebService.EndpointAddress," has been added. The value for this field varies based on each CircPro client.
API - Subscriptions
A validation check has been implemented for the input parameter “RegistrationCount” in the
PUT /Subscriptions/{subscriptionId} endpoint to limit the maximum number of registrations allowed when creating a new start. If the registration count exceeds the value specified in the MG2 control setting, a validation error will be returned.
A new MG2 control internal setting, "Subscription.MaxLinks," has been added with a default value of 100.
The endpoint, PUT /Remarks/{remarkId}, has been modified to update the Hidden column under the Remarks table in Subsvc of a subscription based on the details provided for the RemarkID and the RemarkTypeID.
The endpoint, GET /Remarks, has been modified to include new output parameters, Active and Hidden, to indicate whether a respective Remark of a subscription is hidden or active. The logical values are true and false. By default, the QueryString parameter, request.onlyActives, is set to true.
A new endpoint, DELETE /Remarks/{remarkId}, has been developed to remove the active status of a Remark based on the provided RemarkID.
API - Billing
The GET /Billing/AutoBill/{subscriptionId} has been modified to retrieve the amount required to restart a subscription in the API response. The new Matrix endpoint, SubCalculateID, which has been associated with the GetRates event, will return the required details in the response under GetStoppedSubscriptionPaymentOptions only for stopped subscriptions in Matrix Flow.
When restarting a subscription in the Matrix Restart flow, payment-related events will no longer be created if the amount to be paid to restart the subscription is zero.
The POST /Billing/Payments/{subscriptionId}/RestartPayment now includes a new output parameter, Restart Date, in the response, allowing the API to return the restart date for the accounts in SubCon Site.
When processing one-time payments, the event log will now include either the masked Credit Card number (if the one-time payment is processed through Credit Card) or the masked Bank Account number (if the one-time payment is processed through ACH).
API - Proxy
Previously, even if the API response returned error codes like 200, 400, or 500, the HTTP Status Code was always 200. This was due to the APIs not managing HTTP status codes correctly. Due to the fact that the load balancer only depends on the HTTP Status Code, this resulted in the load balancer realizing the server was down quite late.
The HTTP status code is now returned correctly to match the API response error code as a result of conversion logic that has been introduced to the Proxy API handler.
For example, the HTTP status code 503 is now returned instead of the previous HTTP status code 200 when the server is down.
API - OSG
The OSG API, which allows users to download their invoices, has been modified to store the information of the invoice, URL, unencrypted request XML, and result in the Event_Post_Return_Html table of the GetInvoices event type.
API - Payway
A new MG2 control setting, Edgil.SoftDescription, has been introduced to allow the value specified in this setting to be passed to Payway as a processorSoftDescription in the card transaction authorization request. Statement descriptors provide an explanation of charges or payments on bank statements, as well as the information that banks and card networks require to ensure that customers understand their statements.
API - Subscription/Billing
Previously, on the 'My Profile' page of the SubCon Site, the Last Payment Amount and Expiration Date details for CircPro clients were obtained from the database once a day and were not being retrieved in real-time.
By integrating with the CircPro APIs getCustomers (for the Expiration Date) and getPayments (for the LastPayment Amount), changes have been made to the GET /Billing/AutoBill/{subscriptionId} and GET /Subscriptions/{subscriptionId} endpoints to retrieve these details in real-time.
The information that has been obtained is updated on the ‘My Profile’ page and synced with Subsvc under the Subscription Table.
Pre-Requisites:
Circ System & Minimum Supported Version: CircPro, 2019-2.0
API - Matrix
Previously, the logic for selecting Matrix addresses resulted in the system randomly selecting either the AlternateDeliveryAddress or the Main address for the Delivery address and either the Billing or the Main address for the Billing address. This logic causes an issue when the Main address is considered by Subscribe even when AlternateDeliveryAddress or Billing Address is available.
The logic determining the selection of the Delivery Address and Billing Address has been modified such that:
As for the Delivery Address, the AlternateDeliveryAddress will be used. If there is no AlternateDeliveryAddress, the Main AddressType will be used as the Delivery Address.
The Billing will be used as the billing address. If the Billing address does not exist, the Main address is used instead.
CMS
Add Phone number to Lite Form Component
The Lite Form V3 now includes the subscriber's phone number as a component in the Personal Details section with all necessary properties.
If the phone number properties are switched "ON" while creating a new Lite subscription, it is necessary to provide a phone number in the respective field.
The Lite Form V3 of Subscription Panel now includes the subscriber's phone number as a mandatory field when creating a new subscription.
The user can configure the PhoneNumber properties by going to: CMS > Subscription Panel > Presentation (Choose a valid presentation) > Page V3 > Step V3 > Lite Form V3 > Details.
Switch On/Off the properties of PhoneNumber, as required.
Open Graph image tag in Subscription Panel
The Open Graph image tag (og:image:alt) has been introduced to PresentationPropertiesV3 in CMS in order to facilitate the usage of this tag in the Subscription Panel. If the images can't load on third-party websites like Facebook, this alternative text will be displayed instead.
The Open Graph image tag (og:image:alt) has been added to the Subscription Panel so that an alternative text will now be displayed if the images can't load on third-party websites like Facebook.
The user can configure the properties by going to: CMS > Subscription Panel > Presentation (Choose a valid presentation) > PresentationPropertiesV3 > Details > OgTags ImageAlt.
Australian Phone Number Validation in Subscription Panel
In order to use Australian phone numbers in the Subscription Panel, phone number validation properties have been added to the components in CMS listed below.
DeliveryInformationV3
BillingInformationV3
IndependentAddressV3
PaymentMethodsV3
Subscription Panel now supports Australian Phone Number based on the CMS configuration. By default, the format for Australian phone numbers has been set to "xx-xxxx-xxxx", where the first 2 digits are any number between 0 and 9, followed by a hyphen (-), then followed by 4 digits between 0 and 9, then followed by a hyphen (-), then followed by 4 digits between 0-9.
Transport Layer Security (TLS) Upgrade to Version 1.2
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket.
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
This fix was also merged to 2.39.1, 2.39.1.0, 3.15.2.1, 3.15.3.1, 3.16.0.13, 3.16.1.7, and 3.16.2.4.
Subscription Panel
Company Name Field in Subscribe Database
Previously, the Company Name provided in the Subscription Panel while creating a new subscription was not being pushed to the Subscribe database. Changes have now been made so that the company name that is provided will be recorded in the Subscribe database along with the subscriber's other details so that it will be displayed on the CSR site.
Print Subscription should be created only for Routable Address
The Print Subscription will now only be created if the address provided is routable and will return an error if it is not. To make sure that only routable addresses are used for creating Print Subscriptions, an address validation check has been implemented after clicking the Submit button in Subscription Panel.
GooglePay Icon error
When processing a payment with GooglePay in the Subscription Panel that had multiple cards set up, switching the payment method from one card to another did not show the chosen card in the GooglePay icon iframe of the payment page.
Changes have now been made so that the selected card for the payment will be displayed correctly in the GooglePay icon iframe on the Subscription Panel payment page.
One-CSR Portal Fields Loading Error
This is a client-specific case.
When starting a subscription through the CSR Funnel, choosing an offer and clicking "Go to CSR Start Portal" did not load all the necessary fields on the first try; instead, the CSR portal had to be closed and opened again for each offer to load all the fields.
Changes have been made such that the fields now load properly on the very first attempt, and when you click the Submit button, the form is successfully submitted.
GoogleTagManager (GTM)
Multiple container IDs can now be added to the GoogleTagManager (GTM) container in the Subscription Panel. This allows the use of an array of container ids in the configuration file, and these values will be used in the GTM script in the layout pug file.
Note: The client has to use the "commonResource" and "commonResourceBody" pug files in their layout pug file in order to integrate multiple containers.
The client specific GoogleTagManager (GTM) script has been included in the Subscription Panel configuration.
Note:To use the GTM script, each client must import the "commonResource" and "commonResourceBody" pug files.
Subscription-related enhancements in the Subscription Panel
This enhancement is related to clients using GUP authentication.
Previously, in SubCon Site (My Account), when a subscription was restarted after being permanently stopped, the client was unable to link the new account with the old one and was instead directed to their old accounts.
The Subscription Panel (SP) received an incorrect value from the GUP API (currentUserAPICall()) key "isAuthenticatedIncurrentContext", which caused this issue. The customerRegistrationId (CRID) in SP changes into the "anonymousId" if the value supplied for "isAuthenticatedIncurrentContext" is true. The CRID becomes null if the value for "isAuthenticatedIncurrentContext" that the GUP API passes to the SP is false, which prevents the Link Owner event from being called.
Now, the "isAuthenticatedInCurrentContext" value is no longer taken into consideration, and instead, the "isAnonymous" value is used to see whether the user is currently logged in. The userId is null if "isAnonymous" is true; otherwise, the anonymous ID is set to the userId.
And if a subscription has been stopped on SubCon Site (my account), clicking the Subscribe button will direct users to the Subscription Panel URL, where they can purchase a new subscription. A CRID will be generated after the user purchases the new subscription, and by going to SubCon Site/One-CSR Portal, both the stopped and new subscriptions will now be linked.
Naviga Dashboard (DSB)
This is for internal stakeholders only.
Naviga Subscribe is launching the initial release of the brand new Naviga Dashboard in 3.16.3. Naviga Dashboard is a new application that empowers Support, Implementation and Project Management teams to modify their configuration settings without the need of any scripts.
Below is a list of various enhancements that have been implemented in the new Naviga Dashboard:
Appropriate modals with corresponding validations are made available to add, edit or view Api settings on the Tenant and API Settings pages of Naviga Dashboard.
If the ApiSetting value is String, a Textarea will be displayed to input data. No validation in place for Textarea.
If the ApiSetting value is Int, a Textbox will be displayed to input data. Numeric validation implemented.
If the ApiSetting value is Boolean, a Checkbox will be displayed to input data. No validation in place.
If the ApiSetting value is Json, a WYSIWYG form element will be displayed to input data. Json should be properly formed.
The "Edit Tenant" option in the main menu (hamburger menu at top right) on the Tenants page has been replaced with a pen icon that is now included with each entry in the Tenant grid. Clicking the pen icon for a particular tenant record will open a window, allowing the user to easily modify the details for the selected tenant as displayed below.
The Home, Environments, and API Setting Types options have been removed from the sidebar menu and are no longer accessible from the Dashboard. Moving forward, only the Tenants and API Settings options will be available in the sidebar, with the Tenants page being set as the default page.
The Compare Api Settings modal design has been improved. The changes made are enlisted below:
The Title of the modal is changed from “Compare Api Setting Values“ to “Compare <ApiSettingKey name>“
The subtitles have been shortened to just ‘Source’ and 'Target
Modal width has been reduced by 30%.
An unwanted Textbox and Label for the ApiSettingKey have been removed.
The underlying form would be hidden while displaying the comparison results.
A ‘Go back’ button has been introduced on the form showing the comparison results.
The active flag, which was previously used for the logical deletion of an API setting and was present on both the Add and Edit API Settings pages, has been removed now. This decision was made because it seemed illogical to have a deletion flag present on both of these pages.
The DB schema has been improved, by adding the relationship between the ApiSettings, and the ApiSettingDataTypes.
There were some discrepancies found in the Dashboard-specific stored procedures between the Dev branch and the BetaRelease branch. From this release, it has been made sure that all the changes are in place and both branches have the same set of stored procedures. This will ensure that the code is working correctly and consistently across both branches, making it easier to test and release to users.
The Dashboard is accessible only to two Roles: MG2 Admin and MG2 Developer.
Refactor
SubCon Database
Performance Optimizations
Following Stored Procedures and Views are optimized now, and cost of execution is reduced.
GetBillingSubscriptionById
GetBillingInfoBySubscriptionId
GetBillingInfoBySubscriberId
ApiCreateEventLog
ApiGetFilteredEventLog
ApiCreateChildEvent
vwPayments
vwBillingMinimumSubscriptions
vwBillingData
The column size of the Id in RefreshTokens table of mg2_control database has been verified and corrected accordingly. It is changed from Nvarchar(Max) to Nvarchar(200). Proper Indexes also have been added on this table to improve the performance of querying and retrieving data from the table.
API
API - Purchase
In Subscribe, when the lookup strategy (Purchase.GetSubscriber.LookUpStrategy in MG2Control) is set to email, only one occupant has to be returned per email address. However, on the NCS Circ side, a feature has been added that returns multiple occupants when searched using an email.
Due to the above configuration issue, the FindAddressOccupant failed in the Subscription Panel with the error message "Child Event: FINDADDRESSOCCUPANT failed. Error: Completed," which does not clearly state the error occurred because the error handler has not been checking the event status received from the NCS Circ.
The error handling has now been modified so that if NCS Circ returns multiple occupants instead of one, the Subscription Panel now displays a clearer error message, "Invalid occupant result. Only one occupant is expected" rather than "Error: Completed."
This enhancement is specific to NCS Circ clients.
Pre-Requisites:
Circ System & Minimum Supported Version: NCS Circ 2020
API - Core
The logic to handle event operations has been updated in the new API core, limiting event creation to the Orchestration Layer, where event logs are necessary.
API - ApiCache
The POST /Cache/All endpoint has been updated to include a new step that triggers a request to the Users Orchestrator to clear the cache settings from the new Core depending on SubscribeCoreCacheVersion.
API - Users
The Users endpoint, POST /User/UpdateSolicitationPreferences, has been modified to return an error when a non-supported tenant is passed in the request for NCS clients. Previously, regardless of whether the occupant was supported, the request was processed by the class that was controlled by the internal flow setting Flow.TrackingCodes.
In order to update the occupant communication flags, a new internal flow setting, Flow.CircSystem, has been added, and the previous internal flow setting Flow.TrackingCodes has been deprecated.
The endpoints, POST /License (Create License), POST /Subscriptions/Upgrade,
POST /Subscriptions/Downgrade, POST /User/OwnerUser, and POST /User/GuestUser have been modified in order to prevent the LinkOwner and LinkGuest events from being processed by third-party vendors.
If LinkOwner or LinkGuest endpoints have been successfully processed and the MG2 control flow setting, Flow.EntitlementProvider, has been set to the third-party vendor "Firefly," then the AddExternalEntitlement record will be created by calling the Entitlements/External endpoint of the Entitlements API.
The User endpoints, POST /User/LinkSubscription/Revoke and POST /User/GuestUser have been modified in order to prevent the RevokeLink events from being processed by third-party vendors.
If the RevokeLink endpoint has been successfully processed and the MG2 control flow setting, Flow.EntitlementProvider, has been set to the third-party vendor "Firefly," then the DeleteExternalEntitlement record will be created by calling the POST /Entitlements/External/Revokes endpoint of the Entitlements API.
API - Users Orchestrator
A new orchestration API, GET /Users/{Id}, has been developed to handle the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API.
With the input parameter Customer Registration ID (CRID), the API gets the user's information from both the integration service and the subscribe registration. The response displays the combined information.
A new orchestration API, GET /Users, has been developed to handle the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API.
The details of users can be retrieved by providing either the registration email ID or Customer Registration ID (CRID) as an input parameter.
Based on the value of Flow.UserProvider and the IgnoreProvider input parameter, the API gives user information in the following way:
If no valid value is provided in Flow.UserProvider, the API retrieves user information from the Subscribe Registration API.
If a valid value is provided in Flow.UserProvider and the input parameter IgnoreProvider is set to True, the API retrieves user information from the Subscribe Registration API.
If a valid value is provided in Flow.UserProvider and the input parameter IgnoreProvider is set to False, the user's details are retrieved from both the integration service and the subscribe registration. The combined information is displayed in the response.
MG2 control flow setting: Flow.UserProvider value should be set to "Auth0," "Gigya," "SSOR", or "Firefly", depending on the third-party system or integration service being used.
MG2 control flow setting, "Flow.Users.RedirectToOrchestrator", value has to be set to 1 for the ProxyAPI redirection to the UsersOrchestratorAPI instead of the UserAPI. The default and recommended value of this setting is 0 (zero) for this version.
Note for Implementation:
Clients who are currently on 3.16.3 should not set the value of the setting, "Flow.Users.RedirectToOrchestrator", to 1. Only after upgrading to 3.16.3.1 should you update the value of the setting to 1 for ProxyAPI redirection to UsersOrchestratorAPI.
Updated on September 29th, 2023
API - Subscribe Registrations
A new endpoint, POST /SubscribeRegistrations, has been developed to create Subscribe Registrations.
Based on the provided information, such as the registration’s first and last names and email address, a subscribe registration record will be added to the Registrations table in the database.
A new endpoint, GET /SubscribeRegistrations, has been developed to return the details of created registrations.
The details of registration can be retrieved by providing either the registration email ID or registration ID as an input parameter.
A new endpoint, GET /SubscribeRegistrations/{CustomerRegistrationId}, has been developed to return the details of created registrations based on the provided Customer Registration ID.
A new endpoint, PUT /SubscribeRegistrations/{CustomerRegistrationId}, has been developed to update an existing Subscribe Registration.
Note: If the provided Customer Registration ID does not exist in the Registrations table, a new record will be created with all the details provided.
API - SubscribeEvents
A new endpoint, GET /SubscribeEvents has been developed for retrieving the list of events and their details (such as the Event ID, Event Type Code, Add Date, Date Local, Event Status, Event Message Id, Event Message) and pagination information (row number and total rows).
A new endpoint, GET /SubscribeEvents/{EventId} has been developed for retrieving the complete details of an event based on the provided Event ID.
A new endpoint, POST /SubscribeEvents has been developed to create a new event.
A new endpoint, GET /SubscribeEvents/{EventId}/Operation has been developed for retrieving the operation information for an event.
Note: The operation information is retrieved from Event_Post_Return_Html.
CMS
CMS Content Module Changes
The following changes have been made to the CMS module:
The front-end of the CMS Content Module has been changed from WebServices to AngularJS.
The back-end of the CMS Content Module has been changed from Visual Basic .NET (VB.NET) to NET Framework 4.8 (.NET 4.8).
CMS Notification
CMS > Notification New > Test Notification New
When choosing the consumer as SubCon, the ResponseObject field in the ‘New Notification Testing’pagehas now been made a non-mandatory field.
Subscription Panel
Performance Optimization
On the subscription panel, performance issues caused by render-blocking resources such as CSS and JS files on the UI side have been resolved. To prevent the issue, the render-blocking resources will now be preloaded or loaded in an asynchronous manner.
SubCon Site (Self-Service)
Refactoring of Tag Manager section
SubCon Site handles various types of Tag Managers. Whenever a new Tag Manager has to be introduced, it required product development. With this new enhancement, any Tag Manager can be implemented in SubCon Site by just updating client’s configuration without any development.
Standardized Load Script functions
The DOM Service previously consisted of multiple functions dedicated to injecting scripts for various integrations. However, a standardized function has been introduced now that can handle both internal and external scripts. This new function can be utilized throughout the entire application, offering a unified approach.
To clarify, the single standard function is capable of injecting a script by accepting either a URL or a script body.
Resolvers on SubCon Site
Starting from this release, resolvers have been incorporated into SubCon Site pages. As a result, the configuration is readily available when the page loads, eliminating the need for defensive code that previously checked if the configuration was null or undefined.
Upgrade of SubCon Site pages to latest Angular version
The SubCon Site pages have been upgraded to the latest Angular Version 12. It has also made sure that all the packages (dependencies) are upgraded in parallel. In scope of Angular version upgrades, some NgRx syntax has also been upgraded.
Resolved Issues
SubCon Site (Self-Service)
Error in 'My Subscriptions' URL
The issue of paper code in the URL getting changed to the paper code of a different newspaper (default newspaper) after clicking My Subscriptions link (Manage > My Subscriptions) has been resolved.
Issue with Tip Amount
The Tip amount entered by users were getting limited to $50 on My Account page of the Self Service portal while doing the bill payment. The system was not accepting any amount higher than $50. This issue has been resolved and the maximum amount bar is raised to $500 now.
Vacation Stops appearing in Stop Saver flow
The problem regarding the inclusion of the "Vacation Stop with Restart" reason alongside other permanent stop reasons in the subscription cancellation workflow has been resolved. Following the fix, the "Vacation stop with Restart" reason will no longer appear in the drop-down menu of reasons for permanent subscription cancellation.
Error message on Cancel page even after navigating to another page
The alert message that got displayed on the Cancel page while cancelling a subscription on a non-publishing day was still appearing on the page even after the user navigated to another page and then came back. This has been resolved now.
Missing Credit Card Details
Even after the successful Autopay Signup, the credit card details entered were not visible in the Autopay Manage page. Likewise, when the user was trying to update the payment details on SubCon Site, the credit card details were blank whereas the same account had credit card info in the One-CSR Portal. These issues have been resolved.
The iframe loading error on payment pages
The issue of iframe not loading on the payment page (autopay/signup page) has been resolved. While the issue did not happen in incognito mode, it was affecting the loading of payment pages. This issue has been fixed now.
Login issue
The users were able to change their password in One-CSR Portal with 32 char long password, but encountered difficulties while logging into the SubCon Site with the newly changed password. However, this issue has now been resolved.
Notification Errors
The issue of Notification texts configured in CMS not being displayed on SubCon Site pages (VerifyAccount, TemporaryStop, StopSaver, and SubscriptionUpdate) has been resolved. The "Notification texts configured in CMS" is working fine for all SubCon Site pages without exceptions.
SubCon Site - Invalid Logout call on some flows and 500 error by Update user endpoint
The issue of an increased number of 500 and 404 errors found on clients' servers has been successfully resolved. This was an Authentication system specific issue. For SSOR clients, even if the user was logged out while navigating to the SubCon site, the logout call was triggered and was returning a 500 error. For MG2 Auth clients, the wrong credentials during login were triggering the logout action. After the fix, for SSOR clients, the logout call will be executed with a status 200 and for MG2 Auth clients, there will not be any logout call while entering the bad login credentials.
One-CSR Portal
Registrations User Interface
The push buttons (Details, Edit, Invite, and Forgot Password) located under Registrations in the Digital tab were tightly packed and intersecting with each other. However, after providing enough room between the buttons and reworking the user interface, the buttons now have enough space, and the overall UI appearance has been improved.
Issues with restarting a stopped Subscription
While restarting a recently stopped subscription by paying the valid due amount, the CSR was not taken into the existing account with an updated Active status. Instead, CSR was put into a new Start call which was not the expected behavior. This has been rectified now for all Circ systems.
Custom Report export error
It was not possible to export Custom Report from One-CSR Portal if the dataset to be exported was large. This was caused by an erroneous condition check that relied on row and column counts. After fixing the issue, it is now possible to export the Custom Report regardless of the data size to be exported.
Account update error
While submitting the update of a user account with any action in the Account Information tab, the user was receiving an error message. After fixing, a user account can be updated successfully without any error message.
Company Name column disrupting the layout of Search result grid
The search option Company name is available in One-CSR Portal only if the setting key SubscriberSearchCompanyNameOption in the Support viewer has a value 1. Even when the value of the key was 0, the Company name column was visible in the Search result grid and it was disrupting the layout of the grid.
On the page reload after clicking the Search button, the value of the setting key SubscriberSearchCompanyNameOption was not considered, and the system was displaying the default result grid with Company name column. This resulted in the layout issue. Now after incorporating the adequate checking in place, the result grid is displayed appropriately as per the value of SubscriberSearchCompanyNameOption key.
Offers not available for CSR to subscribe
When the customer support representative user was attempting to add a new user to One-CSR Portal and initiate a subscription call, no offers were displayed, but an error message was appearing, even though offers were already set up in the SolCon. This issue has now been resolved. After the fix, the CSR can now view all offers set up for his teams in SolCon and can select any offer to benefit the customer.
Landing Application
Multiple User issues on landing page application
The following issues that were occurring during the process of adding or updating users through the Landing page application have been identified and resolved:
Once a new user is created and success message is displayed, if an edit happens on the user profile before navigating to any page, the system was not accepting it.
Existing users who had access to multiple applications (Products) were only able to view one application when editing their user profile. Attempts to add additional applications resulted in an error indicating that the user already existed.
Some users were missing the Client and/or Environment settings.
Updating the profiles of existing users was not functioning properly and needed attention.
Solicitor Concierge (SolCon)
Unable to add Division to a published offer
The user was not able to add a Division to a published offer in SolCon. An error message was displayed during this update. This issue has been resolved.
Issue with 'Mark as processed' button
The issue with 'Mark as processed' button in SubCon Admin has been resolved.
API
Gift Flow Corrections - NCS Circ
When a user attempted to buy a gift subscription using the Subscription Panel's Gift purchase subscription flow, the response for the AddModifyDemographic event was displayed as Null. But manually calling the AddModifyDemographic API worked as expected. This issue has been fixed, and the response will now be displayed correctly.
In the Subscription Panel, when purchasing a gift subscription, a success message was displayed; however, the AddSubscription endpoint returned the error message "Invalid Gifting API Response." The issue has now been fixed, and a subscription will be created without error.
Additionally, after the gift has been redeemed, the gift subscription is converted to a standard subscription after the nightly sync.
The gift flow issues have now been resolved for NCS Circ clients.
Supported Versions:
Minimum Subscribe Version: 3.16.3
Minimum NCS Circ Version: 2020.2 Plus SP1
API - Performance
The error "Value cannot be null. (Parameter 'value')" that occurred on the servers with version 3.16.0 for the Subscription Restart and Auth0User workflows has been resolved.
This error was caused by the null value issue with the MG2.SubCon.WebApi.Controllers, which prevented the applications from working correctly but triggered a lot of pop-up alerts.
Column not populating as expected in event_log table
When new events were created through the POST /Events endpoint, values in the d_unitNum and d_unitType columns for some of the EventTypes were displayed as Null in the event_log table. This has been fixed, and the aforementioned columns will now display the correct details for the corresponding EventType.
CMS
Page and Segment Management: Error while creating a new page with an existing name
CMS > Admin > Page/Segment Management
When creating a new page (or segment) with an existing page (or segment) name, the unclear error message "Sorry, there was a problem adding page (or segment)." was displayed instead of the correct error message "The Page (or segment) with such name already exists". This issue has now been fixed.
Import progress bar error
While importing a presentation from a JSON file, the import progress content pop-up window became unresponsive after the import was completed, and the user was unable to close the pop-up by clicking the close button (X).
This issue has now been fixed, and the OK button in the pop-up window will only be enabled if the import progress content has reached 100% completion, and clicking the OK button will close the import pop-up window.
Incorrect success message displayed for overriding the attributes
CMS > Attributes > (Select any attribute) > Edit (update the required values) > Save > Remove Override
When overriding an attribute, the incorrect success message "Attribute successfully deleted" was displayed instead of the correct message "Attribute override successfully removed". This issue has now been fixed.
Detail button issue in the User Information component
The issue with the Detail button not displaying the details of the User Information component for clients with large amounts of data, which caused the database to take longer to load the components, has now been fixed.
Incorrect success message displayed for removing an override of a reward
When removing an override of a reward, the incorrect success message "Reward successfully deleted" was displayed instead of the correct message "Override successfully removed". This issue has now been fixed.
Creation of new rewards without selecting Display For checkbox
CMS > Rewards > Add
The issue with rewards being created even when no option for the "Display For" checkbox was selected has been fixed, and creating or modifying rewards without selecting an option under ‘Display For’ will no longer be allowed.
Subscription Panel
Print subscription with non-routable address issue
The issue with the "I'd like to provide a different Billing Address" checkbox being automatically selected when the user enters a non-routable address for a Print Subscription and then selects the routable link to a different offer mentioned in the error message pop-up has been resolved by setting the checkbox to false by default.
OI Database
The regional date format support for Australian clients have been introduced in OI:
All date fields in NCS will be stored in mm/dd/yyyy format in the database (a Progress 4GL feature), regardless of the client's region (US/UK/AUS, etc.). Only the display format varies by region. For example, the display format for the U.S. region will be mm/dd/yyyy, whereas Australia will use dd/mm/yyyy.
Extracted data follows the display format of the field. Therefore, for the U.S., dates in extracts will be in mm/dd/yyyy format, while for Australia, they will be in dd/mm/yyyy format.
There will be no change in date format when receiving requests through CircAPI. NCS expects dates in mm/dd/yyyy format for ALL clients.
CircAPI XML responses may use either yyyy-mm-dd or the client's display format (e.g., dd/mm/yyyy for Australia), depending on the specific API.
ETL changes have been made to accommodate the dd/mm/yyyy format from extracts of AUS region clients. However, Subscribe will store data only in mm/dd/yyyy format.
NCS APIs have been enhanced to handle date format conversion (via Business Rules Setup) when receiving/sending date-related data.
Future Enhancements
These are partial enhancements checked into 3.16.3 that do not affect any functionality and will be ready for use in a future release.
External Entitlements - Real-Time Update
A new endpoint, POST /Entitlements/External, has been developed to create an Entitlement for a specific subscription with a third-party vendor, such as Firefly or Piano.
Configuration Notes:
MG2 control flow setting: Flow.EntitlementProvider is set to Firefly.
If the EntitlementStartDate is today, the Entitlement will be created immediately. An AddExternalEntitlement record will be created and processed to create the license.
If the EntitlementStartDate is in the future, the Entitlement will be queued for later processing. An ExternalEntitlementQueue record will be created.
If the EntitlementStartDate is in the past, the request will be rejected.
MG2 control flow setting: Flow.EntitlementProvider is set to Piano.
Irrespective of the EntitlementStartDate, the Entitlement will be created immediately.
A new endpoint, PUT /Entitlements/External, has been developed to update an existing entitlement for a specific subscription with a third-party vendor, such as Firefly. The AddExternalEntitlement record will be updated based on the information provided.
A new endpoint, POST /Entitlements/External/Revokes, has been developed to delete an entitlement for a specific subscription with a third-party vendor, like Firefly, when a link or license is revoked.
Once the entitlement has been removed from the account, a DeleteExternalEntitlement record will be created.
The entitlements are recorded in the ExternalEntitlementQueue table if they have a start date in the future. In order to process these entitlements that are in the ExternalEntitlementQueue table when the start date has been reached, a new endpoint, PUT /Entitlements/External/Queue/{ExternalEntitlementQueueId}, has been developed.
When processing the record from the queue:
If the event has been processed successfully, an AddExternalEntitlement record will be created and processed for creating the license.
The Status column of the record in the ExternalEntitlementQueue table will be updated to either 1 (if the event has failed to process) or 2 (if the event has been processed successfully).
The ExternalEntitlementQueue table's Retry Count column will be updated to 1 if the event could not be processed, and this number will be increased by 1 for each additional failure.
A record's Status column will be updated to 1 (failed) when the RetryCount reaches the value specified in the MG2 Control Setting, OnPremise.ExternalEntitlement.MaxRetryCount.
A validation error will be returned if the queued record has already been processed (either failed (1) or completed (2)).
A validation error will be returned if the record in the queue has a start date in the future.
A new OnPremise endpoint, POST /Entitlements/External/Configure, has been developed to schedule a task (cron job) that will run every day to check the records for processing the entitlements under the ExternalEntitlementQueue table.
The Status column (0 or pending) and the EntitlementStartDate (should be ≤ Today) are used to identify the Entitlements records that need to be processed.
With the EntitlementQueueId as an input parameter, the identified records will be processed by calling the POST /Entitlements/External endpoint.
A new OnPremise endpoint, DELETE /Entitlements/External/Remove/{taskKey}, has been developed to delete a scheduled task created with POST /Entitlements/External/Configure endpoint.
When creating (POST /Entitlements/External), updating (PUT /Entitlements/External), or deleting (POST /Entitlements/External/Revokes) an entitlement, an Event ID in the input parameter, ParentEventID, will make the respective entitlement the child event of the provided event (ParentEventID).
If no value is passed for the input parameter, ParentEventID, the respective entitlement will have no relation to any other events and is considered a regular event.
An entitlement's parent Event ID will be displayed in the ParentEventID field of AddExternalEntitlement and DeleteExternalEntitlement records. If the entitlement has no parent event, the field will display Null.
The upgrade and downgrade flow for the abovementioned respective endpoints has been updated to include a new step that executes the Create License operation in Firefly through the Update External Entitlement endpoint (PUT /Entitlements/External).
Once the subscription has been successfully upgraded or downgraded in the Circ System, the AddExternalEntitlement record will be created through the PUT /Entitlements/External endpoint.
The Purchase API has been modified to include a step at the end of the New Starts flow to create the Entitlement with a third-party vendor, such as Firefly or Piano.
Once the subscription has been successfully created, the AddExternalEntitlement record will be created through the POST /Entitlements/External endpoint.
NavigaPay
A new component, NavigaPay V3, has been added to the CMS to be used as one of the payment methods in the Subscription Panel.
Configuration Notes:
The user can configure the properties by going to:
The NavigaPay API has now been integrated with the Newstart flow, allowing NavigaPay to be utilized as a payment gateway.
Configuration Notes:
MG2 control flow setting: Flow.BillingProvider should be set to NavigaPay
Solicitor Concierge - API Integration with CircPro
The direct integration API has been developed as a simple wrapper for external systems and is used in cases when consumer applications need to communicate with a specific system but do not need full integration and instead rely on the subscribe API. In addition to CircPro, this feature can also be used for NCS integration.
With this release, the API development has been completed, and the Solicitor Concierge application will be enhanced to consume this API in an upcoming release.
A new Direct Integration Orchestration API, GET /DirectIntegration/Rates, has been developed for CircPro clients to return the available rates for a specific publication.
A new Direct Integration Orchestration API, GET /DirectIntegration/StartReasons, has been developed to return the start reasons available for a publication for CircPro and NCS Circ clients.
Configuration Notes:
MG2 control flow setting: Flow.CircSystem value should be set to either NCS or CircPro based on the Publication information required.
A new Direct Integration Orchestration API, GET /DirectIntegration/Rates/{externalId}, has been developed to return details of rate codes based on the ID (ID - rate code received in the GET /DirectIntegration/Rates endpoint) for CircPro clients.
3.11
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
3.11
2018.5 Service Pack 1
NCS Circ: Closed
Subscribe: Closed (Version 3.13)
3.10
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
3.10
Updated on July 13, 2023
3.17.1.x Hotfixes
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
This release is currently in its Beta version.
Attention - Enhancements
Removing dependency on the EZPAY Component for Applepay Payway in the Autopay flow
The dependency of Autopay flow on the EZPay CMS component has been removed for ApplePay Payway newstart transactions. The new start flow will now follow the EZPay settings configured in the SolCon offer regardless of the EZPay component's inclusion in the CMS presentation:
EZPay Required selected in the SolCon offer: New starts will be submitted with EZPay set to 'true' regardless of the EZPay component's presence in the CMS presentation.
EZPay Not Required selected in the SolCon offer: New starts will be submitted with EZPay set to 'false', even if the EZPay component is included in the CMS presentation. (Note: Including the EZPay component in the presentation when 'EZPay not required' is selected in the offer level is considered an incorrect setup.)
EZPAY Optional selected in the SolCon offer:
If the EZPAY component is not included in the presentation, new starts will be submitted with EZPay set to 'false'.
If the EZPAY component is included:
If the Auto pay checkbox is checked by the end-user: EZPay is submitted as 'true'.
If the Auto pay checkbox is not checked by the end-user: EZPay is submitted as 'false'.
If the checkbox display is disabled on the UI for an optional EZPay: This is a setup issue.
This update ensures accurate submission of the EZPay data based on the SolCon offer-level configuration.
Redeployed the deprecated /DigitalAccess endpoint
The /DigitalAccess (POST) endpoint was deprecated in Subscribe version 3.17 as part of a major API refactoring. However, to ease the migration, this endpoint has been made available again.
Bug Fixes
InApp subscribers not getting website access
Users who successfully purchased subscriptions via In-App Apple Pay and were created in Subscribe did not gain access to the website. This issue was due to the large download_id sent by Apple Pay, which led to incomplete user details being recorded in Subscribe and thus preventing website access.
This issue has been resolved. After the fix, the details of successful In-app Apple Pay subscriptions are now updated correctly in Subscribe, ensuring that subscribers now have valid access to websites as per their subscriptions.
This fix is also merged into the 3.16.3.15 and 3.17.0.4 releases.
Instant access issue when restarting a subscription
When a stopped subscription was restarted from the Subscription Panel, users did not receive instant access to the subscribed site. Additionally, a different account number appeared in internal records for the restarted subscription, though it was corrected to the original account number after the nightly sync process.
These issues have been resolved. After the fix, restarting a stopped subscription now grants users instant access to the news site as per their purchased subscription.
This fix is also merged into the 3.17.0.4 release.
Custom CSS class not set for the CMS link
Previously, it was not possible to set a Custom CSS Class in the CMS for the SS footer link. This issue has now been resolved, and users can successfully assign a CSS class to the SS footer link in the CMS. This fix is applicable for both Horizontal and Vertical DisplayType.
This fix is also merged into the 3.17.0.4 & 3.17.2.1 releases.
UI label Misalignment in the Dashboard
The misalignment issue of week-day labels with checkbox icons in the Subscription menu and Billing menu label values has been resolved. After the fix, checkboxes are now center-aligned below the week-day labels, and the Billing menu label values are right-aligned. This update ensures a cleaner and more structured display of the Subscription and Billing menus on the SS dashboard.
This fix is also merged into the 3.17.0.4 & 3.17.2.1 releases.
OneTrust Modal not opening in the footer link
The issue where the OneTrust Modal did not open upon clicking the Self Service (SS) Dashboard footer link has been resolved. After the fix, clicking the SS Dashboard footer link now correctly opens the OneTrust modal on the same page without refreshing the screen.
This fix is also merged into the 3.17.0.4 & 3.17.2.1 releases.
Incorrect Trial End Date displayed in Trial Banners
Previously, instead of the trial end date, the subscription expiration date was incorrectly displayed on the trial banners in Self Service and SubCon Admin. This issue has now been resolved.
After the fix, for a trial subscription:
If the trial end date is null, a static message will be displayed:
Self Service:"This is a Trial Subscription. The trial end date will be updated soon."
SubCon Admin:"This is a Trial Subscription. The customer will be charged if the subscription is not canceled before the trial period expires. The trial end date is currently not available."
If the trial end date exists (not null):
Self Service: The message configured in CMS will be displayed along with the trial end date:
"This is a Trial Subscription that will end on <Trial end date>."
SubCon Admin: A static message will be displayed with the trial end date:
"This is a Trial Subscription ending on <Trial end date>. The customer will be charged if the subscription is not canceled before the trial period expiration."
This fix is also merged into the release 3.17.2.1.
Issue with Cache Refreshing
When refreshing the CMS cache using the “Refresh CMS + Site” button, not all cache servers were being refreshed. This issue has been fixed now.
This fix is also merged into the 3.17.0.4 & 3.17.2.1 releases.
Issue with the Restart page
The Restart page freezing issue—where the page became unresponsive, preventing user interaction, and eventually timing out with an error—has been resolved.
Omission of Grace Amount in One-time payment flows
The issue where the grace amount (a negative balance which is due to the publisher) was omitted from the Rate Table and the total amount calculation during One-time payments has now been resolved.
After the fix, when a user opts for a One-time payment, and if a grace amount exists:
It will be displayed separately below the Rate Table.
It will be included in the total amount calculation.
The field label for the grace amount can be configured in CMS via:
Content > Payment (Filter by page) > ‘DebtAmountLabelText’.
This fix is also merged into the releases 3.17.0.5 & 3.17.2.1.
Applications Covered:
Subscription Panel, Self Service, CMS, API
The release notes for the internal stakeholders that include Refactors & Tech Upgrades can be found in (access required)
Please note that the minor release will include all the 3.16.1.X hotfixes. The hotfixes documentation can be found in the
Trial-with-Payment allows end-users to try the subscription for free before they decide whether they are going to purchase it. If users don't want to continue they will be able to cancel anytime before the renewal.
Please note that for now only digital subscriptions are supported. Print/hybrid are on the way.
Please note that for correct work we recommend applying 3.16.2.1 HotfixThe minimum NCS Circ version is 2020-4.0 (release notes can be found )
Please check our for more details
The minimum NCS Circ version is
If you were previously using Comp subscriptions then for correct work please ensure that your existing comp offers include the reason code and delivery method. Naviga implementation can provide you with a SQL script to update existing Comp offers
Please check our for more info about the feature
The new 'Show active users' filter is added to the Landing application. This filter check works in accordance with the search criteria specified by the user in the search box, hence only the data that matches the active filter check & search text is displayed.
During export, the user is able to choose if they want to export all the data or only the selected rows.
More info about the Landing app can be found .
When Subscription Panel sends PromotionCode as part of the request to PurchaseAPI (), the Promotion Information is now being stored in the event logs.
When a user hits the ‘Login’ button, the Self-Service portal will direct the user to the Sign-in page. Similarly, clicking the 'Register' button will still direct the user to the Sign-up page, as before. For those interested in learning more about the advantages of this new login experience, you may find additional information here:
The fix was also merged to 2.39.0.1 and
During the creation of a new Occupant or updating an Occupant without any phone, the collected phone is saved as a Primary phone. If a new phone is collected for the same Occupant (based on Email + FirstName + LastName + AddressID) then it is saved as Other. Please check documentation for details
Note added Jul 5th 2022
For the information about Landing app please check our
Note added Jul 5th 2022
In previous releases we expected some problems with retrieving rates for permanently stopped or inactive subscriptions. Starting from the 3.16.0 Release we're starting to consume new stable MicroAPI solution. More info about Restarts can be found
Database occupant lookup was replaced by real-time occupant lookup in NCS circ as a part of async flow during the New Start. There are two types of lookup: standard and email only (default one). For more details please see the .
Note added Jul 5th 2022
All flavours of new starts are now supported for DSI circulation system in PurchaseAPI. More information can be found in our public documentation about and
Please note that starting from this Release the Trial subscription functionality was renamed to Comp
Upgrade subscription to a Print/Hybrid product is now supported for those subscriptions without billing address. Delivery schedule update (i.e. Upgrade) and Billing/Delivery address update are processed in one API call. More information can be found in and
Please note that due to the critical issues found we can not guarantee this feature working correctly. We recommend waiting for the next version.Note added Jul 5th 2022
Upgrade/downgrade from ezpay to non ezpay offer and vice versa is now supported. More information can be found in and
Please note that due to the critical issues found we can not guarantee this feature working correctly. We recommend waiting for the next version.Note added Jul 5th 2022
Additional validation added to the Offer Group: Offer Group is not allowed to have more than One Base product. Please find more information about Offer Group creation in
To keep our applications consistent for all the circ systems Trial checkbox and Trial payment method were renamed to Comp. Please find more details about setup in our
GooglePay payment method is now supported for Braintree payment processor under NCS Circ. More information can be found in our
PayPal payment option is now supported for ZIP only subscription purchase during the frictionless checkout flow. For more information please see our public documentation about and
Please find more details in our and documentation.
Note updated on July 6th, 2023
Upgrade/downgrade from ezpay to non ezpay offer and vice versa is now supported. More information can be found in
The release notes for the internal stakeholders can be found in (access required)
Please note that the minor release will include all the hotfixes. The hotfixes documentation can be found at
in CMS please create the new and set the login URL at the attribute value.
Users can and handle the .
Complaints are now supported for paused (status P) subscriptions or subscriptions on vacation (status V). The feature is available both for One CSR Portal and Account management. More info about Complaint functionality can be found . The client can decide(by publication) to expose or hide the complaint option.
For more details about the feature, please refer to Auth0 Email Verification documentation: .
Initial Authorization: Upon the user's first click on the payment button , payment details are authorized.
Feature Name
Description
Feature Name
Description
Feature Name
Description
Feature Name
Description
Circ System & Version
Payment Provider
Feature Name
Description
Circ System & Version
Payment Provider
Feature Name
Description
Feature Name
Description
Fix
Description
Notes
Feature Name
Description
Fix
Description
Notes
Feature Name
Description
Feature Name
Description
Circ System & Version
Payment Provider
Feature Name
Description
Circ System & Version
Payment Provider
Fix
Description
Notes
Feature Name
Description
Circ System & Version
Payment Provider
Feature Name
Description
Circ System & Version
Payment Provider
Feature Name
Description
Circ System & Version
Payment Provider
Feature Name
Description
Circ System & Version
Payment Provider
Feature Name
Description
Circ System & Version
Payment Provider
Fix
Description
Notes
New Feature or Enhancement
Description
New Feature or Enhancement
Description
When a user hits the ‘Login’ button, the Self-Service portal will direct the user to the Sign-in page. Similarly, clicking the 'Register' button will still direct the user to the Sign-up page, as before. For those interested in learning more about the advantages of this new login experience, you may find additional information here:
The release notes for the internal stakeholders can be found in (access required).
Seamless Flow updated for Credit Card Edgil Payment Method
Added on 13-Oct-2023
In the seamless flow, if the Independent Address component for the payment page has been enabled, users could purchase or subscribe to a subscription with a single click after entering their credit card information. The issue occurs when the credit card details have been validated, the Submit button disappears, and the user is taken directly to the payment options, even if the fields, First and Last names, Phone, and Zip Code, have not been filled. This resulted in the AddSubscription call being triggered with incomplete information, and since the Submit iframe button is from a third-party payment site, it does not validate whether the aforementioned fields have been filled, resulting in no error warnings being displayed.
Changes have been made to allow the submission of incomplete fields if the credit card has already been validated in the seamless flow by introducing a delay time after each keystroke while filling the fields under the independent address component.
A key, "SeamlessInputDelayTime", must be added to the SP Config file with any numerical value. The value indicates the delay time in milliseconds, with the default value set at 1500 milliseconds (1.5 seconds).
For example, after entering the first name, it will wait 1.5 seconds and then call AddSubscription if no additional keystrokes have been detected. When the user starts entering the following fields, such as Last name, phone number, and zip code, the timer is reset after each keystroke, and the AddSubscription call is triggered only after a 1.5-second delay.
Note: This fix was also merged to 3.16.0.14, 3.16.1.9, 3.16.3.1, 3.15.2.4, 3.16.2.5
Seamless Flow updated for Credit Card Edgil Payment Method
Previously, when purchasing a subscription with a Credit Card, if the Independent Address component had been enabled for the payment page of seamless flow, users would have had to go through two-step purchase verification before they could complete the transaction.
Changes have now been made so that users can now purchase or subscribe to a subscription with a single click after entering their credit card details if the Independent Address component for the payment page has been enabled for seamless flow.
Transport Layer Security (TLS) Upgrade to Version 1.2
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket. Note was updated on June 12th, 2023.
PurchaseAPI now covers User validation and Syns steps
In case registrationID is provided then PurchaseAPI can use user email to support SSOR
N/A
N/A
Security improvements
Security improvements including password security and roles&permissions security
N/A
N/A
Seamless Flow updated for Credit Card Edgil Payment Method
Added on 13-Oct-2023
In the seamless flow, if the Independent Address component for the payment page has been enabled, users could purchase or subscribe to a subscription with a single click after entering their credit card information. The issue occurs when the credit card details have been validated, the Submit button disappears, and the user is taken directly to the payment options, even if the fields, First and Last names, Phone, and Zip Code, have not been filled. This resulted in the AddSubscription call being triggered with incomplete information, and since the Submit iframe button is from a third-party payment site, it does not validate whether the aforementioned fields have been filled, resulting in no error warnings being displayed.
Changes have been made to allow the submission of incomplete fields if the credit card has already been validated in the seamless flow by introducing a delay time after each keystroke while filling the fields under the independent address component.
A key, "SeamlessInputDelayTime", must be added to the SP Config file with any numerical value. The value indicates the delay time in milliseconds, with the default value set at 1500 milliseconds (1.5 seconds).
For example, after entering the first name, it will wait 1.5 seconds and then call AddSubscription if no additional keystrokes have been detected. When the user starts entering the following fields, such as Last name, phone number, and zip code, the timer is reset after each keystroke, and the AddSubscription call is triggered only after a 1.5-second delay.
Note: This fix was also merged to 3.16.0.14, 3.16.1.9, 3.16.3.1, 3.15.3.5, 3.16.2.5
New editable CMS Content
The following fields can now be edited via the CMS application:
/address:
Address.NoPendingMovesText
DeliveryAddressLabel
EditButton
SubmitButton
CancelButton
/autopay/manage:PaymentMethod.Title
Removed Hardcoded “Not available” text
Banner:
NavBar.WelcomeMessage
NavBar.AccountMessage
/complaint:
ProductFrequency.ProductHeader
Placeholder text removed
/dashboard:
SubscriptionPanel.AccountLabel
/ebill/invoices:
EBillInvoice.NoInvoicesText
/feedback:
Placeholders for “Select a feedback category” and “Comments” have been removed
/payment:
ButtonGoDashboard
ButonPrint
/subscription/cancel:
Placeholder removed
/subscription/share:
SubscriptionShare.RemainingInvitationsText
SubscriptionShare.NoPendingInvitationsText
/temporaryStop:
TemporaryStopForm.NoVacationsText
Failed Credit Card payments from Apple devices
Details added on August 21st, 2023.
Apple payments made using credit cards were experiencing failures, causing error messages to appear for customers. The payments initiated from Subscription Panel using Apple Credit card with Apple Pay payment method were also failing.
Resolution:
These issues have now been resolved by adding a new API setting key which defaults the ECI parameter value to 5.
Introduced a new MG2Control API Setting Key Edgil.SecureElectronicCommerceTransactionECI
For any client, the default value of the key is set as 5 at the root level. The ECI parameter is otherwise received from Apple Pay.
Seamless Flow updated for Credit Card Edgil Payment Method
Previously, when purchasing a subscription with a Credit Card, if the independent address component had been enabled for the payment page of seamless flow, users would have had to go through two-step purchase verification before they could complete the transaction.
Changes have now been made so that users can now purchase or subscribe to a subscription with a single click after entering their credit card details if the independent address component for the payment page has been enabled for seamless flow.
Failed Credit Card payments from Apple devices
Details added on August 21st, 2023.
Apple payments made using credit cards were experiencing failures, causing error messages to appear for customers. The payments initiated from Subscription Panel using Apple Credit card with Apple Pay payment method were also failing.
Resolution:
These issues have now been resolved by adding a new API setting key which defaults the ECI parameter value to 5.
Introduced a new MG2Control API Setting Key Edgil.SecureElectronicCommerceTransactionECI
For any client, the default value of the key is set as 5 at the root level. The ECI parameter is otherwise received from Apple Pay.
Transport Layer Security (TLS) Upgrade to Version 1.2
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket. Note was updated on June 12th, 2023.
Gigya Auth System Integration
All accounts logged in with Gigya are reflected correctly in SubCon Admin (One CSR Portal). All the actions with the accounts are supported (e.g Search, Change password, Occupant data update, add owner/guest and reporting)
N/A
N/A
Peach Payment Integration
Payments are now supported with PeachPayments.
Matrix - 38.0.34
N/A
Failed Credit Card payments from Apple devices
Details added on August 21st, 2023.
Apple payments made using credit cards were experiencing failures, causing error messages to appear for customers. The payments initiated from Subscription Panel using Apple Credit card with Apple Pay payment method were also failing.
Resolution:
These issues have now been resolved by adding a new API setting key which defaults the ECI parameter value to 5.
Introduced a new MG2Control API Setting Key Edgil.SecureElectronicCommerceTransactionECI
For any client, the default value of the key is set as 5 at the root level. The ECI parameter is otherwise received from Apple Pay.
Newzware - New Endpoints
In order to not affect every client that is using the /Authenticate and /DigitalAccess/Token endpoints and considering that a very custom solution was developed for an existing customer, a new set of endpoints have been created: /Newzware/Authenticate and /Newzware/DigitalAccess
N/A
N/A
Stripe Payment Integration
Stripe Payment provider is now supported in Subscription Panel, SubCon Admin (One CSR Portal) and SubCon Site (Account Mgmt)
Matrix - 38.0.34
N/A
Failed Credit Card payments from Apple devices
Details added on August 21st, 2023.
Apple payments made using credit cards were experiencing failures, causing error messages to appear for customers. The payments initiated from Subscription Panel using Apple Credit card with Apple Pay payment method were also failing.
Resolution:
These issues have now been resolved by adding a new API setting key which defaults the ECI parameter value to 5.
Introduced a new MG2Control API Setting Key Edgil.SecureElectronicCommerceTransactionECI
For any client, the default value of the key is set as 5 at the root level. The ECI parameter is otherwise received from Apple Pay.
New Feature or Enhancement
Description
Permanent stop for NCS Circ
Along with canceling a subscription in real-time, scheduled cancellations can now be edited/deleted in real-time w/ NCS Circ on one CSR portal.
A minimum of NCS Circ 2018.5 is required.
Permanent stop for Circ Pro
Circ Pro users can now make permanent stops in real-time on the CSR Portal.
Temporary stops for Circ Pro
Circ Pro users can now make temporary stops in real-time with self-service portal.
Upgrades/downgrades for Circ Pro
Circ Pro users can now use the upgrade/downgrades functionality
(real-time) on the CSR Portal.
Link Subscription refactor
Naviga subscribe has refactored its account linking endpoints to improve performance across its product suite. Two new endpoints were added:
POST OwnerUser
POST GuestUser (to link a guest)
This helps to optimize the linking process internally.
Description
Jira Number
HotFix#
Subscribe Version
Extract Update needed?
Fixed the issue of missing data in the extracts when input file is used for extract's selection criteria. Also, the extracts for carrier, carrierdistribpoint, routedraw and routesubscription are moved from SubCon files to Discovery files.
CM2-2140
CM#1350
Latest Subscribe/NCS Extracts
Yes
Modified the Demographics setup to allow to update Audience Category for each answer type. Added a new demographics extract for Subscribe which will have the demographics having DemographicType Subscription and AudienceCategory Subscribe.
CM2-3551/CM2-3552
CM#1930
"Latest Subscribe/NCS Extracts Needed to support Trials in Subscribe (3.13) "
Yes
Resolved the missing rate terms issue in rate_codes extract. And added 2 more fields start_date and end_date in rate_codes extract.
CM2-3560
CM#1920
"Latest Subscribe/NCS Extracts "
Yes
Fixed the issue of files not getting generated with data in batch mode. Also, debugging messages are put in the utility to log or track the errors.
CM2-3096
CM#1760
"Latest Subscribe/NCS Extracts "
Yes
Modified to fix the Performance issue of autorenew extract and send the most recent AutoRenew Subscription against subscription in SubCon autorenew extract instead of sending all the AutoRenewSubscriptions.
CM2-2815
CM#1620
"Latest Subscribe/NCS Extracts "
Yes
Moved the extract "future trans full" from Discovery to SubCon files. And now RateCodes will be sent in th rate_codes extract irrespective of association of the RateRuleLink with the RateCode.
CM2-2630
CM#1510
"Latest Subscribe/NCS Extracts "
Yes
Added 7 new fields in SubCon submaster extract for EditionID of the publication for each week day.
CM2-2688
CM#1590
"Latest Subscribe/NCS Extracts "
Yes
Description
Jira Number
HotFix#
Subscribe Version
Extract Update needed?
Added a new naviga API i.e. getsolicitationdetail to send the solicitations of the Subscriber to Subscribe.
CM2-2080
CM#1360
3.10
No
Created a new Naviga API to update and add the solicitation for an occupant in NCS Circ Customer Service as per the request sent by Subscribe
CM2-2081
CM#1380
3.10
No
Modified the API to correct the Total Charge Amount
CM2-2245
CM-1430
3.10
No
Fixed the issue of not getting generic donation codes in getdonationdetail API which are applicable to all products. And also fixed the wrong startdate error message when startdate passed is invalid in getpayment-detail API
CM2-2647
CM#1560
3.11
No
GetDonationDetail API modified to send only active codes and removed check of GLAaccount DonationType to send all type of donation codes and added EnterOnWeb flag in response
CM2-2750
CM#1610
3.11
No
Returned only active RateCodes where valid and active Source, Reason and Delivery Schedule is set in rule. Returned comma seperated list of Source, Reason, Delivery Method and Delivery Schedule when * is selected in rule
CM2-2771
CM#1630
3.10, Needed for Solicitor code look up)
No
New API created for adding Delivery Schedule Change transaction
CM2-3213
CM#1810
3.13
No
Description
Jira Number
HotFix#
Subscribe Version
Extract Update needed?
Modified to not update ReasonCode when Stop Reason is not provided in request (permstop)
CM2-2610
HM#160
3.10, NCS Circ patch needed to support cancel in real time
No
Through this change, if a subscriber who is in Grace requests to perm stop the subscription in the next billing cycle then perm stop date will be the maximum of current publishing date and the expiry date of the subscription. (permstop)
CM2-2881
HM#170
3.10, NCS Circ patch needed to support cancel in real time
No
Through this change, if a subscriber who is in Grace requests to perm stop the subscription with stop date as next billing cycle then perm stop date will be maximum of current publishing date and expiry date of subscription (permstop)
CM2-2881
HM#190
3.10, NCS Circ patch needed to support cancel in real time
No
Resolved issue where next publishing date is used to start subscription without considering delivery schedule days and holidays. (Create Subscription and Create Subscription by Campaign)
CM2-2011
HM#210
3.10, Campaign Starts
No
Modified to set next publishing date as the permstop date for In Grace Subscriptions on the basis of cut-off date instead of Today/System Current date. (permstop)
CM2-2881
HM#200
3.10, NCS Circ patch needed to support cancel in real time.
No
Corrected the values of TotalTaxAmount and TotalTaxPercent. Now, these fields will include City/County/State/Country tax amounts only when they are non-exempt. (gettax)
CM2-3214
HM#180
Release 3.10, NSC Circ TAX
No
Description
Jira Number
HotFix#
Subscribe Version
Extract Update needed?
New endpoint developed for invoking cti api from Circulaton API
CM2-3476
HM#240
3.13, Redirect from one CSR portal to NCS Cirl CSR portal
No
New cancel subscription rules for Subscribe’s self service
Option 1: Allows cancel for all subscriptions irrespective of the location (Billing State) of the subscriber or subscription type (print, digital or hybrid) on self-service portal.
Option 2: Allows cancel subscription based on the State location, Start Source, StartDate and Subscription type of the subscription on self-service portal.
For all clients using option 2 the default settings are as follows:
• Billing State is CA • Start source is blank (means include all)
• StartDate is NULL (means date validation is not in place)
• SubscriptionType is NULL (means it applies to all subscription types)
Eg: 1
• Billing State is CA
• Start source in (INTERNET, INTERNT1, INTERNT2, INTERNT3, INTERNT4, INTERNT5 )
• StartDate >= 07-01-2018
• SubscriptionType is Digital (i.e. Base product is digital and not print)
Eg: 2
• Billing State in CA, NY
• Start source is bank (means includes all)
• StartDate is NULL (means date validation is not in place)
• SubscriptionType is NULL (means it applies to all subscription types)
Note: Until now only CA subscribers were allowed to cancel subscription, but recently there's was a new law to enable NY subscribers to allow cancellation as well.
Active subscription check refactoring
The following Solicitor Concierge flags have been refactored, which drives determining an active subscription at a specified address logic in Subscribe during the new start flow.
No existing subscription at address: If this flag is turned on Subscribe evaluates if an active subscription for the product exists at the specified address, if an active subscription is found then an error is displayed. If turned off this check is skipped, and the user can purchase a subscription though there’s an active subscription found.
No outstanding balance: If this flag is turned on Subscribe checks if there’s a recently stopped subscription with an outstanding balance > 0. If the flag is turned off, then this check is skipped and lets the user purchase a subscription though they owe a balance.
No subscription stopped last X days: If this flag is turned on Subscribe checks if there’s a recently stopped subscription within the last “X” days where X (default value is 30) is configurable in Subscribe database. If the flag is turned off, then this check is skipped and lets the user purchase a new subscription though they have a stopped subscription in the last few days.
Note: This feature is also available in 2.X version.
One-time promotion codes
The one-time promotion codes feature allows clients to run marketing campaigns that require unique promotional codes which can be used only once. One-time use codes are generated in Subscribe’s solicitor concierge application; offers can be presented to customers based on them. The codes reside in Subscribe and is independent from any circulation system. As soon as a customer consumes a code it will be deactivated in Subscribe and cannot be used any further.
CyberSource CVV validation
With our continual effort to prevent CC fraud attack we have introduced additional security measure of validating the CVV in our CyberSource payment gateway integration. CyberSource has released a new version of their Flex Microform that includes a CVV field which will be validated in Subscribe.
Instant digital access upon paying a balance during restart workflow
The restart flow has been enhanced so that a subscriber who pays an outstanding balance is given instant digital access. The Subscription Household level will be updated in Subscribe db during the workflow to accomplish to this.
Transactional email performance enhancement
The transactional email event processing logic has been optimized to reduce the overall time spent in transactional email events. Thus, enhancing the transactional email event processing performance for faster email triggering.
HouseHold Level update on syncing from Circ System
It was discovered that subscriptions that were received in the nightly extracts might be stopped but the subscription can get activated later in the day on the circulation system end. In these scenarios if the user logs into Subscribe’sself-service after the fact, Subscribe synchronizes the subscription status by calling Get Subscription by ID. However, until now the subscriber was not able to access content because the HouseHoldLevel(HHL) was not being updated in Subscribe. In release 3.10 we’ve enhanced Subscribe’s logic to update HHL when GetSubscriptionby ID iscalled to make sure subscriber can access content uninterruptedly
Saxo circ Integrations
For the CSR Portal:
Billing and delivery address update in real time - This feature provides CSR’s the ability to update billing and/or delivery address on an account in real-time in Saxo circ. This is available on the Moves tab of the CSR portal.
Paperless billing in real time - This feature provides CSR’s the ability to sign up a non-auto renew subscriber to paperless billing in real time in Saxo circ. It also allows a CSR to cancel paperless billing in real-time. This is available on the Payment/Billing tab of the CSR portal.
Switch to invoice payment in real time - This feature provides CSR’s the ability to switch an account from auto renew to invoice payment in real-time in Saxo circ. This is available on the Payment/Billing tab of the CSR portal.
EZ Pay - One time donation
Starting release 3.10, subscribe supports accepting one time donation during ezpay workflow. To accomplish this payment cc event (30) was introduced where in the one time donation amount is posted to NCS.
2018.5 Service Pack 2
NCS Circ: Closed
Subscribe: Active (Version 3.13.1)
Application Area
Description
Jira Number
HotFix#
Subscribe Version
Circ API
Support one time tip for auto renew subscriptions in Subscribe platform
CM2-4439
HM42#250
3.13
MicroService API
After the modification , now the API of GetVacationdetail shows the stop Type for Current , Future Vacations and Perm Stops
CM2-4445
CM#2050
3.13.1
MicroService API
Added the Bankdraft type of payment details and Bank Account Number in GetPaymentDetail API
CM2-3676
CM-2020
3.13.1
MicroService API
Added the ability to update billing address for no address starts (digital)
CM2-3208
HM#260
3.13.1
2020.2.2 Version
NCS Circ: Closed October 2021, available on live servers
All the items refer to MicroAPI
Description
Jira Number
Hotfix
MG2 MicroAPI: Create a new microAPI to have an address update and delivery schedule update in one go.
CM2-6037
CM43#1750
MG2: Update Vacation: Once the temp starts processed, it doesn’t allow us to change the tempAddressEnd date
CM2-5366
Unable to get restart rates for inactive subscriptions
CM2-6105
HM43#270
2018.5 Service Pack 4
NCS Circ: Active
Application Area
Description
Jira Number / HotFix#
Subscribe Version
Micro API
Create a new microAPI to have an address update and delivery schedule update in one go
Add or update a recurring tip and/or add a one-time tip
CM2-4439
hm42#250, hm43#160
MG2 Redeem Gift: MoveIn Transaction is not getting processed. Getting error "Route publication record does not exist for publication VCP, route
CM2-3208
HM42#260, HM43#110
Taxes not calculating
CM2-4971
HM42#280, HM42#290
Gettax API - modify find to not require county
CM2-5072
HM42#300
Description
Jira#
HotFix#
Subscribe version
Gannett Rating Issues - CS API not returning proper terms
CM2-5001
cmo42#490, cmo43#280
3.13
Description
Jira#
HotFix#
Subscribe version
AutoRenew should be handled through Paypal OLD PAS independent of NavigaPay BR
CM2-5660
CM43#1470
2020.3.0 Version
NCS Circ: Out, Closed Dec 2021
Description
Jira#
HotFix#
Subscribe version
Complaint code with ValidWhen = Always not honored in CS API
CM2-5861
CMO43#360
Description
Jira#
HotFix#
Subscribe version
Recurring tip for auto-renew subscription
CM2-4572
cm43-#800, cmo43-#250 (compile only), hm43- 170
MG2: Circ API - GCI Rounding up donation codes adding 3 more adjustment codes/amounts
CM2-5516
HM43#250, CMO43#350, CM43#1620
Description
Jira#
HotFix#
Subscribe version
MG2 API: Payment Profile - GET a Payment Profile
CM2-4526
CM43#850
MG2 API: Payment Profile - ADD a Payment Profile
CM2-4523
CM43#860, CMO#270
MG2 API: Payment Profile - DELETE a Payment Profile
CM2-4524
CM43#870
MG2: Update Vacation: Once the temp starts processed, it doesn’t allow us to change the tempAddressEnd date
CM2-5366
MG2 API: AddPaymentProfile is not throwing error when CCExpireDate is in past
CM2-5011
CM43#1610
MG2 MicroAPI: Create a new microAPI to have an address update and delivery schedule update in one go
CM2-6037
Description
Jira#
HotFix#
Subscribe version
Temp Stop Tran can be Modified to Vacation Pack = Yes if the transaction is Modified when the Reason Code does not allow Vac Pack
CM2-5558
CM43#1630
2020.4.0 Version
This page has access to 2020.4.0 version Issues for NCS Circ.
2020.4.0 Version - Resolved Issues
Resolved Issues
NCS Circ Maintenance Release Issue
Description(Cust.Service)
JIRA#
HotFix#
Subscribe Version
Customer Service:
Session Context Errors that occurred while launching a new customer service session to update a subscriber’s opt-in or opt-out of E-Bill using the BillingChg transaction and then modifying the Renewal Delivery Override information have been resolved.
CM2-7411
CM43#2550
Customer Service:
Transaction processing for MoveIn and MoveOut transactions is now running successfully for accounts that were on a combo subscription previously.
CM2-7236
CM43#2400
Customer Service:
Creating a Temp Stop transaction with the “SendEmailConfirmation” checkbox selected in Customer Services will no longer result in any debug warnings.
CM2-2953
CM43#2980
Customer Service:
The calculation for extending days by applying the incorrect adjustment amount in complaints has been corrected now in
CM2-8249
CM43#3660
Customer Service:
The issue where an incorrect CopyRateByDay is calculated for subscribers on a Rate Code with the Rate Terms in month, year, or quarter and if the payment includes a Wallet Amount has been fixed.
CM2-8787
CM43#3760, CM43#3790
Accounting:
A fix in the validation of the Bank Draft program has been made to accept Bank IDs that use the HSBC file format.
CM2-9086
CM43#4080
Tools:
The verbiage in the Remarks field on BillingChange transactions is now dynamic and will populate information based on the UpdateCode that is provided in the file.
If UpdateCode is 1, then Remarks will be “TokenAccountUpdater-NewCCExpire”
If UpdateCode is 2, then Remarks will be “TokenAccountUpdater-NewCCNumberandExpireDate”
If UpdateCode is 3, then Remarks will be “TokenAccountUpdater-AccountClosed”
An error will be thrown for any other UpdateCode or for leaving it blank.
CM2-6522
CM43#2280
Conversions:
Added the subscription payment tip and adjustment amounts, also Modified the settings of the Temp Stop/Restart Date based upon subscriber status and the Account export to account for non-delivery account. The updated information has been exported to the Subscription and Account export files.
CM2-7873, CM2-8263
CM43#3000,CM43#3510
Conversions:
The performance of Demographic Edits to run 130k records has been optimized now.
CM2-8223
CM43#3450
Description
JIRA#
HotFix#
Subscribe Version
Carrier Mail Export now exports all messages to the carriers/routes when utilizing the multiple delivery address feature or the mapping feature, which allows a subscription to be delivered by multiple routes.
CM2-1274
CM43#3640
The 1099 Audit Report, in Reporting > Account > 1099Audit, has been modified to reflect the changes made to the 1099 IRS form, and it now produces data for all three form types in a single report (Misc., NEC, and Interest)
CM2-7381
CM43#2470
Vindicia GetPayments now creates payments with the correct rate code for both AutoPay and normal Subscribers.
CM2-5597
CM43#2950
Subscribe Extract now exports all addresses and will display them in the Address Master even if the subscriber’s Route Publication record is end-dated.
CM2-7663
CM43#3100
Description
JIRA#
HotFix#
Subscribe Version
A fix program has been created to update the Zip Code and Zip Pattern fields of the Country table used in the Subscription Link.
CM2-8093
CM43#3290
Description
JIRA#
HotFix#
Subscribe Version
Modified MicroAPI, “GetRates” to return the valid Rate Codes.
CM2-6523
CM43#2590
Any billing changes transactions initiated from CircAPI with a transaction date before the Subscription’s Start Date, it will now be created only at the Subscription Start Date.
CM2-6453
HM43#340
Description
JIRA#
HotFix#
Subscribe Version
A fix program has been created to add PayTrace and other recently added vendors to the Add-On Table, such as Bambora and Stripe.
Setting the business rule— IfusingDTIPaymentAuthorization, whichthirdpartypaymentauthorizationproductintegrationisused? to newly added vendors such as Paytrace, Bambora, and Stripe will no longer make the Addon check fail.
CM2-7746
CM43#2760, CM43#3780
The Lock-Table overflow error caused by payment refunds of declined cards for Digital Address Subscribers has been fixed, and subscriber refunds are now processed in a separate batch.
CM2-7871
CM43#3020
A set of new decline response codes returned by Payway has been added to CM43 > Setup > System > PymtAuthMessages.
CM2-6577
CM43#2190
When a credit card payment is initiated using Edgil as the payment vendor, the NavigaPay I-frame window now shows the right information, and the payment is processed successfully.
CM2-8221
CMO43#510
Description
JIRA#
HotFix#
Subscribe Version
When creating a subscriber with Billing Method = “CarrierCollect,” the CircAPI threw an error message if no rate code/term/length details were provided.
To resolve this issue, the Customer Service Business Rule— “Shouldcarriercollectsubscriptionsbeassignedaratecode?” logic has been modified such that only if the value is set to “Yes,” then the rate code/term/length details are mandatory, and failure to provide them will result in an error stating “Novaluepassedforrequiredfield, Rate, Term, Lengthcombinationnotvalid.”
CM2-7490
HM43#520
Adjustment only payment through CircAPI is now buying the correct number of days and extending the Subscription Expiration date.
CM2-6448
CM43#2200,CM43#2310
Digital subscriptions can now be started in CircAPI, CreateSubscription, up to 7 days prior the Start Date of the email address.
CM2-7942
HM43#420
The issue with the “RequestedRefund?” checkbox being selected on the Customer Service screen when a PermStop is created using the CircAPI has been resolved by setting the checkbox to false by default.
CM2-8235
HM43#530
Code changes have been made to eliminate erroneous debug messages that were terminating the Circulation API calls.
CM2-8991
HM43#590
In the CreateSubscription API, the error "Invalid Rate Code" was shown since the Rate Code validation was performed against DeliveryMethod (Online/Mail/Route) instead of DeliveryType (Carrier/Motor/HomeDel). This issue has now been resolved.
Gigya is now integrated with Subscription Panel and SubconSite as an alternative authorization system. All the end-users logging-in with Gigya are supported in One CSR Portal
Subscribe: Account Management International address support
International Addresses are now supported in Account Management allowing users to enter City/Town, State/County, Zipcode/EirCode
One CSR Portal Complaint type
Now a complaint can be submitted via One CSR portal as of either formal or informal complaint type passing to NCS CIrc. Minimum NCS circ version required is 2018.5 + SP3
One CSR portal and Account Management Upgrade (Digital to Print)
Please note that this feature requires an additional fix from NCS Circ to be applied.
Upgrade ZIP-only digital to print is not supported until 3.15.0
Account Management Restarts refactor
New endpoint for Restarts has been created and is now used in Account Management and One CSR portal
Account Management Scheduled Move Grid refactor
'Old Address' column was removed from Scheduled Move Grid. so that Templates A and B now look consistent
Account Management ‘Billing’ section for Matrix clients
‘Billing’ section was added to Account Management Profile page for Matrix clients
New Feature or Enhancement
Description
Solicitor Data Import/Export
New Feature or Enhancement
Description
Account Management and One CSR portal Stop Saver
Account Management and One CSR portal One-time tip
One CSR portal Payment method type
Payment method type the subscription was purchased with e.g. ApplePay, GooglePay etc. is displayed on 'Payment' tab of One CSR Portal
SSOR registration for ApplePaysubscription purchase
For the Apple Pay in offer selector SSOR registration is now supported (used by Tribune). The minimum NCS Circ version required is 2020.2
Account Management Stop Delivery Date hidden
The opportunity to hide Stop date when scheduling a move is added to Self-Service application
New Feature or Enhancement
Description
One CSR portal Disclaimer management
One CSR Portal redirect to classic CSR portal
Account Management and One CSR portal upgrade and downgrade
Account Management and One CSR portal Update Occupant/Subscriber information
Account Management and One CSR portal Restarts
One CSR portal New search criteria
NCS Circ system stores alternate account number which is mostly associated to subscriptions during client’s databases consolidation and migration. This feature will allow CSR to look up an account with an alternate account number as well. Please note that the client should have the latest extracts with external_id field. This feature is important for those clients who migrate their databases.
Gifting
Comp Subscriptions
Apple Pay (via Payway)
One CSR Portal Matrix integration
One CSR Portal now has new functionality supported by Matrix circulation system such as arranging a temporary stop, cancel a subscription immediately or have a scheduled cancellation, submit complaints about a dissatisfactory delivery, update billing and delivery address.
Account Management and One CSR portal EZPay change
The Grace amount now is displayed outside the grid and only in case it’s >0
Active Subscription check refactor
Seamless theme updated
Step Header now supports gradient.
N/A
OneTrust script added
OneTrust tag at the checkout helps manage and maintain compliance with user consent laws
N/A
N/A
Display external billing logo on order summary
All
All
Populating billing info from GooglePay
This new feature automatically populates the billing adress including zipcode with the data linked to the card that has been used with the Google account.
All
All
Start from CSR Portal Enhancement
Newly created subscription is not opened in CSR Portal any more.
This enhancement has to be done due to using PurchaseAPI instead of old SubscriptionAPI.
All
All
ApplePay - Braintree starts
ApplePay payments are now supported in Braintree's payment processor.
NCS - 2020.2
Braintree
Zip Code filtering for Digital & Zip Only offers
All available upgrade, downgrade & stop saver digital only offers are returned for a subscription regardless of the zip code. To do that GetOffers API call has been modified to remove the zip code check
N/A
N/A
Upgrade/Downgrade feature for Matrix
Matrix - 38.0.34
N/A
Edit customerRegistrationID
N/A
N/A
Transaction History Table
Matrix - 38.0.34
Spreedly
End user session and logout when password reset is complete
If a user changes his password whilst having several sessions opened with the same login, all sessions that are not the one the password change has been done will be automatically logged out.
N/A
N/A
ApplePay - Braintree payment method
N/A
Braintree
Zip Only Offers - Mandatory Available areas
Selecting available areas for Digital and Zip Only offers is no longer mandatory.
N/A
N/A
Tags in import/export mechanism
Tag information will now be available in the json file when using the import/export offer feature in Solicitor Concierge. More information here.
N/A
N/A
Purchase API
PayPal support for Braintree payment processor
PayPal payments are now supported for Braintree payment processor.
There is no need for any special API configuration. The integration is transparent for the API, which is expecting to receive a Braintree Token just like with any other CC.
It's up to the Subscription Panel to use Braintree-PayPal library to generate that Token. The appropriate component must be included in presentation (PayPalBrainTreeV3) in CMS.
Note: Updated on 22nd July '22 - Addition of API explanation and CMS component.
Future transactions grid in One CSR Portal
At the bottom of the Account tab there is a grid where a CSR can see future transactions scheduled for this subscription like Upgrade/downgrade, Expire, End of Grace period, Permanent Stop, Temporary stop, Billing and/or Delivery address change. Above the tabs there is a clickable info message with short information about the future transaction. No specific setup is required. Minimum NCS version required is 2020.2.1 and extract version should be version 2
Subscription Payment method type in Account Management
Subscription payment method type like Apple Pay, Google Pay, Credit Card, Bank Draft, InApp, etc. is displayed at the Billing section of Dashboard and at the Update Payment Page. This feature can be turned on/off via MG2control setting.
Landing Application
The newly developed landing application allows the business user to access One CSR Portal, CMS and Solicitor Concierge dependent on the user permission from the single landing screen without having to log in each application separately.
Videos support in Account Management
Culture-specific formatting in Account Management and One CSR Portal
This feature allows to display date in a culture-specific format in Account Management and One CSR Portal. We support American formatting (MONTH-DAY-YEAR) and European (DAY-MONTH-YEAR) one. To use this feature you have to have the Culture populated in the Countries table in the database.
Product and Service type management in One CSR portal
Manual editing of Products and Service Types is deprecated and not available from One CSR Portal anymore. Please contact your implementation manager or data team directly to add/edit a Product or Service Type.
Update Occupant enhancements
Email validation was added. Now it’s not possible to use the email that already is used by another subscriber.
Subscription search enhancements in One CSR portal
Subscription search logic on One CSR portal was enhanced. Now if House Number is provided, then Street name and Zip Code should be required too. if ZIP code is provided then any other additional field should be required too. This logic is implemented in all places where we search subscriptions against address: subscription search on the main page, subscription search when adding registration
‘Forget password’ email for One CSR portal
This feature allows the CSR to send a ‘Forget password’ email by clicking a corresponding button on the Digital tab
Solicitor Concierge payment method enhancements
inApp payment methods are disabled for Smart offers as the Smart offers cannot be sold inApp.
Paypal circ payFlow payment method is deprecated - only PayPal and PayPal Express are left
Trial subscription payment method is deprecated for all the clients except those using DSI Circ
Comp subscription payment method is hidden for all clients
Solicitor Concierge Import/Export enhancement
When importing/exporting Products and Service type the complex unique key is replaced with ProductId and ServiceTypeId, respectively
Log out from all devices for Account Management
This is a security improvement for the end-users. When they log out from one device they automatically are logged out from on all their devices
ApplePay, GooglePay and PayPal support in frictionless checkout
ApplePay, GooglePay and PayPal payment methods are now supported in frictionless checkout for NCS/Payway
Purchase API for the new starts in CircPro
Please note that the introduction of synchronous and asynchronous events will result in two Account Numbers for a subscription purchased on Subscription Panel: the confirmation number is the temporary Account Number that wil be replaced then by a permanent one. The Account number was hidden from the Confirmation page as well as LTE receipts. The users will still get the Permanent Account Number in a confirmation email.
Account Management Update Occupant/Subscriber information for CircPro
Billing and Delivery address change for CircPro
Upgrade/Downgrade Subscriptions in Self Service Portal for CircPro
Zip Only Starts for CircPro
Registration data in Feedback page in Account Management
In order to meet security standards and not to disclosure the data that might not belong to the user (in case of Guest) we now prepopulate the fields at the Feedback page with the Registration data, not Subscription. Note added 17 Oct 2022
Subscribe: Feature management via API and APP settings
The audience of this feature is our development team. All features of One CSR Portal, Solicitor Concierge are now managed with APPsettings instead of code-config settings and APIsettings based tennants instead of Client based tennants.
New Starts with CampaignID (NCS)- improvements
Solicitor Concierge Audit Trail - improvements
The feature was initially introduced in Release 3.14.0. In the current release the section layout and search behavior was updated
PurchaseAPI - Braintree support for NCS
PurchaseAPI now supports Standart and Complimentary starts for NCS+Braintree
Permanent stop, temporary stop and vacation transfer in One CSR Portal (NCS) - improvements
Additional validation was added to One CSR Portal: temporary stop and/or vacation cannot overlap with any existing stop, no stop can be created after already scheduled permanent stop, after creating a permanent stop all the later stops should be deleted, all the overlapping temporary stop and/or vacation should be shortened to and at the date of the permanent stop.
New Feature or Enhancement
Description
Subscribe: PurchaseAPI and AddSubscription refactor
Please note that the introduction of synchronous and asynchronous events will result in two Account Numbers for a subscription purchased on Subscription Panel: the confirmation number is the temporary Account Number that will be replaced then by a permanent one. So starting from 3.14.2 the Account number was hidden from the Confirmation page as well as LTE receipts. The users will still get the Permanent Account Number in a confirmation email
Subscribe: Active check for ZIP-only start
Subscription Purchase with GooglePay for NCS Circ/Payway Clients
‘Single Day Pass’ starts
Frictionless checkout: ACH support
Frictionless checkout introduced in 3.14.0 now supports ACH payments.
No address for ZIP only starts for NCS clients
The address for ZIP only subscriptions is now shown as empty as by definition there is no billing and delivery address for such subscriptions
New Feature or Enhancement
Description
Account Management and One CSR portal Update Occupant/Subscriber information for Matrix
Comp Subscriptions for Matrix
Account Management and One CSR portal Upgrade and Downgrade for Matrix
3DS2 dual factor authentication payment flow for Matrix
3DS2 dual factor authentication payment flow was implemented for Matrix circulation system to meet the new European legislation requirements. Starting from July 1st 2021 an extra authentication step is required when submitting card details
New Feature or Enhancement
Description
Solicitor Data Import/Export refactor
Please note that you cannot import data exported from 3.14+ version to 3.13.1.1 and vice versa
Solicitor Concierge Published Offer Groups Editing
Solicitor Concierge Audit Trail
Marketing Price as plain text for ApplePay
To display Marketing Price correctly for ApplePay an additional field was added to the Offer model. This field stores the price from the Marketing Text field as plain text. Please pay attention that the HTML-formatting like paragraphs, bold, italic, list is not supported.
One CSR portal and Account Management Recurring tip
One CSR portal Attributes support in Disclaimers
Self-Service Late Route Message
Account Management and One CSR portal Real-time features Refactor
Subscribe APIs were refactored to add flexibility in consuming new NCS Circ real-time features. Now the real-time features like Stop Saver, Upgrade/Downgrade can be turned on independently, one by one.
New Starts with CampaignID
Frictionless check-out design for NCS Circ/Payway clients
Firefly License call refactor
2.X Releases
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Display the One Trust modal pop-up for the client in Self-Service Portal. Please note that the 2.X versions are not supported anymore. No enhancement and/or future releases are planned.
2.40
New Feature or Enhancement
Description
PurchaseAPI for Vindicia
Please note that the introduction of synchronous and asynchronous events will result in two Account Numbers for a subscription purchased on Subscription Panel: the confirmation number is the temporary Account Number that will be replaced then by a permanent one. So the Account number was hidden from the Confirmation page as well as LTE receipts. The users will still get the Permanent Account Number in a confirmation email
2.39.2.1
New Feature or Enhancement
Description
Display the One trust modal pop up for the client in Subscription Panel
The "Do Not Sell My Personal Information" link has been added to the footer section of client's Subscription Panel. When users click the link, a pop-up modal displays, allowing them to choose whether to opt out of the sale of personal information, and their preferences are stored once they click the Save Settings button.
Configuration Notes
The user can change the class by going to CMS > Subscription Panel > Presentation > Footer V3 > Link V3 > Class field.
Add class “ot-sdk-show-settings” to the “Do Not Sell My Personal Information” link in footer in CMS.
Add below in the config file under config.System in Subscription Panel.
SS - The script for OneTrust Modal same as that of SP
As per the client's request, starting from this release, SS has transitioned to using the same OneTrust script as SP. Both SS and SP will now use the same OneTrust ID.
2.39.1.1
New Feature or Enhancement
Description
API - New subscriber entitlement not being passed
Previously, when the user's information was requested through the Auth0 API for a subscription that used an Apple ID as its customer registration ID, an error message was displayed.
The Apple IDs include a special character (.), which caused the URL to be broken since the special character is not URL encoded, and the URL rejected the request due to the incorrect Path parameter.
The error has now been resolved by including a "/" at the end of the API request to indicate the Path parameter's limit.
SL - Increased the character limit of SolCon fields
The character limits validation of SolCon fields Code1-10 has been removed to support client-specific change. There will be no character limit restriction in SolCon UI.
2.39.1.0
CMS
New Feature or Enhancement
Description
Transport Layer Security (TLS) Upgrade to Version 1.2
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket. Note was updated on June 12th, 2023.
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
This fix was also merged to 2.39.1, 3.15.2.1, 3.15.3.1, 3.16.0.13, 3.16.1.7, 3.16.2.4, and 3.16.3.
2.39.1
New Feature or Enhancement
Description
Multi-currency support for Vindicia clients
Naviga Subscribe now supports non-US currencies for Vindicia clients. This allows clients to sell subscriptions in local currencies across the globe. The request was originally made by Simon and Schuster so customers could buy their language products in local currency. This is available for Vindicia clients and only in 2.X version.
Please contact Naviga Support if you have additional questions about this feature.
Add class name property in the Link section in CMS application
Date Updated: 11-Apr-23
Users can now add the class name input property to the Link V3 component in CMS to be used in the Subscription Panel's footer section.
Configuration Notes
The user can change the class by going to CMS > Subscription Panel > Presentation > Footer V3 > Link V3 > Class field.
Transport Layer Security (TLS) Upgrade to Version 1.2
Note: If the TLS version is not configured in the web.config file, CMS now uses the TLS 1.2 security protocol by default.
The CMS Content module has been updated to support Transport Layer Security (TLS) version 1.2. The TLS version can now also be configured from the web.config file, and image uploads can now communicate with the AWS S3 bucket using the TLS 1.2 security protocol.
This update has been made as Amazon will no longer support TLS 1.1 for its S3 bucket. Note was updated on June 12th, 2023.
Exposed Code fields in the Offers endpoint
Date added: 27-Jun-23
The Promotions/{promotionId}/Offers endpoint has been modified to add a new set of fields, Code 1 through Code 10. These parameters retrieve information about the codes that support the Offer Group, which can be consumed by the consumer application.
Note: The TLS version fix was also merged to 2.39.1.0, 3.15.2.1, 3.15.3.1, 3.16.0.13, 3.16.1.7, 3.16.2.4, and 3.16.3.
2.39.0.7
New Feature or Enhancement
Description
Remove Chatbot from the client’s Self-Service Portal
Date added: 10-Nov-23
Changes have now been made to remove client-specific Chatbot from the Self-Service Portal.
2.39.0.5
New Feature or Enhancement
Description
Display the One trust modal pop up for the client in Self-Service Portal
To adhere to the privacy laws, the "Do Not Sell or Share My Personal Information/Opt-Out" link has been added to the footer section of the client’s self-service portal. When users click the link, a pop-up modal displays, allowing them to choose whether to opt out of the sale of personal information, and their preferences can be set under "Manage Consent Preferences".
Updated on August 17, 2023
Landing Application User Guide
Allows the business users to access the Subscribe apps easier.
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
The newly developed landing application allows the business user to access One CSR Portal, CMS and Solicitor Concierge dependent on the user permission from the single landing screen without having to log in each application separately. Each client that has a version higher than 3.15.0 must setup the DNS for the landing application.
Additional Information about Naviga Applications
Within Naviga Subscribe one can find the following customer-facing applications:
Solicitor Concierge - An application designed to help you create Offer Groups, sell your Offer Groups, and manage the users who have access to them
Content Management System or CMS - Application to manage content, look and feel of Subscription Panel and Subscriber Concierge site
Subscriber Concierge Site, also referred to as Self-Service or Account Management - end-user website that allows subscribers to manage their accounts and subscriptions.
Support Viewer: An application useful to check Event logs and view logs, Management of User and Role privilieges along with App versions. Only for Naviga Internal Users
Logging In
The User/Business client can log into Landing application with their regular Login credentials.
Accessing the Application
The user will see a Landing page with the tiles for each application they have access for. Please see the screenshot below. Click on a specific tile will redirect the user to the relevant application.
Back to Landing
At the top menu in Subscriber Concierge / Solicitor Concierge / CMS there is a control that will take the user to back to the Landing page , so they can access another application without having to log in/out
Logging Out
In addition to be able to log out through the icon in the top menu in Subscriber Concierge / Solicitor Concierge / CMS, now there's an option to log out from Landing application as well. Please see the screenshot below for details.
2020.4.0 - Enhancements
Description
JIRA#
HotFix#
Subscribe Version
Customer Service:
The following four new Business Rules have been introduced in Customer Service:
The Subscriber Renewal Notice Export, in Accounting > Subscriber > RenewalNotices, now includes the Publication Code in addition to the Publication Name, providing a static data point in the file to clearly identify the publication for which the renewal is produced.
CM2-5351
CM43#2500
Accounting:
A new dropdown for ‘Notice Type’ has been added to the Auto Renew Notice Export screen in Accounting > Subscriber > AutoNoticeExport.
The dropdown has three options:
‘TrialEnd’ - returns a list of Auto-Renew Subscriptions that have a Trial active on them,
‘Auto-Renew’ - returns regular Auto-Renew Subscriptions, and
CM2-7528
CM43#2830
Accounting:
A fix program has been created to get the SecurityID menu included in proto data in Graphical Setup > Accounting > SubscriptionRates > FeeCode.
CM2-7299
CM43#2460
Accounting:
The logic that determines the payment amount to include Fee Tax in the total payment amount has been updated.
When a payment is cancelled, the system now creates a ‘PymtCancel’ transaction with all the amounts (Payment, Tax, Fee, Premium, etc.) precisely identical to the amounts of the original payment but with a negative sign to nullify the payment.
Also, convert records for Fee Tax will be created with both equal and negative amounts.
CM2-7953
CM43#3250
Accounting:
A set of new parameters have been added to the FindTax API, allowing the API to return additional details on the ‘fee amount’ and ‘tax on the fee amount’ when executed.
Print bill Fee Amount
Activation Fee Amount
Total Fee Amount - Sum of Print bill Fee Amount and Activation Fee Amount
Taxable Fee Amount
Total Fee Tax
CityFeeTax
CountyFeeTax
StateFeeTax
CountryFeeTax
TotalFeewithTax - Sum of Total Fee Amount and Total Fee Tax
GrandTotal - Sum of TotalFeewithTax and TotalAmountwithTax
Note:
These new fields are only displayed in the response if the SubscriptionID is provided as an input parameter.
iCM2-7789
HM43#430, HM43#510
Accounting:
A new field, ‘FeesOwedTax’, has been added to the Grace Owed Report, in Accounting > Subscriber > GraceOwedExport.
CM2-8115
CM43#3420
Accounting:
In the Carrier Billing Account Direct Deposit Report, under the Original Amount and Adjusted Amount columns, Pending Total and Approved Total have been added.
CM2-8754
CM43#3720
Tools:
The Import error “IMPORTdatafieldwiderthan65534characters. (4138)” on running the Batch Hygiene in Utilities > Subscription/Address has been resolved.
CM2-1268
CM43#2680
Tools:
CM2-7693
CM43#3230
Tools:
(CM2-5348
CM43#3280)
Conversions:
Conversion Edits - The logic for validating the Credit Card Expire date has been changed from hardcoded values to ‘CurrentYear to CurrentYear+5’.
CM2-6552
CM43#2230
Conversion Edit Reports:
CM2-7235
CM43#2370
Setup:
On running the Decrypt/Encrypt Private Info, the “payment source” and “PayPal email id” fields are now added in the SubscriptionPayment Table. However, the Carrier table now includes the “BankDraft” Vault ID
CM2-7707
CM43#3150, CM43#3120
Setup:
CM2-7737
CM43#2820
Setup:
CM2-7867
CM43#3050
Setup:
The following changes have been made to the Mass Import Export utility to update the End Date of existing records:
When the StartDate of a DB record matches the StartDate of an imported record, the EndDate of the DB record will be set to the EndDate of the imported record.
When the Start Date of a DB record is less than the imported record StartDate, the DB record EndDate is updated to the imported record StartDate – 1, and a new record with imported values is created.
Setup:
The following is a list of Tables/Groups where changes have been implemented:
ABCZonePublication
Area
ChargeCode
CreditStatusPublication
DeliverySchedule
DistribZone
District
ReasonInfo
Region
SubSource
TaxAuthority
TaxAuthorityPublication
TownOf25
CM2-7902
CM43#3330
Setup:
CM2-5345
CM43#3690
Description
JIRA#
HotFix#
Subscribe Version
Trial subscription records will only be picked in AutoPay batch based on the new AutoRenew Term setup for Trial Subscription as mentioned above in CM2-5345.
CM2-7526
CM43#3210
The next billing amount shown on the Auto-Renew CC start & Auto-Renew CC expire extract will now be calculated from the Auto renew process.
CM2-7792
CM43#3300
When a Trial Subscription Start transaction is processed, an Adjustment Only Payment for the same Trial Length and Term is created using the Adjustment Code specified in the Trial Subscription Business Rule—WhichAdjustmentCodeshouldbeusedforPrint/DigitalTrialPayments?
CM2-7616
CM43#2970,CM43#2940, CM43#2890
If any Subscriber (Perm Stop/Expire Stop) has a GraceOwed amount, it will not be adjusted in the Trial Adjustment Only Payment but will be included in the next payment cycle following the Trial End Date.
CM2-7617
CM43#3060
Creating a TempStop, Complaint, MoveIn-MoveOut, or BillingChangetransaction within the Trial Period now extends the Trial End Date.
CM2-7859
CM43#3070
To avoid the conversion of a normal subscription into Trial, the Trial button will be disabled for restarts coming directly by posting a payment from lockbox processing or CreatePayment API.
CM2-7865
CM43#3080
During the Trial Period, Subscriptions are not permitted to add donations when making a Temp Stop.
CM2-7920
CM43#3310
The fake payment created in NCS Circ Trials now matches the amount specified in the plan’s Rate Term and does not contain any additional amounts (i.e., premium day amounts and taxes).
CM2-7995
CM43#3240
MicroAPIs in support of Naviga Subscribe Integration:
A new API “CTAddUser” has been added in the ctimap file to add users.
CM2-6329
HM43#370
Circulation API:
CM2-7457
HM43#390
Circulation API:
CM2-7317
CM43#2720,HM43#400, CMO43#480
Circulation API:
The Circ API CreateDayPassByCampaign has been updated with the following changes.
If the ‘Subsource Type’ or ‘Subsource Required’ is set to True and no Subsource is passed in Campaign Setup, the username in the Campaign Circ API will be used as the Subsource, and a Subsource entry will be created in setup.
If a value is provided in the Subsource field in Campaign Setup, it will be reflected in Daypass Subsource.
If the ‘Subsource Type’ and ‘Subsource Required’ fields are left blank, the Daypass generates a blank value in the Subsource field.
CM2-6575
HM43#360,CM43#2210
Circulation API:
The CreateSubscription CircAPI now includes a new parameter “Copies,” which allows users to request one or more than one copy for all the days of the subscription.
Also, the CircAPI GetSubscription now includes this new parameter, “Copies,” which displays the number of copies for the days of the week for which the subscriber has delivery.
Note:
CM2-7966
HM43#450,CM43#3180 ,CMO43#490
Circulation API:
CM2-8750
HM43#540
Circulation API:
Taxation on the Activation and Printed Bill Fees will be applied in NCS Circ for payments created through the CS API and Circ API, and the payment amount will now be computed by including the Fees Tax Amount.
CM2-7791
Circulation API:
CM2-8251,CM2-9096
HM43#490,HM43#610
Circulation API:
CM2-7866
HM43#440
Circulation API:
CM2-8868
HM43#570
Description
JIRA#
HotFix#
Subscribe Version
CM2-8037
CM43#3650
Naviga Pay:
A billing change transaction is now created for AutoPay users, resulting in records being updated with new credit card details returned by Payway’s Account Updater through NavigaPay when the error status code = 2 and a change in CC number or expiry date is encountered during a sale transaction.
Note:The Billing Change Reason Code have been hardcoded as ‘Payment’.
CM2-7069
CM43#2330
Naviga Pay:
A billing change transaction is now created for AutoPay users to remove them from AutoPay when Payway returns a status code of 5 through NavigaPay during a sale transaction.
CM2-7070
CM43#2330
Naviga Pay:
When using NavigaPay, payments will no longer be processed if the database and server host names do not match.
CM2-7091
CM43#2480
Naviga Pay:
Two new Business Rules have been introduced in the Customer Service section to replace the earlier hardcoded reason codes for creating a billing change in the case of “Credit card details changed or discontinuing from Auto Pay in case of expired card”. Also the status remarks have been updated to “Card Details Changed - Card Number and Expiry Date Updated”.
Previously, after enabling NavigaPay for ACH, subscriptions that contained Bank Draft information had payment processing issues since the existing records lacked a VaultID.
To address this, a new utility has been created that will link VaultID and CustomerID with AccountNumber and BankNumber, which are associated with Subscriptions as AutoRenewal information.
CM2-8869
CM43#4060
Naviga Pay:
Under the Billing tab of RouteService > Setup > AccountServices, two new buttons for ‘Modify’ and ‘Delete’ have been introduced, allowing the CSR to modify or delete the existing Bank Draft details of a Billing Account.
Additionally, if the BR - ‘WillNavigaPaybeusedasthepaymentgateway?’ is set to ‘Yes,’ the Bank draft fields will be greyed out when creating a new Account Setup.
CM2-7529, CM2-7530
CM43#2700
Naviga Pay:
A new menu option has been added in Graphical Accounting > SubscriptionPayments – ACHStatusUpdate. This option retrieves the status of Bank Draft payments and updates it accordingly. A Payment Decline record is created when a payment fails.
CM2-7613, CM2-7614
CM43#2790,CM43#2800
Description
JIRA#
HotFix#
Subscribe Version
Fees Tax information for Activation and Printed Bill Fees has been added to the Fee Analysis Report under Reporting > Subscriber > FeesAnalysis.
CM2-8116
CM43#3600
Extracts
A set of new fields have been added to the multiple NCS Extracts files:
Name and Zip Code of Subscription Credit Card Holder
Service Copies that were missing in the Route Draw
Account file - Credit Card Expire date, Zip Code, and Holder name.
TranNumber in the TranHistory Extract.
Note:
The new changes are available in Subscribe Extract’s export version 5. Please contact Naviga Support for this change to be implemented.
CM2-7218
CM43#2440,CM43#3730
Extracts:
A set of new fields have been added to the sub_master.txt file of Subscribe Extracts.
Credit Status
Trial Term
Trial Length
Trial Start Date
Trial End Date
Note:
The new changes are available in Subscribe Extract’s export version 5. Please contact Naviga Support for this change to be implemented.
CM2-7581, CM2-7759
CM43#2910,CM43#2900
Extracts:
In the auto_renew.txt file of Subscribe Extracts, a new field, “Creditcard_holder_name”, has been introduced between creditcard_type and payment_source fields.
Note:
The new changes are available in Subscribe Extract’s export version 5. Please contact Naviga Support for this change to be implemented.
CM2-8179
CM43#3580
Extracts:
A set of new fields have been added to the payment.txt file of Subscribe Extracts.
Masked Credit Card number
Credit Card expiry date
Masked Bank number
Credit Card holder name
Credit card type
Payment Source
Note:
The new changes are available in Subscribe Extract’s export version 5. Please contact Naviga Support for this change to be implemented.
CM2-8172
CM43#3560
Exporting the Users
Extracts the existing user details in the form of an Excel file
Click Export push button to download the details in an excel sheet.
If the Role is Client Admin, then the list of existing users for all the application are shown in the same excel sheet. The data is exported in this format.
If the User Role Type is Specific, the roles are assigned based on Products access.
If Products access is to Solicitor concierge application, than the User list is shown based on the Admin Privileges, the respective user has.
If the User Role Type is Specific, the roles are assigned based on Products access.
If Products access is to Subscribe concierge application, than the User list is shown based on the Admin Privileges, the respective user has.
If the User Role Type is Specific, the roles are assigned based on Products access.
If Products access is to CMS application, than the User list is shown based on the Admin Privileges, the respective user has.
Find your way around the Solicitor UI
Solicitor Menu
Offer Groups: You can create and manage your Offer Groups in this section. An Offer Group is a collection of individual offers, and each offer is a combination of products per division at a single price point.
We suggest that you organize your offer groups around delivery schedules. For example, 7 Day Delivery, Sunday Only, Monday, Wednesday, Friday, eEdition and so on.
Organizing your Offer Groups in this way minimizes complexity and duplication. Instead of managing hundreds of different publications, each with its own product and delivery type, you will manage a few groups and customize them as needed.
Offers: This is a read-only section that allows you to quickly view your offers and divisions. An offer is the combination of products per division at a single price point. The format of the offer's name is offerGroupName - divisionName; it is automatically generated.
Starting from Release 3.14.0 we added an ability to remove a Division from an already published Offer Group for the following roles: Marketing Admin, Client Admin, MG2 Admin, MG2 Developer
The history of the published offer groups editing can be exported as a log file by Client Admin, MG2 Admin and MG2 Developer roles
Promotions: You can create and manage your promotions here. A Promotion is a group of Offer Groups.
Note: Promotions are a legacy concept and are primarily used to display multiple Offer Groups on the Subscription Panel. Some new features, i.e. Gifting, do not support promotions - you have to use an Offer Group instead of a combination of Offer and Promotion
Inventory: This is a drop-down menu that allows you to manage everything related to your Offer Groups. You can create your sales products, marketing text, and T&C. You can also set up premiums and determine delivery areas.
Teams: Manage your sales teams here. Create a team, manage its members, and customize what offers each team can sell.
Reference Tables: This is read-only reference section that allows you to quickly view product data, such as codes, household levels, sales platforms, service types, and billing plans. These are synced automatically from Subscribe database.
Admin: Add users and manage their access and permissions of the Solicitor application here.
Sync Features
Clear Cache: This clears your cache. It is important to clear your cache after you have made changes in the Solicitor application. This ensures everything is up to date. Clearing your cache can also resolve errors, and it is recommended to do so if you encounter an issue.
Sync: This manually syncs the Subscribe database to your Solicitor app. Syncing also resolves errors. It is recommended you try syncing and clearing your cache first if you encounter an issue. Note: the sync process also happens automatically every night.
Import/Export Features
Note: these features are available only for MG2 Admin roles.
User Icon
Select the user icon to log out of the Solicitor app.
Password Settings
Overview to modify/update the password settings of an existing user.
Click Settings push button on Subscribe Homepage
The user will be re-directed to the page where the Password and Account settings can be updated.
On Password tab, settings can be modified/assigned as per the user's requirements.
This includes the complexity of password in terms of inclusion of special characters, upper/lower case characters, and number character. The user can make a choice on the level of Complexity to be maintained.
The user can also define the minimum password length.
Password age signify the number of days limit, the password is allowed to update/modify.
Password history option helps in maintaining a secure password creation. It signifies the minimum number of old passwords not allowed to use again.
Note: The below icon shown on few field labels on Password Tab will be helpful to understand the purpose of that specific field.
Click the icon and related information is displayed. The fields labels for Password age and Password history serve the purpose.
Click Save button after all the required modifications are done on Password Settings.
Solicitor Concierge User Guide
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Welcome
Welcome to the Solicitor Concierge (Solicitor) User Guide. Solicitor is a flexible application designed to help you create Offer Groups, sell your Offer Groups, and manage the users who have access to them.
Overview
The diagram below shows you how the different components of Solicitor work together.
Since an Offer Group is comprised of different inventory products, you will first create all of your inventory products. Next, you will create your Offer Groups. Last, you will create your users and teams, designating their access and permissions.
Your Solicitor site automatically syncs with your Subscribe database and imports your Billing Products from the Subscriber Concierge database. A billing product is a combination of your divisions (individual publications) and your service types (delivery frequencies). Besides adding Available Areas, billing products cannot be edited. However, you can group them into sales products to incorporate them into an Offer Group.
Guide structure
This guide will explore some key concepts to help you understand the Solicitor application and guide you through common tasks. The guide contains three main sections:
Create a New User
A new account is created for another user/purpose.
On Subscribe Home page, click Users push button
The below screen appears. The list of existing users are displayed.
Click +Add User push button to Create a New User.
The required screen to Create User appears. Fill in the details in the respective fields.
Specify User Name, Email, Password, Confirm Password. Rest of the fields can be populated from the pop-downs.
For Environment access field, more than one option can be selected.
Click Save button to append the New User details to the database.
Note: When the Role Type is picked as Generic, the user have the choice to assign various types of roles as shown in the figure below depending on the functionality of the newly created user.
If the Role is selected as User, Test User, Client Admin, Client Power User or New User, the newly created user has the choice to select the Clients from the dropdown. The new/additional dropdown Clients appears only if the Role selected to the above mentioned list.
Note: If the Role type selected or picked is Specific from the dropdown, then another dropdown Products appear. If the User Role Type is Specific, the roles are assigned based on Products access.
The newly created user can be assigned the privilege to access one or more applications appearing in the dropdown.
The newly created user Role Type can be provided with the privilege of accessing one or more applications as shown below.
As shown below, the newly created User details appear in the list of Users.
Note: Whenever any changes made are to the user details, click Save button to update the changes in the database. Otherwise, the modifications done would not reflect when the user details are accessed next time.
Editing User Details
Updates/edits the account details of the user.
Locking the User Account
Click on Edit icon of the respective user.
Click Save button to update the changes.
If the user tries to login with the Locked Account credentials, an error message is displayed as shown below
The Admin User has to unlock the account for the User credentials to be used again.
Enabling/Disabling the User
Admin can make an existing user account details in an enabled or disabled status.
The status can be checked based on the active status of the user from the list as shown below
Click Edit icon of the respective user.
The user details are accessible.
Uncheck the Active status.
Click Save button to update the details.
When the status of Active is rechecked under User Details, it shows the status as false
The disabled status of user can be confirmed by logging on Subscribe link.
Resetting/Updating the Password
Two new fields would appear to accept the entries of New Password and Confirm the same password.
Enter the New Password and re-enter the same password to confirm it.
The user can access his account by using the changed password.
As shown below, if the user tries to login with the old password, the system gives error.
The user can access the system with the new/updated password only.
Resetting/Updating the password through a link from User's Email id
The user can be instructed to reset the password through the mail id
Admin clicks Force password change button
The User receives an email with a link stating that the password needs to be reset.
The user can make the changes accordingly.
Subscribe now integrated with the Matrix circulation and billing systems
The following features are supported:
New Subscription Purchases via CSR Portal and Subscription Panel.
Managing payment transactions, which enables customers to make one-time payments, enroll in auto-renewals, update their payment method, and sign up for invoice payments.
Spreedly integration
Naviga Subscribe has successfully integrated with Spreedly payment gateway. Spreedly’s payment orchestration platform connects to many other payment gateways and processors such as Opayo, Authorize.net, etc. This initiative helps address the need to integrate with different payment gateways without any additional development in the future as long as it’s supported by Spreedly. Only applicable for NCS circ clients.
Number pad for the expiration date
The expiration date field of the Edgil iFrame on the Subscription Panel is enhanced to use the number/dial pad in mobile rather than the entire keyboard.
Newsletter widget - Show all newsletters
Can now display both free and subscriber-only newsletter preferences to Subscribers using the Newsletter Widget. A new flag calledShowAllwas introduced. When the showall and subscriberonly flags are set to true then both free and subscriber-only preferences will be displayed to a subscriber on the widget.
To leverage this feature, the client will have to set the showall parameter to true on their newsletter widget page. For more details refer to the widget installation document
One CSR Portal/ NCS circ
Solicitation Preference - This feature provides CSR’s the ability to add, update or remove a subscriber from a desired solicitation preference ("Do not call", "Do not email") list in real-time. This is available on the Account Information tab of the CSR portal.
A minimum of NCS Circ 2018.5 is required.
Payment Transactions - This feature provides CSR’s the ability to view a subscription's financial transaction history in real time from circulation. It also allows a CSR to cancel paperless billing in real-time. This is available on the Payment/Bill tab of the CSR portal.
A minimum of NCS Circ 2018.5 is required.
SheerID
Subscribe platform is integrated with SheerID and now allows clients to offer low price subscriptions for specific individuals such as students/military who’s been verified by our platform. Please find more details in our documentation. The feature was requested by MNG client
In case a subscription is updated from digital to print we prepopulate the delivery address with the previously entered billing address that the user is free to edit. Minimum NCS version required is 2018.5 + SP4. For more information about Upgrade/downgrade feature please check page.
Business users now can set up all the Offer Groups and Offers they might want to have in one environment where the data can be tested and approved, and then using copy them to another environment in several clicks. Please see more details in our documentation.
Business users can configure a special offer/benefit that would be presented to the CSR rep or end-user if they start the cancel subscription. The aim of the flow is to improve engagement and save subscribers from going. Business users can define actions based on reasons. Available for NCS clients from 2018.5 version. Please see more details in our documentation.
This feature allows users to pay one-time tip for subscriptions that have print products and are already on auto-renew. Available for clients with NCS Circ 2018.5+SP1+SP2. You may find more details in our documentation.
Business users would now be able to manage disclaimers to be displayed to CSR rep via Subscribe Concierge Admin portal. This is available under ‘Client management’ section of One CSR portal. You may find more details in our documentation.
Integration with Classic Portal - now One CSR portal is integrated with the classic portal for NCS circ and a Customer Service Representative can easily go to classic portal in case they want to use the functionality that is not supported yet in One CSR portal. Please see the feature details in our documentation. Requires minimum 2018.5 NCS Circ version.
Upgrade/downgrade - this feature allows the user to upgrade the subscription to a premium offer or to downgrade it to a lower rate and service in real-time. The change can be applied immediately, at the next billing cycle, or scheduled to happen at a certain date in the future. Can be done via Account management pages or via CSR call using one CSR portal. Please find more details in our documentation. Requires minimum 2018.5 + SP1 NCS Circ version.
Occupant/Subscriber information like first name, last name, phone, email would now be synced with NCS circ. Available for NCS 2018.5 Clients. Please check our documentation for more details.
Real-time restarts of a permanently stopped subscription are now available in Self-Service and One CSR Portal for NCS 2018.5 Clients. Please note that if the subscription had been stopped a long time ago that only a new start via Subscription Panel will be available. Check our documentation for more details.
Subscribe now allows end-users to purchase gifts for friends, family or self. The gift purchaser can send a gift immediately or on a certain date, e.g. to send on someone’s birthday. The person receiving the gift should be able to redeem it by clicking on the link in the gift email or manually entering the code. Clients would need to work with their email management team to send gifts on a specific date. Available for 2020.2 NCS Circ version. Please see our documentation for details
This feature allows clients to offer comp (free) subscriptions. The end-user would not be asked to enter any payment information. Please check our documentation for more details. Available for NCS clients on 2015.5+SP1+SP2 version & latest extracts with demographics data.
Subscribers can now use Apple payment to purchase subscription. Minimum NCS Circ version required is 2020.2. Please check our documentation for more details
Active Subscription check for Print/Hybrid/Digital subscription that was introduced in 3.13.0 was refactored. Please see our documentation for more details
subscription price, tax and total amount to pay are displayed right after ZIP code is entered. More information about frictionless checkout can be found .
In addition, the payment checkout page interface has been modified to highlight the Total Price section.
Note updated on June 29th, 2023.
See the for the pre-requisites
Logos of external billing systems are now displayed on the order summary page. The Payment Show option on the Order Summary Component will now include the Logo for the Alternate Payment Methods. These logos are tied to Payment IDs in the Naviga database associated with the payment type’s specific logo. Currently, the client is not able to change the logo. No setup required by the client. More information about the order summary component .
This might only have an impact for ZIP-only presentations as they rely on billing zip code to calculate the total price. Please see the for more details
This feature allows the user to upgrade the subscription to a premium offer or to downgrade it to a lower rate and service in real-time. The change can be applied immediately, at the next billing cycle, or scheduled to happen at a certain date in the future. Can be done via Account management pages or via CSR call using one CSR portal. Please find more details in our documentation.
CSRs now have the option to edit the customerRegistrationID field. More information
A new transaction history page has been added: '/transactions'. This table has 4 columns that shows the information on previous payments (Date, Transaction Type, Amount and Status). The column names can be edited from CMS.
A new payment method has been added in Solicitor.
The Purchase API now supports new starts in CircPro circ system, gifting and complimentary flows in NCS circ cystem, and Braintree, Cybersource and AuthorizeNet payment processors. For more information about PurchaseAPI please see the .
Note: Updated on 27th June '22 - Addition of Complimentary flow for NCS.
The Benefit element in CMS now has Video property where you can add the link to the video. Please note that only youtube links are supported. In the Benefit at the main page of the Account management, you will see a thumbnail and a play icon that will launch the media player playing the video. Any client can use this component. For more information about the Benefit component, please see the
New starts in CircPro circulation system are now supported in PurchaseAPI. The new PurchaseAPI has two execution parts: synchronous (to perform the input model validations) and asynchronous (to process all child events). The new start gets rejected if one of the synchronous steps fails while the asynchronous step(s) would fail silently without any user notification. CSRs are able to view failed events and the failure reason, update data and reprocess events via One CSR Portal. More information can be found in our documentation.
Occupant/Subscriber information like first name, last name, phone, email would now be synced with CircPro circulation system. Available for CircPro Clients with 2021-1 version. Please check our documentation for more details.
Ability to change in real time both the billing and delivery addresses from SubCon admin (CSR Portal). Please check our documentation for more details.
Users can now upgrade or downgrade their subscriptions from the Self Service Portal (Digital to Print and viceversa). Please check our documentation for more details.
A Digital ZIP-only Subscription Purchase requires a subscriber to enter only a few fields to make a purchase (Email address, First Name, Last Name, Zip Code and Phone Number). Please check our documentation for more details.
The feature was initially introduced in Release 3.14.0. In the current release the Solicitor Concierge behavior is updated to be more user-friendly. For more information about the feature please see ourdocumentation
Subscribe has refactored the SubscriptionAPI and introduced the new PurchaseAPI that has two execution parts: synchronous (to perform the input model validations) and asynchronous (to process all child events). The new start gets rejected if one of the synchronous steps fails while the asynchronous step(s) would fail silently without any user notification. CSRs are able to view failed events and the failure reason, update data and reprocess events via One CSR Portal. The Release 3.14.2 covers the refactor for Standard and Complimentary starts for NCS Circ+Payway. More information can be found in our documentation.
The Active check that is performed during the new start has been refactored to cover digital-only starts. The new subscription can be only created if no active subscription exists for the same product and address. Starting from this version the Active subscription check is performed via PurchaseAPI but old SubscriptionAPI.
Please see our documentation to get more details
Subscribers can now use GooglePay to purchase subscriptions via panel. This integration was made for Payway payment processor. Minimum NCS Circ version required is 2020.2-1. Please see our documentation for more details
This feature allows users to purchase a low-cost, low-commitment version of a subscription that allows users to enjoy a digital subscription for a short term. We support Single Day Pass in Subscribe. Please check our documentation for more details. Minimum NCS Circ version required is 2014.5
Please see our guide for details.
Occupant/Subscriber information like first name, last name, phone, email would now be synced with Matrix circulation system. Available for Matrix Clients with 38.0.034 version. Please check our documentation for more details
This feature allows clients to offer comp (free) subscriptions. The end-user would not be asked to enter any payment information. Please check our documentation for more details. Available for Matrix Clients with 38.0.034 version and latest extracts with demographics data
This feature allows the user to upgrade the subscription to a premium offer or to downgrade it to a lower rate and service in real-time. The change can be applied immediately, at the next billing cycle, or scheduled to happen at a certain date in the future. Can be done via Account management pages or via CSR call using one CSR portal. Please find more details in our documentation. Requires minimum 38.0.034 Matrix version
Import/Export feature that was available since 3.13.1.1. was refactored to increase performance and make the interface more user-friendly. Please see more details in our documentation.
This feature allows business user to edit an offer group that has already been published, e.g. remove a division that was made redundant together with the related price plan and offers. The feature is available for the following Roles: Marketing Admin, Client Admin, MG2 Admin, MG2 Developer. See more details in our documentation.
New Audit Trail section was introduced in Solicitor where the business Admin users can see the last operations made with Solicitor data and filter them against date range, offer group id, person made changes. The feature is available for the following Roles: Client Admin, MG2 Admin, MG2 Developer. See more details in our documentation.
This feature allows users on auto-renew to add a recurring tip to the carrier that will be paid every billing cycle together with the recurring payment. This feature is available for all circulation systems. For NCS Circ the minimum required version is 2020.2.1, for other circulation systems please ensure you're using the latest version. Please see our documentation for more details
The disclaimers that are displayed to CSR rep via Subscribe Concierge Admin portal now support CMS Attributes. This feature allows business users to create more versatile disclaimers. You may find more details in our documentation.
Late route messages are displayed to users in case the delivery might be delayed due to unexpected issues. These messages are aimed to prevent credit for the late routes and decrease possible complaints amount. This feature was also available for One CSR Portal starting from Release 3.5 - please see our documentation for details
This feature will simplify the Offer set up in Solicitor Concierge - after a campaign code is added then rate code, reason code, term length and billing method will be automatically prepopulated with valid values that were set up in NCS circ. Please see our documentation for details. Minimum NCS Circ version required is 2014.5.
Subscription Purchase flow for credit card payment with Payway payment processor was refactored to offer frictionless experience for the end-users and hence improve conversion. For ZIP only starts, the seamless theme allows the user to enter payment and occupant details in a single step and supports final submission in one click. Please see our guide for details.
Firefly as an Entitlement recognition record system requires a license to be created each time a registration links a subscription on Naviga side. The Firefly license call was refactored to support the new structure. Please see our documentation for details
PurchaseAPI that has been developed for the 3.X clients in 3.14.2 now supports Vindicia circulation system and payment processor. More information can be found in our documentation.
OneTrustUrl: "",
Landing application login screen
Landing page for a user with access to Subscriber Concierge, Solicitor Concierge and CMS
Back to Landing at the top menu
Logging out from Landing application
An alert will pop-up on the customer service screen if a CSR view a subscriber account information who is on Trial subscription. The alerts can be configured under Setup > Distribution > Notification.
‘Both’ - returns a combination of the two subscriptions mentioned above.
When running a Grace Owed Report for any subscription with fees, the export file will now include a field for Fees Tax. In addition, Grace Owed Export would include the Fees Tax information in the remark.
The Pending Total would include all failed transactions, while the Approved Total would include all successful transactions, and the Carrier Total would be the total of the Pending Total and the Approved Total.
In NCS Circ, Activation and Printed Bill Fees are now taxed, and the payment amount will include the Fees Tax amount.Activation Bill FeesPrinted Bill Fees
Select the required Distribution Information from the AdvanceDistributionInformation table and click on CopyDistributionInfoRange button. A pop-up window will be displayed to add, update, or delete records depending on the date range passed for selected weekdays in the specified range.
Subscriber Status (Active, Temp Stopped, Perm Stopped) has been added in the Edit Reports for Subscription Edit error 131.
In Setup > Accounting > SubscriptionRates > FeeCode, a new checkbox “IsTaxable?” has been added to apply tax on the Activation and Printed Bill Fees. Hence the payment amount will be calculated including the Fees Tax Amount.
To import or export the Sub Source, a new dropdown value “Sub Source” has been added under Table/Group name of Mass Import/Export Utility.
In the AutoRenewTerm table, the grace days and renew days will now include a field for Trial Subscriptions and the Delivery Method (Route, Mail, Online). Also, a new field for Trial Subscriptions has been added to the notice days. See the FAQ document for further details.
The FindSubscription CircAPI end point has been updated to give information about whether a Subscription is now on Trial.
The response now has a Parent Tag, “Trial,” that provides relevant details such as ‘InTrial’ (Yes/No), ‘StartDate,’ ‘EndDate,’ ‘RateCode,’ ‘RateTerm,’ and ‘RateLength’.
Create Subscription CircAPI has been modified with the below three new fields Trial’, ‘TrialTerm’, and ‘TrialLength’ to support the creation of Trial subscription.
The maximum permitted value is 99, while the minimum is 1.
The CreateSubscription CircAPI now has a new output parameter, RestartDate, which will show the date when the subscription has been restarted in the response.
The FindTax API now includes a new “Rate Code” field, which allows fees to be calculated using the Rate Code and ProductID entered in the API if the SubscriptionID is not provided.
The CircAPI ‘GetDeliveryAddress’ now includes a new parameter, MoveOutDate, in the response, allowing the API to return information on when the subscriber is moving out of the old address and into the new address.
Two new fields have been added to the FindSubscription API: “IsFuturePermStop” and “FuturePermStopDate.”
If a subscription contains an unprocessed future Perm Stop transaction, the FindSubscription API will return the logical answer for “IsFuturePermStop” as “yes” and the transaction date for “FuturePermStopDate”. If no Perm Stop or Processed Perm Stop exists, the logical field “IsFuturePermStop” will return “no.”
A new business rule— ShouldAutoPayments/AutoNoticebegeneratedforSubscriptionswithunprocessedPermStoponexpire? has been added in Subscriber Payments Section with the default value set to Yes. When set to No, raising invoices, or generating Auto-Renew Payments will be suppressed if the subscriber’s Expire date has a future Unprocessed Perm Stop.
Use these buttons to import and export JSON data into Solicitor. Imported data must be in JSON format. Please see our guide for details.
- provides the highest overview and instruction to get you going. Its aim is to show you how create your inventory products and first Offer Group quickly. It also acts as a good overview for how Solicitor works.
- explores how to navigate around the Solicitor application. The application contains many features. Use this section to for high-level definitions and explanations.
- provides the most detail and information. Each tutorial walks you through each step for each feature in Solicitor.
Make sure you meet the following pre-requisites before starting the tutorial steps:
Reach out to Naviga Implementation Manager to ensure your Solicitor site has been configured
Get started
Step 1 - Configure an available area
By default, all of the US and CA postal codes will be included as deliverable areas. To narrow further:
Select inventory, then choose available areas.
Select + new button.
Add the deliverable ZIP/Postal codes of your publication.
Name your available area, then select save.
Step 2 - Configure your first product
Select inventory, then choose products and bundles.
From the billing tab, navigate to your product and select the pencil icon.
Add your newly created available area to the billing product. Select save.
Select the sales tab, then select the + new button.
Name your new sales product, add your billing product, and add your newly created available area.
Select save.
Step 3 - Configure your first terms and conditions
Select inventory, then choose terms and conditions.
Select the + button.
Create a name for your new terms and conditions option.
Write your terms and conditions in the body field.
Optionally, check the set as default box if applicable.
Select save.
Step 4 - Configure your first marketing text
Select inventory, then choose marketing text.
Select the + button.
Create a name for your new marketing text option.
Fill in your desired text in the text fields.
Optionally, check the set as default box if applicable.
Select save.
Step 5 - Optionally, configure your sales team
If your offer will be using direct sales/Kiosk or Subscriber concierge admin, follow this step. Otherwise, unselect these options from Offer Groups -> Additional Options setting and skip the rest of this step.
Select teams, then choose sales team.
Select the + new button.
Enter a name for your sales team, then configure their privileges.
Select save.
Step 6 - Configure your first offer group
Select offer groups.
Select the + button.
Name your offer group. Add your product, price, and division.
Select publish
What's next
Audit Trail
Starting from Release 3.14.0 together we also developed the ability to view changes made with Solicitor Concierge data and download the report as a log file. In the report we can see the creation, editing and deleting operations. This feature is available for Client Admin, MG2 Admin and MG2 Developer Roles.
In the Grid the following information is displayed:
The name of the table in the database where the changes were made
The date of the change
The type of the change: Added, Modified, Deleted
The login of the user who made the changes
Value
Client code
'Details' icon that opens the right-hand panel with additional info
Import/export is not reflected in the reports i.e. if the entity will be created/modified during export it will not be reflected in these logs
Ensure that you have one of the following Roles: Client Admin, MG2 Admin, MG2 Developer Roles
Select the 'Reports' in the left-hand menu
Select 'Audit Trail'
Optionally apply sorting and/or filtering. Default order sequence is by change date, descending
Click 'Export' button
Configure available areas
Goal
The goal of this guide is to show you how an Available Area (AA) works in Solicitor. An AA is an area that a product can be delivered to. Solicitor comes with all the US and Canada postal codes preconfigured, but you might want to limit or expand your delivery range to a different AA.
Make sure you meet the following pre-requisites before starting the tutorial steps:
Have the products created in your Subscribe database and then synced to Solicitor as Billing Products. Reach out to a Naviga Implementation Manager to do this.
Have non-default postal codes loaded into the system. Reach out to a Naviga Implementation Manager to do this.
Manage your AAs
In this section, you will learn how to create a new AA and delete or edit an existing AA.
Create an AA:
Select the inventory menu in the Solicitor dashboard, then choose Available Areas. Any existing or preconfigured AAs will display.
Select the + New button. The creation screen will appear.
Choose a name for your AA, then add your desired postal codes.
Add a postal code:
Select the circular + button in the ZIP/Postal Codes section. A search feature will appear.
In the following order, choose a country, state, and if applicable, county and city. You can limit your AA to a single postal code or an entire city or state's postal code.
Add individual postal codes by either dragging or double-clicking them or add your entire search query with the add all button. Once a postal code has been added to your AA, you can explore them with the expand arrow.
Select the active box, then select save.
Congratulations, you've created a unique AA. To use this AA, you will need to add it to your billing product, the subject of the next section in this guide.
Delete or edit an existing AA:
Select the inventory menu in the Solicitor dashboard, then choose Available Areas. Any existing or preconfigured AAs will display.
Navigate to the desired AA and select the pencil icon to edit OR the trash can icon to delete. If editing, the creation screen will appear. If deleting, confirm your choice then select delete.
Add your new AA to your billing product
In this step, you will learn how to add your new AA to your existing billing product. Your billing products will have been configured by Naviga to include the preconfigured US and Canada postal codes, but you will need to manually add any new AAs you create.
A billing product is a combination of your divisions (individual publications) and your service types (delivery schedules). Besides adding Available Areas, billing products cannot be edited. They live in your Subscribe database and can be synced to Solicitor with the sync button or scheduled.
Add an AA to a billing product:
Select the inventory menu in the Solicitor dashboard, then choose Products & Bundles. Any existing or preconfigured billing products will display.
Navigate to your desired billing product and select the pencil icon.
Select the available areas window to highlight the section. Any AAs you have created will appear to the right.
Drag or double-click the AA you wish to add.
Select save.
Congratulations! You've added your newly created AA to your billing product.
What you've learned
To review, you've learned to create or update AAs, which are designated deliverable postal codes, and you've learned to add the AAs that you've created to your billing products, which enables you to add them to an Offer Group.Goal
The goal of this guide is to show you how an Available Area (AA) works in Solicitor. An AA is an area that a division can be delivered to. Solicitor comes with all the US and Canada postal codes preconfigured, but you might want to limit or expand your delivery range to a different AA.
Manage your AAs
In this section, you will learn how to create a new AA and delete or edit an existing AA.
Create an AA:
Select the inventory menu in the Solicitor dashboard, then choose Available Areas. Any existing or preconfigured AAs will display.
Select the + New button. The creation screen will appear.
Choose a name for your AA, then add your desired postal codes.
Add a postal code:
Select the circular + button in the ZIP/Postal Codes section. A search feature will appear.
In the following order, choose a country, state, and if applicable, county and city. You can limit your AA to a single postal code or an entire city or state's postal code.
Add individual postal codes by either dragging or double-clicking them or add your entire search query with the add all button. Once a postal code has been added to your AA, you can explore them with the expand arrow.
Select the active box, then select save.
Configure marketing text
Goal and overview
The goal of this guide is to show you how to configure marketing copy in Solicitor. You can create templates (e.g. Print Delivery Text or Digital Access Text) and then use them in your Offer Groups.
Best practice note: we suggest you use attributes when configuring your marketing text templates. Doing so will reduce duplication and complexity in the long run!
Before you start
Make sure you meet the following pre-requisites before starting the tutorial steps:
Reach out to your Naviga Implementation Manager to get your Solicitor application up and running.
Create marketing text
In this section, you will learn how to create/edit/delete a marketing text template, as well as how to use attributes and add images.
Create a marketing text template:
Select the inventory menu in the Solicitor dashboard, then choose Marketing Text.
Select the + button. The creation screen will appear and display a series of WYSIWYG text fields.
Choose a name for your marketing text template, (e.g. Digital Only).
Write your desired text for the title, body, and price fields. Use the WYSIWYG editor to format your text.
Add an internal description, a confirmation name, and any search tags.
Optionally, select set as default then select either physical/digital. Doing so will make this template the default of the same category when you create Offer Groups.
Select save.
Note: by the end of configuration, there must be at least one default digital and print marketing text.
Here is an annotated image that displays a title, body, and price.
Attributes
Using attributes is highly recommended and will save you a lot of time. Think of attributes like placeholders for publication-specific text, similar to a phone number or address. When a phone number or address changes, you won't need to update every marketing text template since you're using an attribute as a placeholder. You only need to update the attribute once in the CMS. An attribute might look like this:
Unlimited digital news at {{NewspaperName}}. Call now at {{PublicationPhoneNumber}}
Add attributes:
Select +Attributes & Images. The tab appears to the right.
Select the attributes tab.
Drag your desired attribute into the WYSIWYG editor. Alternatively, you can simply type your attribute if you know its format and name.
Images
Add images:
Select +Attributes & Images. The tab appears to the right.
Select the images tab.
Double-click or drag your image into the add image box.
Delete or edit a marketing text template:
Select the inventory menu in the Solicitor dashboard, then choose Marketing Text. Any existing templates will display.
Navigate to the desired marketing text template and select edit.
If editing, make your changes then select either save or save as new. If deleting, select the trash can icon.
What you've learned
To review, you've learned how to create/edit/delete a Marketing Text template. You will use these templates when you create an Offer Group. You've also learned how to add attributes and images to your template.
Configure a sales product
Overview and goal
The goal of this guide is to show you how Sales Products (SPs) and Billing Products (BPs) work in Solicitor. One difference between SPs and BPs is that Naviga preconfigures your BPs whereas you create your SPs.
BPs are a combination of divisions (publications) and their service types (delivery frequencies). SPs are a way to "group" similar BPs so that you can use them in your Offer Groups.
Best Practice Note: we suggest you create SPs to reflect divisions that have similar service types. Creating SPs in this way will greatly simplify managing your Offer Groups.
For example, you may want to create a Sunday Only SP. This SP would be a single entity that includes every division that has a Sunday Only BP.
You could also create a Digital Only SP, which would include every division that has a Digital Only BP.
Creating SPs in this way helps you organize your Solicitor dashboard and removes complexity and duplication.
Before you start
Make sure you meet the following pre-requisites before starting the tutorial steps:
Have the products created in your Subscribe database and then synced to Solicitor as Billing Products.
Have Available Areas assigned to your Billing Products.
Create a Sales Product
In this section, you will learn how to create an SP. The first procedure will guide you through the mandatory steps. The latter procedures explore optional configurations.
Create an SP:
Select the inventory menu in the Solicitor dashboard, then choose Products & Bundles. Your BPs will display.
Select the sales tab. If you have created any SPs, they will display here.
Select the + new button. A creation window will appear.
Name your SP, e.g. Sunday Only Print.
Add your desired BPs. Select the billing products window, then double-click or drag your desired BP. To continue with the example, this would be any Sunday Only BPs.
Add an optional configuration with the steps below. Otherwise, select the active box then select save.
Optionally, configure your SP further
You can configure your SP further with the following options:
Limit available areas allows you to specify a particular Available Areas that you have added to BPs (leaving all product available areas checked means all the available areas for the Billing Product will be available). To limit the available area:
Select the limit available area window.
Select set per product.
Toggle between BPs and double-click or drag your desired Available Areas.
Add incompatible products allows you to denote incompatible SPs (e.g. a Sunday Only delivery would be incompatible with a 7 Day Delivery). This feature disallows certain SPs from being combined when configuring Offer Groups. To add an incompatible product:
Select the incompatible product window.
Double-click or drag all desired incompatible products.
Add mandatory products allows you to denote any BPs that must be sold as part of the SP (e.g. a TV Book or Puzzle Book that is mandatory for a 7 Day Delivery). To add a mandatory product:
Select the mandatory product window.
Double-click or drag all desired mandatory products.
Congratulations! You've created a Sales Product.
What you've learned
To review, you've learned the difference between Sales Products and Billing Products, as well as how to create and customize a Sales Product. Creating these Sales Products is necessary for creating Offer Groups.
This quick start guides you through getting your first offer group up and running in Solicitor. For detailed explorations of the features explored in this quick start, check out the section.
Congratulations! You've just configured your first inventory products and Offer Group. Follow these sets of instructions for each product and/or Offer Group that you wish to create. For more detailed explorations of the Solicitor features, check out the or sections.
Reports -> Audit Trail
If you do not see the desired BP, make sure you have assigned it an . BPs without an assigned Available Area will not display here.
To configure an activation fee, you must contact your Naviga Implementation Manager. Naviga will configure a service type and fee product for a one-time charge activation fee in the Subscribe database. After you have completed that, complete the following steps.
Create a sales product
Best Practice Note: we suggest creating a single sales product for all publications. This reduces complexity, duplication, and many offer groups to navigate.
Configure an activation fee sales product in the Solicitor Concierge dashboard:
Select inventory, then products & bundles from the left sidebar.
Select the sales tab, select edit next to the corresponding sales product.
Select the billing products field. A list of billing products will appear on the right. Drag the activation fee product into the billing products field.
Select save.
Add the sales product to an offer group
Configure the activation fee in the Solicitor Concierge dashboard.
Select offer groups from the left sidebar. Your offer groups will appear in a list to the right.
Select an offer group from the list, or create a new offer group. The offer will now display the activation fee.
Select the price box and set the activation fee's price.
Select save.
Outcome
Congratulations! You've configured an activation fee. You can add this activation fee to each of your products.
Configure premiums
Goal and overview
The goal of this guide is to show you how to configure premiums in Solicitor. Premiums are merchandise that are sold along with the product. They are NCS specific.
Follow the instructions in this guide to add premiums to your inventory. The instructions in the Offer Groups guide show how to add them to a specific Offer Group.
Before you start
Make sure you meet the following pre-requisites before starting the tutorial steps:
Have the products created in your Subscribe database and then synced to Solicitor.
Have created a premium code in your NCS Circ database.
Create a premium
In this section, you will learn how to create a premium:
Select the inventory menu in the Solicitor dashboard, then choose premiums. A list of all your premiums will appear.
Select the + new button. The creation screen will appear.
Create a name for your premium, (e.g. $5 gift card).
Create a display name for your premium.
Select the divisions box, then double-click or drag any division(s) your premium will apply to.
Add your NCS Circ code that corresponds with this premium.
Chose whether you want the premium to be active, and select save.
Edit your premium
To edit your premium:
Select the inventory menu in the Solicitor dashboard, then choose premiums. A list of all your premiums will appear.
Navigate to the desired premium and select the pencil icon. The edit panel will appear.
Make your desired changes.
Select save.
Note: You cannot delete your premium, but you can make it inactive. To inactivate a premium, edit your desired premium and unselect the active box.
What you've learned
To review, you've learned how to create and edit your premiums. Once you've created them, they are a part of your inventory and you can apply them to offers from the Offer Groups menu.
Configure terms and conditions
Goal and overview
The goal of this guide is to show you how to configure terms and conditions (T&C) text in Solicitor. You can create templates (e.g. Print Delivery T&C or Digital Access T&C) and then use them in your Offer Groups.
Best practice note: we suggest you use attributes when configuring your T&C templates. Doing so will reduce duplication and complexity in the long run!
Before you start
Make sure you meet the following pre-requisites before starting the tutorial steps:
Reach out to your Naviga Implementation Manager to get your Solicitor application up and running.
Create terms and conditions text
In this section, you will learn how to create/edit/delete a T&C text template, as well as how to use attributes and add images.
Create a T&C text template:
Select the inventory menu in the Solicitor dashboard, then choose Terms & Conditions.
Select the + button. The creation screen will appear and display a WYSIWYG text editor.
Choose a name for your marketing text template, (e.g. Print Delivery T&C).
Write your desired text for the body fields. Use the WYSIWYG editor to format your text.
Add any search tags.
Optionally, select set as default then select either physical/digital. Doing so will make this template the default of the same category when you create Offer Groups.
Select save.
Note: by the end of configuration, there must be at least one default digital and print terms and conditions text.
Attributes
Using attributes is highly recommended and will save you a lot of time. Think of attributes like placeholders for publication-specific text, like a phone number or address. When a phone number or address changes, you won't need to update every marketing text template since you're using an attribute as a placeholder. You only need to update the attribute once in the CMS. An attribute might look like this:
...You can cancel anytime by calling the {{PublicationPhoneNumber}}...
Add attributes:
Select +Attributes. The tab appears to the right.
Drag your desired attribute into the WYSIWYG editor. Alternatively, you can simply type your attribute if you know its format and name.
Delete or edit a T&C text template:
Select the inventory menu in the Solicitor dashboard, then choose Terms & Conditions. Any existing templates will display.
Navigate to the desired template and select edit.
If editing, make your changes then select either save or save as new. If deleting, select the trash can icon.
Preview a terms and conditions text
You can preview your terms and conditions, then select whichever division you'd like to see.
To preview:
Select the inventory menu in the Solicitor dashboard, then choose Terms & Conditions.
Choose a terms and conditions template from the right.
Select the Preview button.
Choose a division from the drop-down menu.
Once finished, select the X button to leave the preview feature.
What you've learned
To review, you've learned how to create/edit/delete a Terms and Conditions text template. You will use these templates when you create an Offer Group. You've also learned how to use attributes.
Best practices for user accounts
Diagram legend
Use case 1
All Sales rep to sell all the available offer groups for a specific division.
This scenario requires a single Sales Team and a single Team Members.
Create each user’s access (username/password) in the user section.
Create a default Sales Team that includes the specific division and all assigned Offer Groups. (When new Offer Groups are created, make sure they are assigned to this default Sales Team.)
Create a Team Members and assign all the users to this Team Members. Since they sell every Offer Group, make it the default Team Members.
Use case 2
A group of sales reps is to sell a promotional offer for a specific division. They belong to the same vendor organization as the first use case.
This scenario requires a single Sales Team, but two Team Members.
Create the required user’s access (username/password) in the user section.
Since the group of sales reps is a part of the same vendor organization of the first use case, that Sales Team can be reused. Make sure all the promotional offer groups and the correct division is added to the first sales team if missing any.
Create a Team Members A and assign to it all the users expected to sell the promotional offers. Next, assign the division and promotional offer to Team Members A. Last, assign Team Members A to the Sales Team created in use case 1.
Use case 3
A group of sales reps is to sell one set of promotional offers and another group of sales reps to sell a different set of promotional offers. Both sets of offers are of the same division. Both groups of sales reps belong to the same vendor organization.
This scenario requires a single Sales Team, but two Team Members.
Create the required user’s access (username/password) in the user section.
Since they are a part of the same vendor group, create a single Sales Team, then assign the division and both promotional offers1 and promotional offer2 to that Sales Team.
Create Team Members A and assign to it all users selling promotional offers1. Next, assign the division and all the promotional offers1 to the Team Members A. Last, assign Team Members A to the single Sales Team.
Create Team Members B and assign to it all users selling the promotional offers2. Next, assign the division and all of the promotional offers2 to Team Members B. Last, assign Team Members B to the single Sales Team.
Use case 4
A group of sales reps is to sell one set of promotional offers and another group of sales reps is to sell the same set of promotional offers. Both sets of offers are of the same division. However, each group of sales reps belong to different vendor organization.
This scenario requires two Sales Teams and only a single Team Members.
Create the required user’s access (username/password) in the user section.
Since the reps are a part of two different vendor groups, create two Sales Teams. Assign the division and the promotional offer1 and promotional offer2 to Sales Team 1 and Sales Team 2 respectively.
Create a Team Members and assign to it all of the users selling both promotional offer1 and promotional offer2. Next, assign the division and both promotional offers1 and promotional offers2 to the Team Members. Last, assign the Team Members to both the Sales Teams.
Use case 5
A group of sales reps to sell two different sets of promotional offers. Both sets of offers are of the same division, but the group of reps belongs to different vendor organizations.
This scenario requires two Sales Teams, but only a single Team Members since it is the same group of reps.
Create the required user’s access (username/password) in the user section.
Since the reps are part of two different vendor organizations, create two Sales Teams. Assign the division and promotional offer1 to Sales Team 1. Similarly, assign the division and promotional offer2 to Sales Team 2.
Create a single Team Members and assign to it all of the users selling bothpromotional offer1 and promotional offer2. Assign the Team Members to both of the Sales Teams.
Set the Team Members as default so that all of the Offer Groups are assigned from both the Sales Teams.
Use case 6
A group of sales reps is to sell one set of promotional offers for a division and another group of sales reps is to sell different promotional offers for a different division. Both groups of reps belong to the same vendor organization.
This scenario requires a single Sales Team, but two Team Members.
Create the required user’s access (username/password) in the user section.
Since the reps are part of the same vendor organization, create a Sales Team. Assign both divisions and promotional offer1 and promotional offer2 to the Sales Team.
Create Team Members A and assign to it all of the users selling promotional offer1. Next, assign the first division and the promotional offers1 to Team Members A. Last, assign Team Members A to the single Sales Team.
Create Team Members B and assign to it all of the users selling promotional offer2. Next, assign the second division and promotional offer2 to Team Members B. Last, assign Team Members B to the single Sales Team.
Configure an offer group
Goal and overview
The goal of this guide is to show you how Offer Groups work, as well as how to configure them in Solicitor.
An Offer Group is a collection of offers, and an individual offer is a combination of a specific division at a certain price.
You construct an Offer Group with the inventory items you've created previously (sales products, marketing text templates, etc). The diagram below indicates which components are mandatory and which are non-mandatory. It also illustrates which components are needed for successful synchronization with both Subscribe and circulation systems.
Though you can publish an Offer Group with the minimum components, we suggest you create robust Offer Groups using as many components as you can.
Best practice note: We suggest creating Offer Groups as collections of Sales Products and divisions (publications). Creating them in this way allows you to still add unique prices, but minimizes the amount of duplication.
Each component of an Offer Group can be applied everywhere (to all) or be limited by either price plan (use for price plan) or individual divisions (select division). This gives you flexibility with how you apply your components.
Use the exceptions button to exclude particular divisions. Alternatively, limit by division and choose the specified division from the drop-down menu.
Before you start
Make sure you meet the following pre-requisites before starting the tutorial steps:
Create your inventory items (available areas, sales products, marketing text, and terms and conditions), being sure to configure defaults for marketing text, sales team and terms and conditions
Have payment methods, sales platform and market place configured in Solicitor application. Reach out to an implementation manager for this.
Create an Offer Group
In this section, you will learn how to create/edit/delete an Offer Group. The guide divides the steps into smaller, manageable chunks.
Offer Group can be saved as draft or published.
For the Draft offer group all the fields can be edited but the offer group cannot not be consumed by Subscription Panel. Published offer group can be used for Subscription Purchase but some fields cannot be edited, e.g. Product, Billing plan, Billing system codes, Term, Complimentary flag
The option to delete divisions that is available for Marketing Admin, Client Admin, MG2 Admin, MG2 Developer starting from Release 3.14.0.
Offer Group basics
Select the Offer Groups menu in the Solicitor dashboard. Any existing Offer Groups will display on the right.
Select the + button. The creation screen will appear.
Choose a name for your Offer Group.
Select save draft if continuing. Otherwise, select publish.
Products and divisions
Select the products box. Your sales products will appear to the right. Double-click or drag all corresponding sales products (e.g. 7 Day Delivery, Sunday Only, or Friday Only). Starting from 3.16.0 no more than one Base product is allowed in the Offer Group.
Select the divisions box. Your divisions will appear to the right. Double-click or drag all corresponding divisions (e.g. publication's name).
Select the price box. The price creation screen will appear to the right. Enter a price for the Sales Product+Division combination. NOTE: To price divisions differently, select the + tab directly to the right of the price box. This creates a separate tab for a new division/set of divisions. Add a division, then adjust it's price accordingly.
Select save draft if continuing. Otherwise, select publish.
Remove division from already published Offer Group
Starting from Release 3.14.0 onwards for Marketing Admin, Client Admin, MG2 Admin, MG2 Developer we developed an option to remove a division from an already published offer group.
If you belong to one of the Roles mentioned above then if you open a published Offer Group that has more than one division you will see an 'X' icon near every division. If you want to delete a division then hit the 'X' icon near the division you want to delete and click 'Update button'. The division will be deleted along with the related priceplan and all the related offers
Marketplace
Use this feature to determine the domain/URL on sales platforms where the offer will be sold. A default selection will use the division's default domain. You can add multiple URLs if you wish. Note: if nothing is used, your default marketplace will be used.
Select the marketplace box. Your maketplace options will appear to the right.
Choose how you wish to apply your sales platform:
-all - applies everywhere
-price plan - allows you to limit by price plan, then select which Markets for which Sales Platform
-division - allows you to select which Markets for which Sales Platform on any division
Select a sales platform from the drop-down menu.
Double-click or drag your desired sales platform to add to the Offer Group.
Select save draft if continuing. Otherwise, select publish.
Note: you can also adjust the sales platform from the additional options box.
Terms and conditions
Use this feature to add the a T&C template to your Offer Group. Note: if nothing is used, your default terms and conditions will be used.
Select the terms & conditions box. Your T&C options will appear to the right.
Choose how you wish to apply your T&C (for all, by price plan, or by division).
From the drop-down menu, select the sales platform you wish to apply your T&C to.
Double-click or drag your desired T&C to add it to the Offer Group.
Select save draft if continuing. Otherwise, select publish.
Marketing text
Use this feature to add a Marketing Text template to your Offer Group. Note: if nothing is used, your default marketing text will be used.
Select the marketing text box. Your marketing text options will appear to the right.
Choose how you wish to apply your marketing text template (for all, by price plan' or by division).
Double-click or drag your desired marketing text to add it to the Offer Group.
Select save draft if continuing. Otherwise, select publish.
Related offers
Use this feature to add related Offer Groups as upsell options to this Offer Group (e.g. the addition of a digital subscription to a Sunday Only subscription).
Choose how you wish to apply your related offers (for all, by price plan, or by division).
Select save draft if continuing. Otherwise, select publish.
The Upsell V3 component must be added to the presentation in the CMS for this feature to work properly.
Premiums
Use this feature to add premiums to your Offer Group. Premiums are individual additions to a Sales Product, like a free mug or $5 gift card.
Select the premiums box. The premiums screen will appear to the right.
Choose how you wish to apply the premiums (for all, by price plan, or by division).
Select the add premiums box. Your premiums options will appear to the right.
Double-click or drag your desired premium to add to your Offer Group.
Select save draft if continuing. Otherwise, select publish.
Coding
Use this feature to add, manage, or define unique codes that support your Offer Group.
Select the coding box. The coding options screen will appear to the right.
Choose the code type you wish to add (i.e. house hold levels, smart offer segments, multi-use codes, one-time use codes,custom codes, or billing system codes). The tables below define the coding options.
Select save draft if continuing. Otherwise, select publish.
House hold levels allows you to define entitlement levels (e.g. 1 typically refers to full access and 99 to no access.) You can apply house hold levels to either all or individual divisions.
Multi-use codes allows you to define whether a customer coupon-code can be used to access kind of special offer. These offers can be unlocked on either the Subscription Panel or in the CSR portal. On CSR portal there's a code field.
One-time use codes allow you todefine whether a single-use coupon code can be used to access a special offer.
To create a code, go to coding section in an already published offer group, select one time use codes and create your code's group in the code groups created field. Name your code, determine it's length, and the amount of codes desired. Select generate codes. You can only add codes, and the difference between the number of preexisting codes and codes desired will generate.
Custom codes refer to circulation dependent codes. The table below shows NCS Circ example codes. You can apply these codes to either all or individual divisions.
Custom codes
Definition
Prm Sub Src
Subscription sub source from NCS Circ (optional).
Source
Source code from NCS Circ.
Campaign code 1
Codes 4-10
Placeholders for additional functionality.
Billing system codes refer to codes associated with the circulation system. You can apply these codes to either all or individual divisions.
For systems using NCS Circ 2018.5 or greater, choose a rate code first. The rate-code options come in real-time from the circulation system, and the rate code field is searchable. Hover your pointer over the rate code for a description. After selecting a rate code, the fields below get pre-populated.
reason code
delivery method
term
length
source
If more than one option exists, a drop-down menu with the appropriate options appears.
The table below is an example from NCS Circ. Other circulation systems can be configured differently.
Billing System Codes
Definition
Rate code
The Offer Group's NCS Circ rate code (eg: VCD7HDCA)
Bill period
The billing type used (e.g. CCAuto or BankAuto)
Reason code
NCS Circ's reason code associated with the rate code (eg: 4DayLgTV)
Term
The billing term type (e.g. weeks or months).
Billing Method
The billing method used (e.g. Office Pay).
Term length
Associated with the Term: 1 for monthly term or 13/26/52 for weekly term.
Delivery method
The method of delivery. Either Route for print offers, or Online for Digital Only offers.
The next example is for Matrix Circ system:
Billing System Code
Description
Example Value
Rate code
Matrix's circulation code indicating the price of a subscription.
IT 6 MTHS
Copies
The number of desired copies.
1
Period
The term and length of the Offer Group.
6 MONTHS
TaxID
Matrix's tax code.
1
Additional options
Use this feature for miscellany such as address validation rules, and active subscription check, and payment methods.
The table below defines each section's use.
Additional options
Usage
Sales platform
Use this section to determine where the Offer Group will be sold.
Validity date
Use this section to select a start and end date for the Offer Group.
Offer Group code
Use this section to create a unique code to identify your Offer Group. This code can be referenced as a URL parameter direct customer to your Offer Group.
Term
Use this section to define the Offer Group's type of term and term length. Subscriber's will see this in their UI panel.
Pass or trial
Use this section to determine if the Offer Group is either a Free or Trial subscription.
Payment method
Use this section to determine the Offer Group's valid payment methods. Check all that apply. Note: These payment methods will apply to all divisions.
Address requirements
Use this section to determine which address type will be required of a subscriber. Billing address will require a billing address. Delivery address will require a delivery address. Run product delivery check will validate the postal code against the default available area configured in the Subscribe database.
Subscription validation
Use this section to determine other required validations for your Offer Group. No existing subscription at address would require the address to not be used for an existing subscription. No existing subscription stopped recently would require that the subscription wasn't stopped within {X} amount of days, with the amount of days configurable in MG2Control. No outstanding balance would require the subscription to not have an outstanding balance.
EZPay
Use this section to determine if your Offer Group accepts/requires EZPay (automatic payment renewal). Note: This section will apply to all divisions. EZPay required will require auto-renew. EZPay optional will allow auto-renew to be optional. No EZPay will disallow auto-renewal as a feature.
Tags
Use this section to add search tags to your Offer Group.
Old PID
Legacy promotion id.
Preview offers
You can preview the offers of your Offer Group with the preview button. Use the scroll arrows to navigate between offers. Select a section of the Offer Group to highlight it and preview that component. The preview will appear to the right.
What you've learned
Congratulations! You've created an Offer Group! To review, you've learned how to create an Offer Group, as well as explored all of the functionality of the Offer Groups menu.
Import or Export Solicitor Data
Goal
The goal of this guide is to show you how to export and import data in Solicitor Concierge. The feature is available for Admin users only.
There are two types of data that could be exported:
System Configuration - allows to export implementation settings; is available only for Naviga admins and developers
This feature will allow business users to set up all the Offer Groups and Offers they might want in test environment and then using export/import functionality copy those data to another environment in several clicks.
Before you start
Make sure you meet the following pre-requisites before starting the tutorial steps:
Have Subscribe version 3.13.1.1 or above
Please note that Import/export is only possible within matching version and subversion, e.g. you cannot import data exported from 3.14+ version to 3.13.1.1 and vice versa
Have Admin access to Solicitor Concierge - Import/Export of Offer Groups and related entities is available for the following Roles: MG2Developer, Client Admin, Client Power User, Marketing Admin, Marketing Power User
Tutorials
Export Solicitor Data
On the Solicitor Concierge dashboard, please select the 'Export' option in the upper right corner
Please select the data option you'd like to export in the Data Export dialogue box, and click the 'Export' button
Please wait until the export is complete, it might take a while. You can track the progress by watching the progress bar at the top of the screen. After the export is complete the system will open a dialog window when you can enter the export file name and choose a folder to store the file. Please note that the data will be exported as a JSON file.
Import Solicitor Data
On the Solicitor Concierge dashboard, please select the 'Import' option in the upper right corner
Please select the JSON file you'd like to import in the Data Import pop up, and click the 'Import' button.
If you want to import not the whole set of the previously exported Solicitor Data then please edit the exported JSON file. If you're using 3.13.1.1 version we do not recommend to delete entities except offer groups as this can damage the data.
The import process might take a long time, the progress will be reflected in the Data Import pop up. Also please note that the import process cannot be aborted - click on the 'Close' button in the Data Import pop up will only close the pop up but not abort the import process.
After the process is completed the summary of the process will be reflected at the pop up showing what entities were imported and whether the import was successful.
If you want more detailed info then you can click 'Download logs' and get the logs as an Excel file
Please note that if the imported file will contain an entity with the same name as an already existing one then the entity will be overridden during import
Reference tables
Goal and overview
This article explores the Reference Tables menu in the Solicitor Dashboard. The Reference Tables menu displays information about the following categories:
Coding
Household Levels
Sales platforms
Service Types
Billing plans
Besides the coding category, the information in the following categories comes from the Subscribe database and is populated in Solicitor with the sync button.
Reference tables
Coding
Use this section to view Multi-use (multiuse) and One-time-use (onetimeuse) codes.
The reference table will give you the name and type of code. Multi-use codes are customer coupon codes that can be used multiple times by different customers. Use them to allow customer's access to special offers. One-time-use codes are customer coupon codes that can be used a single time to give customers access to special offers.
Select the collapsed menu icon at the end of the line to view which Offer Groups are currently using the code. You can search and filter codes with the search and status fields.
Household levels
Use this section to view all house hold levels, their code, and it's active/inactive status.
Sales platforms
Use this section to view all created sales platforms.
Service types
Use this section to view all listed service types. Their name, description, short name, days of week, and active/inactive status display. Select the collapsed menu icon at the end of the line to view further details.
Billing plans
Use this section to view all listed billing plans. Note: the preconfigured billing plan is always named default with a billing period of 1.
Configure users, sales teams, and team members
Overview and goal
The goal of this guide is to show you how to configure the various user accounts in the Solicitor application:
Sales Teams consist of either one or more Team Members. The purpose of a Sales Team is give Team Members the ability to sell Offer Groups.
Team Members consist of either one or more Users and must be a part of a Sales Team.
As an admin, you must create your accounts in this order:
Users
Sales Teams
Team Members
This order is important because when you attempt to create Team Members, you must also assign them to a Sales Team (and therefore already have a Sales Team created).
Team Members can only sell the Offer Groups associated with their Sales Team. You can create multiple Team Members, both part of the same Sales Team, but each with distinct Offer Groups.
Diagram
This diagram shows the general relationship between users, team members, and sales teams.
An example
Let's say there exists five Offer Groups, one Sales Teams, three Team Members, and many Users. In this scenario, out of the five total Offer Groups, the Sales Team only has collective access to OG1, OG2, and OG3 (OG4 and OG5 are used in a Sales Team not discussed here).
Team Members 1 is part of the Sales Team, but only has access to OG1 and OG2, whereas Team Members 2 is part of the same Sales Team, but only has access to OG2 and OG3. In this scenario, Users will only have access to the Offer Groups that there Team Members group has access to, even if the Sales Team is associated with more Offer Groups.
However, Team Members 3 is designated as default, which means all of the associated Users will have access to all of the Offer Groups at the Sales Team level.
This example is visualized below as a spread sheet:
Before you start
Make sure you meet the following pre-requisites before starting the tutorial steps:
Ensure the default Sales Teams for the platforms Kiosk (LTE) and SubconAdmin have been created
Have admin privileges in your Solicitor account
Create a user
In this section, you will learn how to create a general user.
Create a user:
Select the admin menu in the Solicitor dashboard, then choose users. A list of Solicitor users will display.
Select the + new button. A creation window will appear.
Enter a user name, as well as an email address and password. User names must not contain special characters.
Select save.
Create a sales team
To create a sales team:
Select the teams menu in the Solicitor dashboard, then choose sales team. A list of sales teams will display.
Select the + new button. A creation window will appear.
Enter a name for the sales team (typically the vendor's name), then select the platform the team will be using.
Select the divisions box, then double-click or drag to add divisions the team will use.
Select the Offer Groups box, then double-click or drag to add Offer Groups the team will use.
(Optionally, if you've already created team members, you can add them to the team by selecting the team members box.)
Fill in any contact or bank account information and select save.
Create a team member
To create a team member:
Select the teams menu in the Solicitor dashboard, then choose team members. A list of team members will display.
Select the + new button. A creation window will appear.
Enter a name for the team member.
Select the team member box, then double-click or drag to add teams the member will be a part of.
Select the divisions and Offer Groups boxes, then double-click or drag to add divisions and Offer Groups the team member will use.
Select the users box, then double-click or drag the user to associate the user and team member hierarchies.
Select save.
What you've learned
Congratulations! You've created various types of users. To recap, you've learned about users, sales team, and team members, as well as how the three relate to each other.
Note: Currently, Naviga sends the following information to NCS Circ when new Subscription Purchases are made on either the CSR portal or Mobile LTE:
Source set at the offer group.
Team member name as the sub source
Delivery method set at the offer group.
Billing method set at the offer group.
Reason code set at the offer group.
Rate code set at the offer group.
If any client wants reporting on specific fields such as kiosk username, offer group name, etc., the data is available in the Subscribe database and can be leveraged as needed.
CSR User Guide
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Welcome to the CSR User Guide! Currently, the guides in this section provide detailed instructions for all the features of the following circulation systems:
NCS
Matrix
Each page's title indicates its circulation system in parentheses. Alternatively, please use the following table to determine if your circulation system supports a feature.
Account information
The Account Information tab displays information about the subscription/subscriber. From this tab, you can:
view account details, personal details, addresses, and products
update a subscriber's solicitation preference
restart a stopped subscription
Navigation
To view subscription information, fill the appropriate search parameter fields, and select search.
Find the desired subscriber/subscription from search results.
Select the start call button of the desired subscription result.
The application will prompt you to confirm the subscriber's email address.
Choose either no email, the subscriber's email, or add a new email address and select OK.
Account Information Definitions
These are the account information definitions. These values return in real-time, via API calls to either the circulation database or the Subscribe database. The Source column in the table below indicates the database that stores the information.
Account Details
Personal Details
Products
Addresses
Roles and permissions matrix
The matrix below defines the permissions of each user role available in Solicitor.
The amount of permissions decreases from left to right. A Kiosk Admin has more permissions than a Kiosk User, and a Marketing Admin has more permissions than a Power User, who has more permissions than a Limited User.
Note: You can edit and create new from the terms & conditions box. To do this, select unlink, make your changes, then select save as new.
Note: You can edit and create new from the marketing text box. To do this, select unlink, make your changes, then select save as new.
Select the related offers box. The related offers screen will appear to the right.
Select the upsell box. Your related Offer Groups will appear to the right.
Double-click or drag your desired related Offer Groups to add to your current Offer Group.
Smart offer segments allows you to specify that your Offer Group will be used as a Smart Offer. Check out the for detailed exploration. You can apply the Smart Offer segment to either all or individual divisions.
These codes exist only in the Subscribe database and will not be passed to a circulation database. To view the codes you created go to .
Campaign code from NCS Circ (optional). More details about campaign code starts can be found
Offer Groups - Offer Groups will be exported with their offers and include all the Offer Group components like Terms&Conditions, Marketing Text, Premiums, Codes, Available areas etc. Please see more information about the Offer Groups . Sales Team and user data will also be included in the export file.
You can from the Offer Groups menu.
Users is a fundamental account type. There are various types of user accounts, each with their own roles and permissions. View the for extensive definition.
The provides examples for six use cases. Check it out to learn more.
Select the role box then double-click or drag to add a role. Role types are defined . Only one role can be selected.
From the account information tab, you can also with the account update button and if it has been stopped.
Indicates whether the subscription renews automatically, for example, if the subscriber qualifies for EZ Pay.
Subscribe
Subscriber Since
Date of when subscriber began service (MM-DD-YYYY).
Subscribe
Subscriber Stop Date
Date of when subscriber ended service (MM-DD-YYYY).
Subscribe
Client
Name of the publication.
Subscribe
Trial
Indicates whether the subscription is a trial. Options are either yes or no.
Subscribe
Subscriber Status
Status of the subscriber's subscription.
Circulation (Subscribe for Matrix Circ users)
Next Publishing Date
Date the next publication is released in circ (MM-DD-YYYY). Only applicable to NCS Circ.
Circulation
Copies Until Expiration
Amount of subscription copies that a subscriber is scheduled to receive. If digital, days left of digital access. Only applicable to NCS Circ.
Circulation
Billing Method
Method of payment collection. Office Pay means their bill is paid to the office. Carrier Collect means the carrier collects payment upon delivery. Paid Comp and UnPaid Comp are complimentary subscriptions. Third Party refers to gift subscriptions. Only applicable to NCS Circ.
Subscribe
Delivery Method
Method of publication delivery. Options: RouteMailOnlineMixedHybrid. Only applicable to NCS Circ.
Subscribe
Term
Definition
Source
Company Name
Subscriber’s company name. Note: Subscriptions can be for either a company or an individual. Depending on the subscription type, either Company Name or First Name and Last Name will display.
Subscribe
First Name
Subscriber's first name. Note: Subscriptions can be for either a company or an individual. Depending on the subscription type, either Company Name or First Name and Last Name will display.
Subscribe
Last Name
Subscriber's last name.
Subscribe
Subscriber Email
Email address upon starting a subscription. Note: This may or may not be the subscriber's registered email, which a subscriber uses to gain access to digital subscriptions.
Subscribe
Primary Phone
Subscriber's primary phone number.
Subscribe
HH Sub Level
Means Household Subscription Level and refers to a numeric value that is associated with a subscriber’s entitlement access. The numeric values are not fixed and the client determines them. However, 99 typically refers to no access and 1 typically to full access. This field is editable.
Subscribe
Term
Definition
Source
Product ID
Product ID number.
Subscribe
Copies
Amount of copies of a given publication that a subscriber receives each delivery.
Subscribe
Product
Name of the subscription product. Note: this is not the name of the publication itself.
Subscribe
Service Code
Code that indicates the service type (e.g., 7Day refers to a seven-day delivery or SooooFS a Fri, Sat, Sun delivery).
Subscribe
Delivery Frequency
Frequency a subscriber receives a publication (e.g., a Wednesday and Friday delivery would be We Fr).
Subscribe
AddOn
Any additional services a subscriber receives (e.g., a digital edition in addition to a print subscription or an activation of a free product).
Please note that this document is currently under revision!
Click Subscribe Concierge button on One CSR Portal.
The user is redirected to Subcon Admin as shown below
Click Subscription Search option under Subscription Information tab.
Click Add Account and start call button to create a new account to buy a Subscription.
The user is redirected to the below screen.
Click Ok button on Choose email tab.
The user is redirected to another tab. On New start tab, the user can select Publication from the dropdown of the respective field.
Select Start type from the radio button options.
Sales team field is reset by default.
Select source from the drop down.
Select offer from the available list. Click Go to CSR start portal button.
The user is re-directed to the Subscription Panel.
Enter Name, Position, Company Name, Company Type, E-mail, Price, Registration Amount, Address, Zipcode, City and Phone number details. For Country and Currency fields, select the option from the drop-down.
Note: Registration Amount field represents the number of invites the subscriber willing to send.
Click Purchase button. The subscription is successfully purchased. The details are displayed as shown below.
To add new Registration, click User Accounts tab.
The user will redirect the user to enter the Login Name.
The user is traced based on Email id
The respective user details are displayed.
Click Add new subscription tab
The user can enter all the details to add the subscription.
Click +Add new owner button
The User Registration is done successfully. It is displayed on the above below along with all the details.
The user details are shown under Subscriptions tab.
Note: The registration for subscription is active with the verified email used for Registration email.
Sending Invites
Describes the procedure to create Bulk Invites on a single subscription
Please note that this document is currently under revision!
Retrieve the details of Registered user through Subscription Search option.
Enter Search criteria as Account or E-mail, otherwise enter any other three fields.
Click Search.
Click Start call button.
The below screen is displayed with all the user details
On Choose Email tab, select the registered email. Click Ok.
As shown below, on the Information tab, Buyer information(Account Details) and Subscription information(Personal Details) are shown.
The user will click Edit icon(pencil symbol) to update the values of any of the fields.
Click Digital tabto access the details.
On Registrations field, click Invite button.
The Invitation Module will appear to enable the entry of Invite details.
There are two ways to enter the details.
Adding the details manually.
Enter the information in the respective fields. First Name, Last Name, Email address and select User type. Click Send Invite.
Note: The limit of Invitations is determined by the text displayed as "Invitations remaining".
For example, in the below screenshot, the number of Invitations remaining are 22. The subscriber can send invites up to 22 people.
Click Add another person to invite to enter more than one invite user details at a time, manually.
The entered details are shown under the Pending Invites list as shown in the above screenshot.
Multiple Entries to Send Invites is allowed on a one-to-one basis.
Enter the Invite details and click Send Invite button.
Invite received to the recipient email
Enter the Invite details manually.
Click Send Invite button.
The Invite details are shown under Pending Invites list
As shown below, the invite receives the email to his/her respective email.
Click on the link provided "Click Here".
The user clicks the link provided link. The user will be redirected to the page to register for the subscription or to subscribe for the same.
Wrong format of entering Invite details
The user enters the details in the wrong fields, for example, Email details under First name and vice-versa.
When Send Invite is clicked, the following error is shown.
Invites can be sent by uploading a CSV file
On Invitation Module, click Import from CSV button.
A dialog box will appear for Bulk Invitations Import.
Click Find File. The user can browse on his device and select the file.
It appears on the space provided.
Click Upload button.
The list of users imported from CSV files are shown. Click Send Invites.
As shown below, all the respective invite details are displayed under Pending Invites section.
The user can Resend Invite or Remove the invite as per the requirements.
Click Resend Invite.
The respective user will receive subscription invite again from the subscriber.
Click Remove button against the Invite details as shown below.
The application requests the confirmation from user. Click Ok.
The Invite details are removed from the Pending Invites list as shown below.
Wrong format of organizing Invite data in CSV file
Find the sample of CSV file format as shown below. The data is organized in a columnar format.
On Invitation Module, click Import from CSV button.
A dialog box will appear for Bulk Invitations Import.
Click Find File. The user can browse on his device and select the file. It appears on the space provided. Click Upload button.
As shown above, the data has validation errors because of organizing data in the wrong format.
Note:
The user sends multiple subscription invites via CSV file upload.
The end users gets email to complete the registration (GDPR consent, create password and gets linked to the subscription)
Click Show Entitlements button at the bottom of the screen to check the list of entitlements allowed to the user.
End user Newsletter Management:
User can login and manage opt-in /opt-out to the preferences individually.
The end user is able to opt out of GDPR consent
The end user is able to Unsubscribe all.
Disclaimer Management
Goal
Business users would now be able to manage disclaimers to be displayed to CSR rep via Subscribe Concierge Admin portal. This is available under ‘Client management’ section of One CSR portal.
This feature is implemented in phases, where Phase 1 covers search, edit, view, import/export disclaimers and phase 2 covers adding and deleting disclaimers as well as minor enhancements.
In scope of the current document is Phase 1 only.
Pre-requisite Information
Minimum Subscribe version required is 3.13
CMS Attributes are supported in disclaimers starting from 3.14
Search and View is allowed for: CSR Admin, CSR Admin, CSR Power User
Navigation
The ‘Manage disclaimers’ subsection is added to ‘Client management section’ of One CSR portal. Disclaimer search section has single-selection filter and a search field. The dropdown filters disclaimers against their properties:
Disclaimer Code
Description
Event Type Id
Event Code
A single event can have multiple disclaimers, if multiple disclaimers exist for an event display all the associated with disclaimers
Search field only becomes enabled when a filter option is selected in a filter dropdown. It performs search against the disclaimer property selected in the dropdown filter.
Disclaimer search
To perform a search please select an option from a single-selection dropdown filter, type something in search input (this one is optional), and click 'Search' button. You will see a result set of disclaimers matching the entered criteria, ordered by Event Type Id (asc)
If no search criteria is selected and the user clicks search all the disclaimers must be displayed ordered by Event Type Id (asc)
Disclaimer view and editing
To view/edit a disclaimer please click 'Edit' button in the right column - this will open the pop up with disclaimer in a Preview mode. If you want to edit a disclaimer then click 'Edit' button in the pop up. It will open a WYSYWIG editor.
To go back to the preview mode and review the changes you made please save your changes and then click 'Preview' button in the pop up.
Please note that if you want to switch to the Preview mode or close a disclaimer having unsaved changes you will see a warning message
Disclaimer import/export
To export a disclaimer please select the one you want to export from the dropdown and click 'Export'
The export dropdown is multiselectional so several disclaimer can be selected at a time
To import disclaimer(s) please click 'Import' button and select the disclaimer(s) you want to import in the dialog window, and then click 'Open'.
Subscription Search
This guide will introduce you to the Subscription Search feature of the Subcon Admin Portal. Subscription Search allows you to search for and manage subscriptions.
Find a Subscription
To find a particular subscription:
Select the subscription search button on the left side of the window.
Fill in the appropriate search parameters.
Select the search button.
A list of matches will display.
Find the desired subscription from the search results and select either research or start call
Though including client in your search query can be helpful, you cannot search by it exclusively. Attempting to do so will return an error, and the mandatory fields will be highlighted. Populate at least one mandatory field in addition to client for a successful search. In general, the more detailed your search parameters, the more precise and quick your return will be.
Research
The research feature displays a read-only overview of the subscription. You can view account information, digital subscription information, and search the account's history of events, filtering the events by type and time. This feature does not start a call.
Start Call
Note: The client can configure whether the start call feature prompts you to confirm a subscriber's email address. You can enter a new email (other), select a registered email from the drop-down menu, or choose no email. The email address you choose (new or registered) will become the selected email for this call. This email address will be recorded in the event log and will receive a confirmation of events that occurred during the call.
End Call
To end a call, select the end call button in the upper right corner of any tab.
Query Parameter Definitions
Subscriber's billing address. To edit addresses, check out this .
Subscriber's delivery address. To edit addresses, check out this .
The start call feature allows you to manage subscription information. You can process requests, update information, review events, etc. Likely, you will find yourself using this feature in most scenarios. By default, the feature displays the tab.
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
These features are for NCS.
Digital Product Management
You can manage a subscriber's online access from the digital tab. From this tab, you can:
edit a subscriber's digital registration
add or remove another user to a subscriber's digital subscription
view a subscriber's digital entitlements
Navigation
Invite a user to share registration
To invite a user to share registration:
Select the invite button next to any user in the registrations grid. A window appears that indicates the amount of remaining registered users. If the user has remaining invites, continue to the next step. Otherwise, you cannot proceed.
Add the new users first name, last name, and email address. Select either owner or guest as the user type. This determines the amount of privilege the user will have.
(Optionally, if owner is chosen, confirm the disclaimer to the subscriber and check the disclaimer box.)
Select the send invite button. An email will be sent to the specified email address and the record will appear in the pending invites grid.
Use the add another person to invite and remove the last person added buttons to send multiple invites at once!
To re-invite a user whom has not accepted their invitation:
Select the invite button next to any user in the registrations grid. The pending invitations grid will appear.
Select the resend invite button next to the desired user. An email will be resent to the user.
To remove a pending user:
Select the invite button next to any user in the registrations grid. The pending invitations grid will appear.
Select the remove button next to the desired user. The user's invitation will be removed from the pending invitations grid and their invitation will become invalid. This request is processed in real-time with the circulation system.
Edit a user's registration information
To edit a user's registration information:
Select the edit button that corresponds with the user in the registrations grid.
Toggle whether both the email address and password should be changed. If keeping current, select keep current and do nothing. If changing, select set to... and add the new password or email.
Select the update button next to either the new password or email.
Remove someone from shared registration
To remove a user from shared registration:
Select the invite button next to any user in the registrations grid.
Navigate to the current members grid.
Select the remove button next to the desired user.
Registrations grid
Term
Description
Login name
The user's login name, always the user's registered email address.
State
If registration is verified then [State] = "Standard" else [State] = "Unverified"
Type
Either owner or Guest. Indicates the amount of access the user has.
Change date
The date and time the change occurred (MM-DD-YYYY HH-MM-SS AM/PM).
Select the details button to view the manage registration grid.
Term
Description
Account number
The subscriber's circulation account number.
Subscriber
The subscriber's Naviga Subscriber identification number.
Full name
The subscriber's full name.
Active
Indicates whether the account is active.
Type
Indicates the type of access the user has. Owner = full, Guest = limited.
Address
The subscriber's billing address.
Entitlements grid
To view the entitlements grid, select the show entitlements button.
Term
Description
Newspaper ID
The newspaper's identification number.
Newspaper name
The newspaper's name.
Household level ID
The household subscription level identification number.
Household level
Means Household Subscription Level and refers to a numeric value that is associated with a subscriber’s entitlement access. The numeric values are not fixed and the client determines them. However, 99 typically refers to no access and 1 typically to full access. This field is editable.
Entitlement ID
The entitlement's identification number.
Entitlement code
The entitlement's database code.
Entitlement description
Description of the entitlement, e.g. eEdition Access.
You can find more about entitlements here
Registration Management
CSRs now have the option to edit the customerRegistrationID field by using the Search feature under the User accounts module in the menu as well as using the Subscription Search under the Subscription Information module when starting a new call in the 'Digital' tab.
User accounts:
Subscription search:
Important:
When the CSR edits the customerRegistrationID it will update Naviga's Registration tables. It will NOT update Auth0 and is not expected to update any other third party service.
No event type is fired.
No historical data is retained.
Delivery Issues and Delivery Management
This guide explores the complaints tab, which displays information about delivery management and delivery issues. From this tab, you can:
view a subscription's complaint history
create a new complaint
relay messages to carriers and district managers
This guide also contains instructions for creating new complaints and adding delivery messages.
Navigation
Record and Process Delivery Issues
The add new delivery error feature allows you to process subscriber complaints. It displays product information and a redelivery window. The displayed information integrates in real-time with the client's circulation system.
Helpful Information
Here are some helpful pointers for recording and processing complaints.
Subscribers cannot make complaints before the redelivery window on the same day. They can inside or after the redelivery window.
Subscribers cannot make complaints during vacation days.
Record a Complaint
To record a complaint:
Select the calendar icon and choose the complaint date(s). The client determines the number of days back, as well as the number of complaints you can select.
Select an error type that corresponds with the subscriber's complaint. Use your best judgment to match the subscriber's issue with an error from the drop-down field.
Choose a resolution for the subscriber that corresponds to the workflow and client's rules. To choose Redelivery, the complaint must not have been made before the redelivery window.
Read the disclaimer text to the subscriber and check the Disclaimer read box.
Select save. If successful, the record will appear in the complaints box.
Subscription Complaint History
The complaints grid at the top of the page displays a history of complaints and sorts them by incident date. Clients configure the incident date range of complaints (e.g., display complaints with incident dates of today and 30 days prior).
This means it is possible for a new complaint to not appear in the grid if their incident date falls out of the client's configured range.
The table displays the following categories: Transaction ID, Incident date, Complaint description, Complaint option, Credit value, and Escalated. An escalation status of yes occurs when a certain number of complaints are created within a certain amount of days.
Add Delivery Messages and Instructions
This feature allows you to create customized, real-time messages for carriers and district managers. You can create:
one-off notes for special instructions for carriers and district managers
permanent, placement delivery instructions
general delivery instructions
The message/instruction is added into the circulation system in real-time. It may take up to 24 hours to reflect the added message on the screen
Create Carrier and District Manager Messages
Message types are configurable and add context to the message (e.g. a message concerning the route or ZIP code). The maximum message length is 140 characters.
To create a carrier or district manager message:
Select the add new button under the Carrier & district manager messages section.
Chose a message type from the drop-down menu.
Enter a message in the text box.
Select save.
Confirm your message and select OK.
Create Permanent Delivery Messages
This feature creates permanent, placement instructions (e.g. door delivery or double bag when wet). Only one permanent message is allowed per account, and the message options are predetermined. Once added, messages can be updated or removed after the next publishing date.
To create a permanent delivery message:
Select the add new button within the Permanent delivery messages grid.
Choose a date and message from the drop-down menu.
Select save.
Confirm your message and select OK.
Create Delivery Instructions and Directions
These are editable text boxes that you can use to create general carrier notes (e.g. Corner of Melrose and 1st St or backhouse). The maximum message length is 140 characters.
To create new instructions or directions:
Select the add new or edit button.
Enter your message.
Select save.
You can have one instruction and one direction. The messages will remain until you edit or delete it.
Broadcast Messages
Broadcast Messages are customer service messages displayed on Subscribe's CSR portal and/or Account Management.
The messages are broadcasted from NCS Circ to all accounts that are experiencing delivery problems so they are usually called Late Route Messages. The information is returned in real-time from NCS Circ.
This feature makes the user aware of the delivery issues they might experience and hence decreases the number of the submitted complaints.
Pre-requisites
Minimum 2018.5 NCS version is required
Minimum Subscribe version required is:
Subscribe 3.5 for One CSR Portal
Subscribe 3.14 for Account Management
Description
Subscribe calls NCS's GETroutedeliverydelays endpoint sending the number of the account and the code of the application (Account Management and/or One CSR Portal) to display broadcast message(s) in real-time. The messages display on the account as long as they are broadcasted in NCS, and disappear when they are deleted in NCS circ.
Please note that there the broadcast messages are filtered against the application so One CSR Portal and Account Management can have different broadcast message(s)
In One CSR Portal the Late Route messages are displayed above the tabs
In Account Management these messages are displayed on a Delivery Issue page where the user can submit a complaint.
Setup guide
Please follow the steps below:
Please create a ticket for the Implementation manager to configure the feature. Important implementation details can be found below.
Ask your Project Manager to create Late Route messages in NCS. Please remember to specify whether it should be One CSR Portal and/or Account Management. The Late Route messages should be displayed in One CSR portal and/or Account Management in real-time. Please see the guide below.
Implementation details
To turn this feature ON for Account Management the Subcon. Configuration property DisplayDeliveryDelayMessages inside Complaint module should be set to true (true by default).
To turn this feature ON for One CSR portal the StartCallRouteDeliveryDelays appsetting should be set to 1.
The method should send SubscriptionId and/or AccountNumber, and ComplaintSource (DSICode from Apptypes table) in the request. For the response please see the example below:
{
"Response": {
"ErrorNum": "",
"ErrorMsg": "Success",
"Result": [
{
"DelayFlag": true,
"DelayMessage": "Printing was delayed so trucks are running 2 hours late."
},
{
"DelayFlag": true,
"DelayMessage": "Test Message 1 not including address"
}
]
}
}
The response returns the messages that meet the following criteria:
‘Broadcast To’ is either Customer Service - will be displayed in One CSR portal, and/or iServices Subscriber - will be displayed in Self-Service
Message is not expired, i.e.Start Date is less than MAX (PublishingDate/TODAY) and EndDate is NULL or greater than MAX (PublishingDate/TODAY), where MAX (PublishingDate/TODAY) means latest of publishing date or calendar date
Subscription starts before publishing date
Broadcast messages setup in NCS circ
In NCS circ go to Messages tab. At this tab you can add a new broadcast message as well as view existing broadcast messages, modify them or delete them.
To add a new broadcast message please click 'Add' buttton and specify the following:
Message information section
Product - please select the product for which the message should be sent.
Start date, End date - please enter the date range during which the message should be distributed, End date may be left blank
Selection type - please select the distribution type for this message (could be district, truck, route or all). Messages with Selection Type = All will be displayed to all subscriptions including those with delivery methods Online and Mail
Selection - enter the specific truck, district, route or delivery method for which the message should appear. E.g. if you have specified the route in the Selection then enter the exact route number here.
Message - add the text of the message
Message Usage section
Print on - this section has options used by NCS operational staff. Leave this section blank
Broadcast To - please select the following
'Customer service' - the message will be displayed in One CSR portal
'iServices Subscriber' - the message will be displayed in Self-Service
Broadcast time section - here you can set the exact time the message should be broadcast during the selected date range. Please enter the time and specify whether each is AM or PM
After all the required information has been entered please click 'Ok' to save the changes and start broadcasting.
Create a new subscription
This guide describes and provides instructions for creating new subscriptions.
Navigation
Create a new subscription
Account registration is not created at this step. The subscriber does this on their own via self-service or the publication's website.
Part 1
After selecting the +add account and start call button:
Select either no email or add an email with other email. This email address will be the selected email address. It will be recorded in the event log and a confirmation of events will be sent to it.
Select the publication name from the drop-down menu.
Select a start type. Voluntary displays offers associated with your sales team and code displays offers associated with that particular code.
Select the source of the subscription from the drop-down menu.
Select the email only offer. Filter the results with the search and postal/ZIP code fields.
Select go to CSR portal.
Part 2
The order in which information is collected depends on the presentation set up in the CMS.
You will be taken to the New Start Portal. From this screen:
Enter the subscriber's address information and select continue. Note: Digital ZIP-only and digital subscriptions will require only a postal code.
Enter the subscriber's payment information and select continue. Payment information is not required for both complimentary and start-and-bill subscriptions.
Confirm the subscriber’s address and payment information then select place your order.
This procedure is a best-practice example. The order in which a subscriber's payment and address information is collected may change, depending on how the client has configured their CMS.
Update Solicitation Preference
You can manage a subscriber's solicitation preference in the account information tab. From this tab, you can:
add a subscriber to a do not call, email, or TMC list
edit a subscriber's solicitation preference
delete a subscriber's solicitation preference
Due to some issues found in the batch mode we strongly recommend using real-time mode (Flow.TrackingCodes in mg2control).
Please note that as the batch mode is not being used it is planned to be deprecated starting from 3.16.3 together with the corresponding mg2control setting. The real-time mode will be the only version of the flow
Navigation
Add a new solicitation preferences
After selecting the account update button:
Select a type, then select add new.
Select a category to change the solicitation preference. TMC refers to telemarketing.
Choose a stop date. (Optionally, choose a resume date. If left blank, the subscriber is added to the list indefinitely.) New solicitation preferences cannot have overlapping dates and share a category.
If desired, leave a remark in the text field (100 characters). Select submit. The request is processed in real-time with the circulation system. The subscriber's solicitation preference is removed, but a record remains in the account update grid as an audit trail.
Change a solicitation preference
After selecting the account update button:
Select the edit button next to the corresponding solicitation preference.
Change any of the following: stop date, resume date, remarks. If the preference has already begun, only the resume date and remarks fields are editable.
Select save. The request is processed in real-time with the circulation system.
A solicitation preference's category (do not call, do not email, do not TMC) cannot be changed with the edit button. To change a category, delete the solicitation preference, and add a new preference with the desired category.
Delete a solicitation preference
After selecting the account update button:
Select the remove button next to the corresponding solicitation preference.
Confirm you wish to delete the preference and select OK. The request is processed in real-time with the circulation system, and the preference is removed from the account update grid.
Account update grid
The accounted update grid displays all of a subscription's solicitation preferences.
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
To view the digital tab, perform a , and then select the digital tab.
To view the complaints tab, perform a , and then select the complaints tab.
This feature is highly configurable and clients define their own rules. This can help determine when to record and process complaints.
This feature is found in the window. Navigate here and select the +add account and start call button to create new subscriptions.
See also:
View this diagram for a visual representation of the solicitation preference feature.
To view the account information tab, perform a , and then select the account information tab. Select the account update button to display a subscription's solicitation preferences.
The code that corresponds to the solicitation preference's category (e.g. NoEMail, NoCall, NoTMC). These codes are configurable in the circulation database.
Stop date
The date when the solicitation preference begins (MM-DD-YYYY).
Resume date
The date when the solicitation preference ends (MM-DD-YYYY). Note: This field is optional. A solicitation preference can continue indefinitely.
Remarks
Any comments a CSR or subscriber left.
Change date
The date when the solicitation preference record was created or changed. (MM-DD-YYYY).
You can manage a subscriber's product from the offers tab. From this tab, you can:
upgrade a subscription
downgrade a subscription
Navigation
Upgrade a subscription
To upgrade a subscription:
Select the change offers button. The upgrades/downgrades grid will appear.
Select the upgrades tab and choose when to perform the upgrade: Immediately, Next Publishing Date, or Select a date. If selecting a date, use the calendar icon to pick a date.
Choose an offer from the list. The arrow button expands to display more information about the offer. (If the upgraded offer requires a delivery address or if the billing address is not routable, address fields will appear. Fill them in.)
Confirm the disclaimer with the subscriber and check the disclaimer box.
Select the upgrade offer button. The upgrade is processed in real-time with the circulation system.
Downgrade a subscription
To downgrade a subscription:
Select the change offers button. The upgrades/downgrades grid will appear.
Select the downgrades tab and choose when to perform the downgrade: Immediately, Next Publishing Date, or Select a date. If selecting a date, use the calendar icon to pick a date.
Choose an offer from the list. The arrow button expands to display more information about the offer.
Confirm the disclaimer with the subscriber and check the disclaimer box.
Select the downgrade offer button. The downgrade is processed in real-time with the circulation system.
Current products grid
Term
Description
Product
The name of the product offer.
Price
The amount the subscriber pay's for the product.
Quantity
The number of offers subscribed to.
AddOn
Indicates whether the offer has any additional services.
Taxable
Indicates whether the product is taxable.
Delivery method
Method of publication delivery. Options: RouteMailOnlineMixedHybrid
Start date
Date of when subscriber began service (MM-DD-YYYY).
Stop date
Date of when subscriber ended service (MM-DD-YYYY).
Upgrades/downgrades information
Term
Description
Offer ID
The offer's identification number.
Internal name
The offer's internal description.
Confirmation name
The offer's confirmation name.
EZ pay
Indicates whether the offer supports automatic renewal.
Quantity
Indicates the number of products.
Title
In the expanded details, the name of the offer.
Body
In the expanded details, the description of the offer.
Price
In the expanded details, the price of the offer.
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
Billing and payment management
This guide explores the payment and billing management functionality of the SubCon Admin Portal. It describes and provides instructions for each feature of the payment/billing tab. You can:
view a subscription's billing status, saved payment methods, and transactions
make payments and update payment methods
opt subscriptions into automatic renewal (auto-renew)
switch auto-renew subscriptions back into invoices
opt subscriptions into/out of an electronic bill (eBill)
Tip: To quickly show an accounts current balance, select the show balance button in the upper right corner. If the displayed number is negative, the account is past due.
Navigation
Grids
Status Details
The status details section of this tab displays information about a subscription's status. These values are processed in real-time. The source column indicates which database the values come from, either Subscribe or Circulation.
Term or phrase
Description
Source
Auto-renew
Indicates whether the subscription is enrolled in automatic payment renewal. Values can be either Yes or No.
Subscribe
Payment method type
The payment method used for the last transaction (e.g. CreditCard or BankDraft) Note: this field applies to subscriptions that are not currently enrolled in auto-renew.
Circulation
Current payment method
The last four digits of the payment's account number. Note: will only display if subscription is enrolled in auto-renew.
Circulation
Expiration date
The date at which the subscription expires (MM-DD-YYYY). Note: For NCS Circ clients, the expiry date and paid thru date are same.
Subscribe
eBill
Indicates whether the subscription is enrolled in an electronic/paperless billing system. If so, the email address that is invoiced will display here.
Subscribe
Saved Payment Methods
The saved payment methods grid displays a subscription's saved payment methods. The values come in real-time from the circulation system.
Term or phrase
Description
Payment method type
Indicates the type of saved payment method (e.g., CreditCard or BankDraft).
Account number
Either the masked credit card or bank account number.
Subscription Financial Transactions
The subscription financial transactions grid displays a subscription's transaction history. Use the drop-down menu to apply length filters. Select the icon in the details column to view detailed transaction information.
The values come in real-time from the circulation system.
Transaction Terms
Term or phrase
Description
Amount
The total amount of the transaction.
Transaction type
Indicates whether the transaction is auto-renew (AutoPay), a one-time payment (Payment), or a declined payment (PymtDecline).
Payment method
Indicates whether the payment method was Bank Account, Credit Card, Check or Cash.
Status
Indicates whether the payment was completed (Captured) or declined (Declined).
Add date
The date the transaction was made.
Details
Select this icon to view detailed transaction information.
Detailed Transaction Information To view these details, select the icon in the details column. Important: The payment amount includes any adjustments, coupons or discounts.
The values come in real-time from the circulation system.
Term
Description
Transaction ID
Transaction's identification number
Payment amount
Cost of the subscription before tax and tip.
Tax amount
The tax of the subscription.
Tip
Optional tip added on top of the subscription.
Adjustment amount
A credit or debit made to the account’s balance but unrelated to the subscription cost (e.g. an activation fee). There can be multiple fees. Only the total displays. Note: This value will only be included in the total amount if cash flag = Yes in the circulation system.
Coupon amount
A percent or flat amount reduction off the price of a subscription indicated by a detachable voucher. Note: This value is not included in the total amount.
Discount
The difference in price from the immediately previous transaction.
Bank name
The name of the subscriber's bank. Note: This field only appears if payment method is Check or Bank.
Check number
The check number of the particular payment. Note: This field only appears if payment method is Check.
Bank number
The bank number of the particular payment. Note: This field only appears if payment method is Bank.
Payments
Make a payment
For security reasons, a CSR Rep can only make one payment every 24 hours.
To make a payment:
Select the make a payment button.
Choose a payment term and rate.
Confirm whether the subscriber wishes to add a tip.
Confirm whether the subscriber wishes to enroll in auto-renew. If so, check the auto-renew box.
Confirm the disclaimer text to the subscriber and select a payment method.
Enter the payment information details and select Submit. The request is processed in real-time with the payment provider and NCS Circulation system.
Note: The activation fee is a flat fee applicable to subscriptions not currently enrolled in auto-renew. The fee amount is configurable in the Subscribe and Circulation databases.
Auto-renew
Opt into auto-renew
For security reasons, a CSR Rep cannot opt a subscription into auto-renew if a payment has been made in the last 24 hours.
To opt a subscription into auto-renew:
Select the auto-renew sign up button. The sign up form appears.
Confirm a payment term with subscriber. Term is the number of weeks per billing cycle. Total payment is the amount due today.
Confirm the disclaimer text to the subscriber and select pay with credit card.
Enter the credit card details and select submit. The request is processed in real-time with the circulation system.
The new payment method will appear in the saved payment methods grid after selecting the refresh button.
Update a payment method
A CSR can update the payment method of the subscription that's on auto renew.
This feature allows you to update a payment method (e.g. switching credit cards) or change a payment method (e.g. switch from a credit card to a bank account).
To update or change a payment method:
Select the update payment method button. The feature appears.
Confirm the disclaimer text with the subscriber.
Determine if the subscriber will update or change their payment method. If only updating, select the continue with… button. If changing, select the switch to… button.
Fill in the new payment’s information.
Select either submit or save, depending on which option the subscriber chose. The updated payment information is processed in real-time with the circulation system.
The new payment method will display in the payment method grid on the next published day.
Switch to invoice
To switch to invoices:
Select the switch to invoice button.
Confirm the disclaimer text with the subscriber.
Select submit. The updated information is processed in real-time with the circulation system.
eBill
Opt into an eBill
You can opt subscriptions into an eBill only if they are not enrolled in auto-renew.
To opt a subscription into an eBill:
Select the eBill sign up button. The sign up form appears.
Verify the email address. If a subscription email is recorded, that will automatically populate here.
Confirm the disclaimer text to the subscriber and select submit. This request is processed in real-time with the circulation system. The new email address will populate in the eBill field under Status Details.
Update an eBill email address
Once a subscription has opted into an eBill, the corresponding email address can be updated in the status details section. Select the pencil icon the eBill row and enter a new email address. Any change will occur in the Circulation system in real-time.
Opt out of an eBill
To opt a subscription out of an eBill:
Select the cancel eBill button.
Confirm your decision and select OK. This request is processed in real-time with the circulation system. The email address will be removed from the eBill field under Status Details.
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
Address management
This guide explores address management features of the SubCon Admin Portal. It describes and provides instructions for each feature of the move tab. You can:
update a delivery address
update a billing address
cancel a scheduled address change
Note: The feature to update/add an address for a no-address starts is currently under development and will be supported in a future release.
Navigation
Update a billing address
To update a billing address:
Select the edit button under the billing address column.
Enter the new values for each section of the billing address.
Select the calendar icon and choose a date for when the address change should occur.
Confirm whether the subscriber wishes to apply the change to delivery address. If so, confirm the address is deliverable, check the box, then confirm the disclaimer. Otherwise, skip this step.
Select save. The change is processed in real-time with the circulation system and the address change appears in the scheduled address change grid.
Please note that only one address change can be created for the same date
Update a delivery address
To update a delivery address:
Select the edit button under the delivery address column.
Enter the new values for each section of the delivery address.
Select the calendar icon and choose a date for when the address change should occur.
Confirm whether the subscriber wishes to apply the change to the billing address. If so, check the box and confirm the disclaimer. Otherwise, skip this step.
Select save. The change is processed in real-time with the circulation system and the address change appears in the scheduled address change grid.
Note: If a non-deliverable address entered, you will receive an error. The address must be within the delivery route.
Cancel a scheduled address change
To cancel a scheduled address change:
Navigate to the scheduled address change grid.
Select the cancel button that corresponds with the scheduled change. The cancellation is processed in real-time with the circulation system.
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
Temporarily stop a subscription
This feature allows you to pause a print delivery. It functions as a temporary hold of a subscription.
Temporary stops cannot overlap with other stops or transfers. You can edit or cancel existing temporary stops in the scheduled stops/starts grid.
Minimum NCS version required for this integration is 2020.3
Navigation
Helpful Information
Here are some helpful pointers when creating or updating temporary stops.
Temporary stops must comply with the vacation cut-off times table.
For example:
Sun for Mon | 07:00 PM Sun translates to For a Monday stop, the cutoff must occur by 7:00 PM Sunday.
Reason, hold, and donation options come in real-time from a circulation database.
Some common hold options are VacPack, credit, and donation. VacPack refers to a vacation package where the physical product will be delivered after the vacation. Sometimes donation allows the subscriber to specify where a donation goes. Credit extends the subscription's expiry date in accordance with the number of paused days.
Create a Temporary Stop
To create a temporary stop:
Select temporary stop. The add new temporary stop feature appears.
Choose a stop date and resume date. Adhere to the vacation cut-off times table.
Choose a reason from the drop-down menu.
Select a hold option.
Confirm the disclaimer text to the subscriber and select submit. The temporary stop is processed in real-time with the circulation system.
Update or Cancel a Temporary Stop
If a temporary stop has already been created, you can only edit the end date (and not the start date). To edit the start date, cancel the temporary stop, and start anew.
To cancel a temporary stop:
Navigate to the scheduled stops/starts grid.
Select the cancel button next to the corresponding temporary stop.
Confirm you want to delete the record and select OK. The cancellation is processed in real-time with the circulation system.
To update a temporary stop:
Navigate to the scheduled stops/starts grid.
Select the change button next to the corresponding temporary stop. The change a temporary stop function appears
Choose the updated dates for the temporary stop, being sure to adhere to the vacation cut-off times chart.
Select submit. The update is processed in real-time with the circulation system.
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
To view the offers tab, perform a , and then select the offers tab.
To view the payment/billing tab, perform a , and then select the payment/billing tab.
You can make one-time payments only on subscriptions not currently enrolled in auto-renew. View this for a visual representation.
View this for a visual representation.
View this for a visual representation.
This provides a visual representation.
To view the move tab, perform a , and then select the move tab.
Starting from the version 3.13 in case non-deliverable address is entered and there is a digital downgrade offer assigned to this subscription - the user will be offered an option to downgrade to digital only offer. Please see more information about downgrade flow in our documentation.
You can find this feature under the stop tab. To navigate here, perform a , and then select the stop tab.
This can help determine how and when to process temporary stops.
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Welcome
Welcome to the Subscription Panel User Guide!
The Subscription Panel is an application that allows potential customers to purchase subscriptions. You can manage the look, feel, and content of the Subscription Panel in the CMS. Every detail is manageable, from what offers display to what colors are used.
Guide structure
This guide is composed of the following main elements:
Overview - gives a brief introduction to the various features covered in this guide
Tutorials - task-based guides for common Subscription Panel tasks
Redirect to classic portal
For any features not yet supported in the CSR Portal, you can use the lookup classic portal button to navigate to the classic portal.
Prerequisites
Before you can redirect to the classic portal, complete the following prerequisites:
Submit database names to Naviga for implementation.
Reach out to Naviga Implementation Manager to get this implemented in your environment.
Establish a reference between the classic portal and the CSR portal. Instructions for this task are below.
Log into both instances before selecting the lookup classic portal button.
To establish a reference between the classic portal and the CSR portal:
Configure usernames and KeyID in all NCS Circ instances.
Add the CSR username to the Subscribe Portal.
Add the NCS KeyID to the CSR username in the Subscribe Portal:
Select users in the CSR Portal.
Select the pencil icon that corresponds to the desired username.
Add the NCS KeyID in the key id field.
Select save.
Redirect to the classic portal
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
Create a vacation transfer
A vacation transfer allows you to temporarily change a print subscription's delivery address.
Transfers cannot overlap with other stops. You can edit or cancel existing transfers in the scheduled stops/starts grid.
Navigation
Helpful Information
Here are some helpful pointers when creating or updating vacation transfers.
Transfers must comply with the vacation cut-off times table. For example:
Sun for Mon | 07:00 PM Sun translates to For a Monday transfer, the cutoff must occur by 7:00 PM Sunday.
If the temporary delivery address is within a delivery route, a carrier will deliver the subscription per usual. Otherwise, the subscription will ship via mail and may lead to a later delivery.
Create a Vacation Transfer
To create a vacation transfer:
Select vacation transfer. The add new vacation transfer feature appears.
Choose a stop date and resume date. Adhere to the vacation cut-off times table.
Enter a temporary delivery address into the corresponding fields.
Select a transfer reason.
Confirm the disclaimer text to the subscriber and select submit. You will see the scheduled transfer in the scheduled stops/starts grid. The vacation transfer is processed in real-time with the circulation system.
Update or Cancel a Vacation Transfer
If a vacation transfer has already been created, you can only update the dates (and not the address). To update the address, cancel the initial vacation transfer and start anew.
To cancel a vacation transfer:
Navigate to the scheduled stops/starts grid.
Select the cancel button next to the corresponding vacation transfer.
Confirm you want to delete the record and select OK. The cancellation is processed in real-time with the circulation system.
To update a vacation transfer:
Navigate to the scheduled stops/starts grid.
Select the change button next to the corresponding vacation transfer. The change vacation transfer function appears.
Choose the updated dates for the vacation transfer, being sure to adhere to the vacation cut-off times chart.
Select submit. The update is processed in real-time with the circulation system.
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
Restart a Subscription
This feature allows a CSR to restart a permanently stopped subscription in real-time. For the subscription to be restarted from one CSR portal it should pass the restart eligibility check that consists of the following:
The Subscription has been stopped for less than X days (set up for the client in MG2 control)
No payments made during last 24 hours
The Rates are returned from the NCS Circ OR the Rates are not returned but the balance is negative
Navigation
Helpful details
At Payment/Billing tab click the Restart button, the following actions depend on where the rates are returned from the NCS Circ.
The rates are returned in real-time from the NCS circ. You must have NCS Circ 2018.5 or above to turn this feature on
Permanently stop a subscription
This feature allows you to permanently stop a subscription.
Permanent stops cannot overlap with other stops or transfers. You can update or cancel scheduled permanent stops in the scheduled stops/starts grid.
Navigation
Helpful Information
Here are some helpful pointers when creating or updating permanent stops.
When creating a permanent stop, you will work through the stop saver workflow with the subscriber. Stop saver includes three steps (1. Benefit Section, 2. Stop Saver Offer, 3. Stop Subscription). These steps help stop a cancellation. Stop Saver is configurable in the Subscribe database. Clients must submit a Stop Saver Rules document that details their preferences.
Note: the stop saver feature will not appear for some reason types (e.g. deceased, office use only, etc.) These options are configurable in the Subscribe database.
Reason options come in real-time from a circulation database.
Create a Permanent Stop
To create a permanent stop:
Select the permanent stop button.
Choose a cancellation reason from the drop-down list.
Optionally, read the benefits section to the subscriber. (This appears only if Stop Save is configured.) If the subscriber agrees to the suggested solution, select helpful: yes and stop this procedure. Otherwise, select helpful: no and continue to the next step.
Present the offer(s) to the subscriber. If the subscriber agrees to an offer, select it, choose when to implement the offer (Change Immediately, Change Next Billing Cycle, Schedule Change), then select helpful: yes to confirm the change. End the procedure. The updated offer is processed in real-time with the circulation system.
Otherwise, select helpful: no and continue to the next step.
Read the displayed message to the subscriber and choose when to stop the subscription
(change Immediately, Change Next Billing Cycle, Schedule Change). If scheduling for a future date, select a date. Note: If the subscription is in grace, and if you choose the next billing cycle, the subscription will end immediately by default. If you choose an end date after the grace period ends, the subscription will still end when the grace period ends. If a payment is made that brings the subscription out of grace, the selected end date will be honored.
Confirm the disclaimer text to the subscriber and select submit. The permanent stop is processed in real-time with the circulation system.
Cancel a Permanent Stop
You can only cancel permanent stops with stop types values of NextBillingCycle or Specific Date. If the stop types value is Immediate, the permanent stop cannot be canceled.
To cancel a permanent stop:
Navigate to the scheduled stops/starts grid.
Select the cancel button next to the corresponding permanent stop.
Confirm you want to delete the record and select OK. The cancellation is processed in real-time with the circulation system.
Update a Permanent Stop
You can only update permanent stops with stop types values of NextBillingCycle or Specific Date. If the stop types value is Immediate, the permanent stop cannot be updated.
To update a permanent stop:
Navigate to the scheduled stops/starts grid.
Select the change button next to the corresponding permanent stop.
Update the stop type, stop date, and reason. The stop date can updated only when you choose a stop type value of Specific Date.
Select submit. The update is processed in real-time with the circulation system.
The information displayed in this tab returns in real-time from our circulation databases. You must have NCS Circ 2018.5 or greater for current integration.
Billing and payment management
This guide explores the payment and billing management functionality of the SubCon Admin Portal. It describes and provides instructions for each feature of the payment/billing tab. You can:
view a subscription's billing status, saved payment methods, and transactions
make payments and update payment methods
opt subscriptions into automatic renewal (auto-renew)
switch auto-renew subscriptions back into invoices
Tip: To quickly show an accounts current balance, select the show balance button in the upper right corner. If the displayed number is negative, the account is past due.
Navigation
Grids
Status Details
The status details section of this tab displays information about a subscription's status. These values are processed in real-time. The source column indicates which database the values come from, either Subscribe or Circulation.
Payments
Make a payment
You can make one-time payments only on subscriptions not currently enrolled in auto-renew.
You can only make one payment every 24 hours.
To make a payment:
Select the make a payment button.
Choose a payment term and rate.
Confirm whether the subscriber wishes to add a tip.
Confirm whether the subscriber wishes to enroll in auto-renew. If so, check the auto-renew box. The activation fee is a flat rate charged each time a payment is made. The fee amount is configurable in the Subscribe database.
Confirm the disclaimer text to the subscriber and select pay with credit card.
Enter the credit card details and select submit. The request is processed in real-time with the circulation system.
Auto-renew
This section covers:
Opting a subscriber into auto-renew
Updating the payment method of a subscriber who has opted into auto-renew
Returning a subscriber to an invoice method from auto-renew
Opt into auto-renew
You cannot opt a subscription into auto-renew if a payment has been made in the last 24 hours.
To opt a subscription into auto-renew:
Select the auto-renew sign up button. The sign up form appears.
Confirm a payment term with subscriber. Term is the number of weeks per billing cycle. Total payment is the amount due today.
Confirm the disclaimer text to the subscriber and select pay with credit card.
Enter the credit card details and select submit. The request is processed in real-time with the circulation system.
The new payment method will appear in the saved payment methods grid after selecting the refresh button.
Update a payment method
You can update the payment methods only of subscriptions in auto-renew.
This feature allows you to update a payment method (e.g. switching credit cards) or change a payment method (e.g. switch from a credit card to a bank account).
To update or change a payment method:
Select the update payment method button. The feature appears.
Confirm the disclaimer text with the subscriber.
Determine if the subscriber will update or change their payment method. If only updating, select the continue with… button. If changing, select the switch to… button.
Fill in the new payment’s information.
Select either submit or save, depending on which option the subscriber chose. The updated payment information is processed in real-time with the circulation system.
The new payment method will display in the payment method grid on the next published day.
Switch to invoice
To switch to invoices:
Select the switch to invoice button.
Confirm the disclaimer text with the subscriber.
Select submit. The updated information is processed in real-time with the circulation system.
Tutorials, how-tos, and reference documentation
This section of the guide contains tutorials, how-tos, and reference material for the Subscription Panel. Here you will find in depth information for working with the Subscription Panel. This section covers the following topics:
Show events and access events
This guide explores the show events and show access events buttons of the Subscription Search feature.
Show events
Select the show events button to display a history of events. Each tab will display events based on a standard configuration. For example, selecting the button from the account information tab will display different events than selecting the button from the complaints tab.
In the search results, select the details icon to view detailed information about an event. Navigate between the tabs to view related information. Note: It is expected that some fields will not populate since each field does not necessarily pertain to every event type.
Show access events
Select the show access events button to display when a subscriber accessed web content (event type id 708). The results from this button are the same regardless of the tab from which you selected it.
To show access events:
Select the show access events button.
Choose the date criterion.
Select search. The subscriber's access history displays below.
Overview
Subscription Panel is a customer-facing application that allows users to view offers and then make a subscription purchase.
The Subscription Panel features work in tandem with the CMS Hierarchy and Cache Management features. This section discusses both the CMS Hierarchy feature and Cache Management feature, as well as the Subscription Panel features. The Subscription Panel is comprised of three subsections:
Component Manager
Structure Admin
Presentations
Diagram
This diagram illustrates how the Subscription Panel, CMS, and Cache Management feature work in tandem.
While this picture shows where at the screen you can get access to Cache management, CMS hierarchy and Subscription Panel block
CMS Hierarchy
Description
There are three levels in the CMS Hierarchy:
Client
Newspaper Group
Newspaper
Newspapers are a part of a Newspaper Group, and a Newspaper Group is a part of a Client. Settings can be applied at each level, but settings at the Client level act as the default and apply to lower levels as well. However, changes made at lower levels (e.g. Newspaper or Newspaper Group) will not automatically apply to higher levels. Lower level changes are called overrides since they override higher level settings.
We suggest organizing the hierarchy by configuring widely used settings at the Client level, then overriding them at lower levels when necessary. In some cases overriding is the best way to manage settings (e.g. overriding Attribute for different Newspapers) and doing so will save you headaches in the future.
Choose a hierarchy
You can navigate between the hierarchical levels. To do so:
Select the hierarchy button. (The button will display the current level’s name.) After selecting the button, the CMS Hierarchy screen will appear.
Choose the level you wish to be on. The window will disappear. Any change you now make will apply to the selected and lower levels.
Overrides
There are two types of overrides for the Subscription Panel section of the CMS:
structural overrides - these apply to changes in the structuring of different components (e.g. changing parent/child relationships or their location)
property overrides - these apply to changes of a component’s property (e.g. changing the color of a component)
Remove structural overrides with the remove overrides button and remove property overrides with the wastebin icon located next to the component in question.
Cache management
Description
This feature clears your cache so that any changes you make take effect. You will want to use CMS + Panel button to clear the caches of the CMS and Subscription Panel feature.
You must set the panel’s URL for this feature to use this feature. From the CMS, select Admin -> CMS Settings and fill in the PanelClearCacheUrl1 field with your panel’s URL. The URL must not contain an SSL certificate (i.e. use HTTP, and do not use HTTPS).
Example: http://checkout-demo.subscriberconcierge.com/cache/refresh
If your cache was successfully cleared, a success banner appears at the bottom of the screen.
Component Manager overview
Description
The Component Manager subsection allows you to manage your Subscription Panel components. Components are the building blocks for your presentations. Each component has a name, class, and code. Components themselves contain various properties, which you can manage when you edit or create a component.
Each component is comprised of the following things:
Name - The display name for the component
Class - The overarching class the component falls into (e.g. address components or payment components)
Code - The code used to call and refer to the component
Typically, Naviga developers create your components with an SQL script. This ensures that your components are correctly named and ordered. A component's class and code, for instance, must adhere to a predefined naming convention for them to function properly. So though you can create components manually, it is not recommended.
UI
The image below depicts the Component Manager UI.
If you select the + add new button to create a new component, the following screen appears.
Structure Admin overview
Description
The Structure Admin subsection allows you to structure components to build a Presentation Template. Whereas components are just the building blocks of your presentation, a template is the arraignment of the building blocks in a particular way.
Typically you will need only a single Presentation Template. It contains a Template Name and a Presentation Type, and is comprised of various components.
You can drag the components to arrange their order, or designate certain components as either a parent or child component.
Typically, Naviga developers create your Presentation Template. This ensures that it is created to spec. However, you can create Presentation Template manually.
UI
This image shows two components. One is a parent component and has multiple child components.
This image shows the component selector tool. Use it to drag components into your Presentation Template.
Presentations overview
Description
The Presentations subsection allows you to manage the presentation of your arranged components. Instead of creating or arranging components, you are creating, previewing, editing, or deleting the final presentation of all of your work. Similar to how you use various components to create a Presentation Template, you now fine tune your Presentation Template(s) to create various Presentations.
UI
You can either create a new presentation, import a presentation (JSON), or select an existing presentation.
When creating a new presentation:
- a blank presentation is a presentation with no components.
- save selection as new reuses the same components for multiple presentations, which means changes at the component level will affect both/any presentations using these components.
- duplicate selection creates copies of the components to use in a new presentation, which means changes at the component level will not affect other presentations.
When either saving as new or duplicating components, you should rename them so as to avoid adding copy1, copy2, and so on as extensions.
This image displays the various features of the Presentations menu:
After selecting/creating/importing a presentation, you can:
preview your presentation (to preview, you must be on a Newspaper level with your CMS hierarchy.)
set whether your presentation is active/inactive, which determines whether your presentation can be seen by end-users
set whether your presentation is a default presentation
manage your various components
Component Matrix
The matrix below defines each component. Each tab represents a component class and has a table that describes the component and lists each possible parent and child components.
The intent of the matrix is to provide a comprehensive definition for supported components that you can reference for specific questions. We suggest using task-based tutorials to help with particular tasks.
Some components include images. Please note that before adding an image to a component you should upload it in the Image Gallery using Images section in CMS.
For the Subscription Panel Images the following sizes/resolutions are recommended:
The lookup classic portal button is located on any subscription search tab. Perform a , then select the button from the bottom of any tab.
You can find this feature under the stop tab. To navigate here, perform a , and then select the stop tab.
This can help determine how and when to process vacation transfers.
See also: ,
The Subscription is not
You can find this feature either under the Account Information tab - please scroll down to see the Restart button that will redirect you to the Payment/Billing tab, or you can go straightly to Payment/Billing tab. To navigate here, perform a , and then select the tab.
For more details please see the and the documentation
You can find this feature under the stop tab. To navigate here, perform a , and then select the stop tab.
This can help determine how and when to process permanent stops.
See also: , ,
To view the payment/billing tab, perform a , and then select the payment/billing tab.
View this for a visual representation.
View this for a visual representation.
At the end of the section you will find detailed and .
Address Components are related to billing and address information.
Core Structure components shape the basic layout and structure of presentations.
Landings and Promotions Components organize your landing page and any promotions that you are currently running.
Offer Components are used to design and describe offers.
Optional UI components add various UI elements.
Payment Components authorize various payment methods for purchases.
User Data components are designed to collect user data.
Widget Components make presentations interactive with various popovers, notifications, etc.
A container that displays a header. Can be configured as either top-level or as a child, depending on need.
Presentation
Page
N/A
HeaderExtended
Extends the header section.
Presentation
Page
N/A
HeaderGUP
Client specific header, for GUP clients only.
Presentation
Page
N/A
Footer
A container that displays a footer. Can be configured as either top -level or as the child of a page. Can contain useful links, contacts, or an HTML field.
Presentation
Page
N/A
PlaceOrder
A container that displays information regarding an order summary.
Step
N/A
Page
A container for other elements. Typically, there are three Page Components in a presentation.
Allows users to pay with their bank account. Displays a set of fields that allow users to ender bank account data.
PaymentMethods
N/A
BankAccountChase
Displays an iFrame that is used to fill in bank account data. Note: this is rarely used.
PaymentMethods
N/A
CreditCard
Allows users to pay with a credit card.
PaymentMethods
N/A
CreditCardBrainTree
Allows users to pay with a Brain Tree credit card.
PaymentMethods
N/A
CreditCardChase
Allows users to pay with a Chase credit card.
PaymentMethods
N/A
CreditCardCyberSource
Allows users to pay with a Cyber Source credit card.
PaymentMethods
N/A
CreditCardEdgil
Allows users to pay with an Edgil credit card.
PaymentMethods
N/A
CreditCardHOH
Allows users to pay with an HOH credit card.
PaymentMethods
N/A
CreditCardStripe
Allows users to pay with a Stripe credit card.
PaymentMethods
N/A
CreditCardVindicia
Allows users to pay with a vindicia credit card.
PaymentMethods
N/A
PayPal
Allows users to pay with PayPal.
PaymentMethods
N/A
PayPalDTI
Displays a button that opens the PayPal modal window.
PaymentMethods
N/A
PayPalExpress
Allows users to pay with PayPal Express
PaymentMethods
N/A
TermsAndConditions
Displays terms and conditions that a user has to accept to proceed.
Any container component.
N/A
Components
Description
Possible Parent
Components
Possible Child
Components
CollegeInformation
Diplays various fields that allow a user to enter college information
Step
N/A
EmailPreferences
Subscribes users to the various links specified in this component.
Step
N/A
GiftRecipient
???
Step
N/A
InputGiftCode
Displays an input that allows users to enter a code to receive a gift.
Step
N/A
Input
Displays a text field that allows a user to enter text information.
Step
N/A
MilitaryInformation
Displays a set of fields that allow users to enter any military related information.
Step
N/A
UserInformationNoAccount
Displays a field that allows users to enter an email address without creating an account.
Step
N/A
RegistrationOnConfirmation
Displays a set of fields that allow a user to create a registration after purchasing a subscription.
Confirmation
N/A
UserInformation
Displays a set of fields that allow a user to enter genral user information (e.g., DOB, names, etc).
Step
N/A
Component
Description
Possible Parent Components
Possible Child Components
Chat
Displays a chat icon in the bottom corner of the window.
Any container component.
N/A
CookieNotice
Displays a notice explaining cookie data collection.
Presentation
N/A
IdlePopover
Displays a popover after the user has been idle for a determined amount of time.
Page
N/A
IdleTimer
Displays a popover that indicates how much session time is left. Allows the user to continue or leave the page.
Page
N/A
Messaging
??
??
??
NotificationGeographic
Displays a notification if the entered delivery address is undeliverable.
Page
N/A
Captcha
Displays a captcha in the bottom corner.
Any container component.
N/A
RSSFeed
Displays an RSS feed button.
Confirmation
N/A
ScheduledStart
Displays a calendar to specify a subscription's start date.
Step
N/A
Image
Recommended size/resolution
Note
Header Logo
300x45px
not recommended to use height >300
Page 1 Background Image
popular screen resolutions e.g. 1920x1080px
the image behind any the landing and offer selector (if you use small tiles); can be set to a solid color by inputting a Hex code instead of an image; not recommended to use less than 1600px width
Promotion Tiles
380x250px
Offer Selector Tiles
270x170px or 270x270px or 270x380px
this image is set in Solicitor Concierge, not in CMS. The same image appears both in Offer Selector Tiles and Offer Details
Offer Details
190x120px
this image is set in Solicitor Concierge, not in CMS. The same image appears both in Offer Selector Tiles and Offer Details
Create, edit, or remove component properties
Each component must have at least one property, but typically a component has many properties.
Though it is possible to create properties, and there are instructions to do so below, we highly recommend that you don't. Naviga is happy to create them for you, and usually does with a script. This ensures they function properly.
Create a new property
To add a property to a component:
From the CMS, select the Hierarchy button and chose the Client level. Properties can only be created at this level.
Select the component manager button.
Search for the component that you wish to add a property to and select edit. (Optionally, select + add new to create a new component.)
Select + add new property. The property creation screen appears.
Fill in the property's information.
Select save in the property's edit column.
Edit an existing property
To edit a component's properties:
From the CMS, select the Hierarchy button and choose the Client level. Properties can only be edited at this level.
Select the component manager button.
Search for the component that you wish to edit.
Select the edit button corresponding with your desired component. The property manager will display below.
Navigate to the desired property and perform your desired edits.
Select either save or save as new.
Remove a property
To remove a property from a component:
Select the component manager button from the CMS.
Search for the component that you wish to remove a property from.
Select the edit button corresponding with your desired component. The property manager will display below.
Find the desired property you wish to remove from the list and select delete.
You can preview a Presentation at any time with the preview button.
To preview a Presentation:
From the CMS, select the hierarchy button and choose an option from the Newspaper level.
Select Subscription Panel, then choose Presentations.
Select the desired Presentation you wish to preview from the selected drop-down menu. Greyed Presentations are inactive.
Select the preview button. A preview window will appear. If you've recently made changes, clear your cache first. Select Manage Cache then Refresh CMS + Panel.
Create, edit, or delete a Presentation Template
You can only edit Presentation Templates at the Client hierarchical level.
Though it is possible to create Presentation Templates, and there are instructions to do so below, we highly recommend that you don't. Naviga is happy to create them for you, and usually does with a script. This ensures they function properly.
To create a new Presentation Template:
From the CMS, select the hierarchy button and choose the Client level.
Select Subscription Panel, then choose Structure Admin.
Select + add new template. The template creation screen appears.
Choose a Template Name and Presentation Type. Note: each Presentation Type has a unique tree structure. If you change the Presentation Type after having made some edits, the new tree structure will delete the existing tree structure and you will lose your edits.
To edit a Presentation Template:
From the CMS, select the hierarchy button and choose the Client level.
Select Subscription Panel, then choose Structure Admin.
Select an existing Presentation Template from the selected drop-down menu.
Perform any edits you wish to make, then select save. Typically, edits at this stage will be the inclusion of various components. View the tutorials section for more information.
To duplicate a Presentation Template:
From the CMS, select the hierarchy button and choose the Client level.
Select Subscription Panel, then choose Structure Admin.
Select an existing Presentation Template from the selected drop-down menu.
Select the duplicate button. The duplicated Presentation Template will appear in the drop-down menu. Select it to change its name.
To delete a Presentation Template:
From the CMS, select the hierarchy button and choose the Client level.
Select Subscription Panel, then choose Structure Admin.
Select an existing Presentation Template from the selected drop-down menu.
Select the delete button. Confirm you wish to delete this Presentation Template and select Yes. The template will be removed from the drop-down menu.
Create, edit, delete, import or export Presentations
Creation/import
You can either create a new presentation or import a presentation from a JSON file.
Import a Presentation
To import a Presentation:
From the CMS, select the hierarchy button and choose a hierarchical level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
Select the options drop-down and choose import.
Select a file then select import.
If successful, your new presentation should appear under the presentations drop-down menu.
Create a Presentation
Prerequisites
Each new Presentation should meet the following criteria:
Have a unique Presentation Name (cannot be blank) that contains only digits and latin letters
Have a unique Presentation URL
Have a Presentation Type
Contain valid parent-child relationships between components.
Contain the following main components:
Presentation Properties
Header
Page
Step
Confirmation
Order Summary
Typical Presentation Component Layout
Procedure
To create a new Presentation:
From the CMS, select the hierarchy button and choose a hierarchical level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
Select add new presentation and choose an option:
A blank presentation contains no components.
Save section as new reuses components. Changes made to components in this presentation will affect other presentations using these components.
Duplicate selection makes copies of the components for this presentation. Changes made to components in this presentation will not affect other presentations.
Note: if either saving as new or duplicating, select a presentation to work from the drop-down menu first, then choose your option.
Based on your selection, continue to the corresponding section below for further steps.
Blank Presentations:
Add a presentation URL, presentation name, and presentation type to your new presentation.
Choose whether you want the presentation to be a default presentation and whether its status is active/inactive.
Use the component selector sidebar to add your components.
Select save.
Save Section as new:
Change the presentation's name and URL to something unique.
(Optionally, rename the components using the Component Renaming Tool. Once finished, select save and close. If you don't want to rename the components, select the x to exit from the tool).
Select save to finish.
Duplicate section:
Change the Presentation's name and URL so that they are unique, then select ok.
(Optionally, rename the components using the Component Renaming Tool. Once finished, select save and close. If you don't want to rename the components, select the x to exit from the tool.)
Select save to finish.
Edit, delete, or export Presentations
You can edit and delete Presentations.
Edit
To edit a Presentation:
From the CMS, select the hierarchy button and choose a hierarchical level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
Select the desired Presentation you wish to edit from the selected drop-down menu. Greyed Presentations are inactive.
Make your desired changes to the Presentation. To add a component, drag them from the Component Selector sidebar. To remove a component, select the remove button next to the desired component.
Select save once finished.
Undo a change
If at any time you've made a mistake that you wish to undo, select the cancel button. Any changes will be removed and the Presentation screen will disappear.
Delete
When you delete a Presentation you are not deleting components. They will still be available in the Component Manager section.
To delete a Presentation:
From the CMS, select the hierarchy button and choose the Client hierarchical level.
Select Subscription Panel, then choose Presentations.
Select the desired Presentation you wish to delete from the selected drop-down menu. Greyed Presentations are inactive.
Select delete. Confirm this is the correct Presentation and select Yes.
Export
You can export Presentations as either a JSON or HTML file.
To export a Presentation as JSON:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
Select the options drop-down, then choose export.
Select which Presentation(s) you want to export. The show advanced button allows you to include entity, property, and dictionary types as well as structure templates into the JSON file.
Select export content. The download dialogue will appear. Note: if you chose many Presentations or the Presentation is large, it may take longer for the dialogue to appear.
To export a Presentation as HTML:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
Select the Presentation you wish to export from the selected drop-down menu.
Select the options drop-down, then choose Business export. The download dialogue will appear.
Common properties quickstart
Overview
The guide below outlines the common properties of some common components. Each heading denotes a component and defines that component's properties.
Presentation Properties
Property Name
Description
DefaultZipCode
The postal code the Presentation defaults to.
DefaultOfferGroupId
The Offer Group ID the Presentation defaults to.
Theme
Enables clients to configure paddings, stylings, borders etc. to match the. Some of the Themes are custom and are designed for a specific clients.
InputPadding
The padding distance for all input fields in a Presentation.
StepPadding
The padding distance for all steps in a Presentation.
Header
Property Name
Description
StylingBackgroundColor
Color of the Header background
StylingBorderColor
Color of the Header border
StylingTextColor
Color of the Header text
BackText
Text of the ‘Back’ navigation button
LoginSectionShow
If the toggle is on then the Login section is shown at the Header, otherwise is hidden
LoginText
Log in control text
LogoutText
Log out control text
LogoUrl
Makes the Logo clickable; click on the Logo redirects the user to the URL specified
LogoAltText
Alternate Logo text shown on hover
StylingBackgroundImage
Image that can be set as the Header background
StylingLogoAlignLeft
If the toggle is on then the Logo is aligned to the left, otherwise is centered
AlreadySubscriber Show
If the toggle is on then the option for subscribers to view the offers is displayed is aligned to the left, otherwise is hidden
AlreadySubscriber Title
The text shown for subscribers in case 'AlreadySubscriber Show' toggle is set to on
AlreadySubscriber LinkText
The text of the link for the subscribers
AlreadySubscriber Url
The URL redirecting subscribers to view the offers
Landing Tiles
Property Name
Description
SubtypeName
Applies additional styling to a way that the Landing Tiles are displayed, i.e. Rounded, NoImage
DisplayInlineCount
Specifies how many promotions should be displayed inline
Title
The text of the title displayed at the top of the landing; formatted text
Subtitle
The text of the subtitle displayed at the top of the landing but beneath the title; formatted text
IncreaseTileOnHover
If the toggle is on then the promotion that is currently on hover will be displayed with bigger size
SliderDotsColor
The color of the navigation controls that allow to navigate within the promotions
Page
Property Name
Description
DisplayType
This property defines how the component should behave when appeared
Title
The Title of the Page; formatted text
Subtitle
The Subtitle of the Page; formatted text
Styling Background Image
The link to the background image for the Psge
Styling Background Color
The color of the Page background
Styling Background Scrollable
If the toggle is on then the background of the Page is scrollable
Styling Background AccentColor
The accent color of the Page background; if specified then the background has two colors - the main one and the accent one
Styling Background AccentImage
The accent background image; if specified then the background has two images - the main one and the accent one
AlternativeMobileStyling
If the toggle is on then the Page will look different on mobile devices. The following properties are mobile specific and are analogous to those for the desktop: MobileTitle, MobileSubtitle, MobileStyling.Background.Image, MobileStyling.Background.Color, MobileStyling.AccentColor, MobileStyling.Background.AccentImage
Offer Selector
Property Name
Description
Offer Button Text
The text of the main Offer button
Show Offer Title?
If the toggle is on then the Title of the Offer is displayed, otherwise is hidden
Show Offer Price?
If the toggle is on then the Price of the Offer is displayed, otherwise is hidden
Show Offer Image?
If the toggle is on then the Offer image is displayed, otherwise is hidden
Show Image On Mobile Devices?
If then toggle is on then the Offer Image is displayed on mobile devices, otherwise is hidden
Title
The Title of the Offer, formatted text
Auto Select Offer
If then toggle is on then the Offer the user clicked on is autoselected, otherwise all the offers are displayed in the same way
Offer Button Position
Indicates whether the button should be aligned to the left, to the right to centered
Show Express Checkout Offer Text?
If then toggle is on then the Title of the Offer is displayed, otherwise is hidden
Show TermsAndConditions?
If then toggle is on then the Title of the Offer is displayed, otherwise is hidden
Show Body
If then toggle is on then the Title of the Offer is displayed, otherwise is hidden
Promotion Digital and Promotion ZipCode
Property Name
Description
Title
The Title of the Promotion, formatted text
Subtitle
The Subtitle of the Promotion, shown below the Promotion Title, formatted text
Image
The Promotion image
ImageAlt
Alternate image text shown on hover
Body
The Body of the Promotion describing Promotion details shown at the bottom of the Promotion, formatted text
Button OfferGroupId
The Promotion code relevant to the main Promotion button
Button PromotionCode
The Promotion code relevant to the main Promotion button
Button Text
The text of the main Promotion button
RespectURLParams
If the toggle is ON then the flow will go according to the Presentation URL parameters specified, otherwise the URL parameters will be ignored
NoOffersAvailableMessage
Error message displayed in case there are no offers for the zipcode entered
ActionsInModal
If the toggle is ON then the promotions will be displayed in a Modal window so that user's must choose one before continuing
Suppress ZIP Validation Against Default Area?
If the toggle is on then
HideInputs
If the toggle is on then the zipcode input is hidden by default and will be shown only the button is clicked
Step
Property Name
Description
Button Text
The text of the main Step button that redirects to the next Step/Page if the current one is valid
Pricing ActivationFeeShow
If the toggle is on then the Activation Fee is shown to the user, otherwise is hidden
Pricing Amount Show
If the toggle is on then the Pricing is shown to the user, otherwise is hidden
Pricing TaxAmount Show
If the toggle is on then the Tax Amount is shown to the user, otherwise is hidden
Pricing TotalPrice Show
If the toggle is on then the Total Price is shown to the user, otherwise is hidden
Spinner Show
If the toggle is on then the Spinner will be shown while an an action is performed (typically a request to the API)
Should this step be added to Step Indicator?
If the toggle is on then the Step is be included in Step Indicator
Title
The title of the Step
Delivery Information and Billing Information
Property Name
Description
AddressLine Placeholder
Placeholder of the AddressLine input
City Placeholder
Placeholder of the City input
FirstName Placeholder
Placeholder of the FirstName input
LastName Placeholder
Placeholder of the LastName input
PhoneNumber Placeholder
Placeholder of the PhoneNumber input
SecondAddressLine Placeholder
Placeholder of the SecondAddressLine input
State Placeholder
Placeholder of the State dropdown; if not specified then the first dropdown option will be preselected
Zipcode Placeholder
Placeholder of the Zipcode input
NotRoutable OfferGroupId
OfferGroupId offered to the user in case the delivery is not possible for the zipcode entered
NotRoutable LinkText
The text of the link that redirects user to a special offer, shown in case the delivery is not possible for the zipcode entered
NotRoutable DisclaimerText
The disclaimer text shown in case the delivery is not possible for the zipcode entered
NotRoutable NoOffersErrorMessage
The error message shown in case there are no offers for the zipcode entered
Footer
Property Name
Description
Body
Footer body, HTML-formatted fragment
StylingBackgroundColor
Color of the Footer background
StylingBorderColor
Color of the Footer border
Cookie Notice
Property Name
Description
Cookie Text
The text of the Cookie Notice
Cookie Link
The text of the link, usually ‘Private Policy’
Cookie Link Text
The link, usually resurects user to the Private Policy details
Styling TextColor
The color of the Cookie Text and Cookie Link Text
Styling BackgroundColor
The color of the backgroung
Idle Popover
Property Name
Description
Title
The title of the popover
Body
The main popover text
Idle Timeout
The timeout in seconds. If user stays active for the timeout specified then the Idle Popover will be displayed
Number of Openings
The number of times the popover will be displayed to the end users
Abandonment Popover
Property Name
Description
Title
The title of the popover
Body
The main popover text
BackgroundColor
The color of the popover background
Number of Openings
The number of times the popover will be displayed to the end users
BackgroundImage
The Image set as the popover background
Registration on Confirmation
Property Name
Description
Title
The title; usually offers user to create a password to register
SuccessMessage
success message, show in case user has been successfully registered
Order Summary
Property Name
Description
BillingInformation.Show
Toggle; if the toggle is set to ON then Billing Information block is displayed, otherwise is hidden
DeliveryInformation.Edit
Toggle; if the toggle is set to ON then the icon allowing to edit Delivery Information is displayed, otherwise there is no icon
PaymentInformation.Show
Toggle; if the toggle is set to ON then Payment Information block is displayed, otherwise is hidden
UserInformation.Email.Show
Toggle; if the toggle is set to ON then User Email is displayed, otherwise is hidden
UserInformation.Show
Toggle; if the toggle is set to ON then User Information block is displayed
Tutorials and Step-by-step guides
Add a landing to a Presentation
A landing page hosts desired Offer Groups that you want potential subscribers to see immediately.
To add a landing to your Presentation, make a landing component (e.g. Landing - Tiles V3, Landing - Tab V3, etc. ) a child of the Page V3 component, then add any desired promotion components as children of the landing. Which ever promotions components you choose will appear on the landing page.
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to add a landing. The Presentation's structure and components will appear below.
Add or drag your desired landing component into the Presentation and make it a child to the Page V3 component.
Expand the landing component to display its children, then add promotion components as children (e.g. Promotion Digital V3, Promotion ZipCode V3, etc).
Next, configure the promotion component's properties. Select the details button to expand the component's properties.
At minimum, the component needs a name. However, we suggest you configure the following properties for Promotion Digital V3 :
Title - the title that displays above the promotion.
Body - the text that displays in the promotion's body.
Image - the image in the promotion's body.
Button text - the text displayed in the button.
Button OfferGroupId - add the promotion's Offer Group ID to this property. This links this promotion component to the promotion in the circulation database.
And for Promotion ZipCode V3:
Title - the title that displays above the promotion
Body - the text that displays in the promotion's body.
Image - the image in the promotion's body.
Button text - the text that displays in the button.
Button offer groupId - add the promotion's Offer Group ID to this property. This links the promotion component to the promotion in the circulation database.
NoOffersAvailableMessage - add a message to this property. This displays a message to users when there are no offers available to them (usually because of location).
Add social media icons at the confirmation screen
You can add social media icons to your confirmation screen. Each social media element has it's own component. Each Social Media V3 component must be a child of the Confirmation V3 component, which is a child of the Page V3 component.
Before you start
Before you follow the steps below, be sure that the Confirmation V3 component is a child of the Page V3 component.
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to add social media components to. The Presentation's structure and components will appear below.
Drag a Social Media V3 component into the Presentation and make it a child to the Confirmation V3 component. Note: Each social media icon requires it's own component. For instance, if you want icons for Facebook, Twitter, and LinkedIn, you will need three social media components.
Select save.
Configure various component properties:
Navigate to the social media components.
Expand each social media component and fill out the SocialMedia LinkSocialMedia Type properties. Example: For Twitter, enter www.twitter.com for the link and select Twitter from the type drop-down menu.
(Optionally, configure the SocialMedia Header [e.g. "Follow us on"].)
Select save.
Add app-download buttons to the confirmation screen
You can add app-download buttons to the confirmation screen. Currently we support buttons for the Apple App Store and the Google Play Store. Each app store button needs its own App Downloads V3 component, which must be a child of the Confirmation V3 component.
Before you start
Before you follow the steps below, be sure that the Confirmation V3 component is a child of the Page V3 component.
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish adding download buttons to. The Presentation's structure and components will appear below.
Drag a App Downloads V3 component into the Presentation and make it a child to the Confirmation V3 component. Note: Each app store icon its own component. For instance, if your app is in both the Apple App Store and the Google Play Store, you will need two components.
Select the Details button next to each component, and add the corresponding AppDownloads Link (e.g. www.google.com).
Select save next to each component to save your work.
Configure various component properties:
Navigate to the Confirmation V3 component that is the parent to your App Downloads V3 components.
Select the Details button to expand the component's properties.
Toggle AppDownloads.Show to ON.
(Optionally, configure the AppDownloads Header [e.g. "Download our apps].)
Select save.
Other non-mandatory properties:
AppDownloads.Subtitle - Subtitle to the header
AppDownloads.Image - adds a background image
AppDownloads.Styling.Background - changes the background color
Configure an upsell offer
An Upsell Offer is a more expensive offer that you can present to your customers. You can add upsell offers to your Presentation by adding the Upsell V3 component as a child to a Step V3 component. Typically, the Upsell V3 component is added to the second Step V3 component of the third Page V3 component .
Before you start
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to add an upsell feature to. The Presentation's structure and components will appear below.
Drag the Upsell V3 component into your Presentation and make it a child to any Step V3 component.
Select save.
Configure various component properties:
Navigate to the Upsell V3 component and select the details button.
Toggle Offer ShowImage to On.
Toggle Offer MarketingTitle Show to On and add text to the InlineTitle and Offer MarketingTitle Textproperties.
Select save.
These are the recommended properties to make your component functional. Fill in the other properties to add more customization. If you'd prefer your Upsell to appear as a modal, toggle the showinModal to On.
Ask for registration password only at confirmation
You can arrange your Subscription Panel to ask for a user's registration password after they've finished purchasing, at the confirmation screen. The component checks the user's email to see if it has already been registered, and if it has not, it will prompt for a registration password.
This often leads to more customer retention, and makes the checkout process efficient. Todo this, the Registration on Confirmation V3 component needs to be a child of the Confirmation V3 component. Follow the instructions below for a step-by-step guide.
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Using the Component Selector tool, drag the Registration on Confirmation V3 component into your Presentation and make it a child to any Confirmation V3 component.
Select save.
Configure various component properties:
Navigate to the Registration on Confirmation V3 component and select the details button.
Toggle Password Show to On.
Toggle Password Validation Required Apply to On.
Add text to the Title property (e.g. "Create a password") and Button Text property (e.g. "Submit").
Select save.
Add an abandonment popover
An abandonment popover is a popover that appears whenever a user moves their pointer near the top of the screen, presumably to abandon the page. The popover usually contains an offer at a discounted price, though you can customize the popover to contain any offer.
To add this popover to your presentation, add the AbandonmentPopoverV3 component as a child to the Page V3 component. Follow the step-by-step guide below for more instructions.
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Using the Component Selector tool, drag the AbandonmentPopoverV3 component into your Presentation and make it a child to any Page V3 component.
Select save.
Configure various component properties:
Navigate to the AbandonmentPopoverV3 component and select the details button.
Toggle Button Show to On.
Add the offer id of the offer you wish to sell to the Button OfferGroupId field. This links the button to your offer in circulation.
Add text to the title and body properties (e.g. "Get Unlimited Access to Local News");
Add text to the Button Text property (e.g. "Get this Offer").
Set the MaxWidth(px) property to determine the pixel size of your popover. 1000 pixels is max width.
Select save.
These are the recommended properties we suggest to get going for a functional abandonment popover. Optionally, configure the BackgroundColor,BackgroundImage, or other properties.
Add an idle popover
You can add an idle popover to your Subscription Panel that triggers a reminder (max width: 1000 pixels) when the user's mouse has been idle for a predefined amount of time.
To add this popover to your presentation, add the Idle Popover V3 component as a child to the Page V3 component. Follow the step-by-step guide below for more instructions.
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Using the Component Selector tool, drag the Idle Popover V3 component into your Presentation and make it a child to any Page V3 component.
Select save.
Configure various component properties:
Navigate to the Idle Popover V3 component and select the details button.
Add text to the title and body properties.
Add a number of seconds Idle Timeout (sec) property. This number determines how many seconds go by before the popover appears.
Add a number to the NumberOfOpenings property. This number determines how many times the idle popover appears before it stops altogether.
Select save.
These are the recommended properties we suggest to get going for a functional idle popover. Optionally, configure the BackgroundColor,BackgroundImage, BorderColor, and BorderWidth properties.
Add a cookie banner to your Presentation
You can add a cookie notice banner popover to your Presentation that notifies users that the site stores third party cookies.
To add the cookie notice popover, you must add the Cookie Notice V3 component as a child to the Page V3 component. Follow the step-by-step guide below for more instructions.
Step-by-step guide
Arrange the components:
From the CMS, select the hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Using the Component Selector tool, drag the Cookie Notice V3 component into your Presentation and make it a child to any Page V3 component.
Select save.
Configure various component properties:
Navigate to the Cookie Notice V3 component and select the details button.
Enter values for the following property fields: CookieText - The text that appears on the banner, typically explaining that by continuing the user agrees to the cookies. CookieLink - A link typically to your privacy policy. CookieLinkText - The text of your link.
(Optionally, enter values for the following property fields: Styling BackgroundColor - a hexadecimal field and color palette for the banner color. If unused, the default color will be used. Styling TextColor - a hexadecimal field and color palette for the text color.)
Select save.
When a user visits the page, the page will check to see if Subscribe's internal cookie with a value of TRUE already exists. If it does, nothing will happen. If it does not, a cookie banner will display. When the user closes the banner, a cookie will be set with a value of TRUE and an expiration date of 120 days.
Add mobile-specific styling to a Presentation
If you have a Presentation you want to be shown on mobile devices also, you can add specific styling to it.
Step-by-step guide
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to the Page V3 component and select the Details button.
Ensure the following properties are configured:
MobileTitle - the title of the mobile presentation
MobileSubtitle - the subtitle of the mobile presentation
AlternativeMobileStyling set to On - enables mobile-specific styling
Any other properties with the MobileStyling prefix
Select Save.
Redirect mobile devices to a different Presentation
You can redirect mobile devices to different Presentations. This is helpful for ensuring that mobile users have the best Presentation possible.
Before you start
Before you follow the steps below, be sure to create a mobile presentation (please see above).
Step-by-step guide
To redirect mobile devices to a different Presentation:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to the Presentation Properties component and select the Details button.
Ensure the DetectMobileDevices property is set to On.
Add the mobile presentation's URL to the MobileRedirectUrl property.
Select save.
Add a favicon and meta title to your Presentation
A favicon or website icon is an image associated with your webpage that appears on the tab, bookmark, or URL, etc. The meta title tag is an HTML code tag that tells search engines and web browsers what the title of a web page is.
Before you start
Before you continue to the tutorial steps below, be sure to have created a Page V3 component.
Step-by-step guide
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to the Page V3 component and select the Details button.
Ensure the following properties are configured:
PageMetaData Title - the page's meta data title
PageMetaData Favicon - favicon image
Select Save.
Add OG tags to a Presentation
Open Graph Meta Tags (OG tags) control how URLs are displayed when shared on social media. To create an OG tag, you need to configure just a few properties of the Presentation Properties component.
Step-by-step guide
To add OG tags:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to the Presentation Properties component and select the Details button.
Ensure the following properties are configured:
OgTags Description - the description that displays when your page is shared.
OgTags Image - the image that displays when your page is shared.
OgTags SiteName - the website name that displays when your page is shared.
OgTags Title - the title that displays when your page is shared.
Select Save.
Enable CAPTCHA/ReCAPTCHA for a Presentation
You can enable CAPTCHA and ReCAPTCHA on a Presentation, as well as set a ReCAPTCHA score. ReCAPTCHA element helps you to protect yourself from fraudulent transactions coming in from the Subscription Panel.
Step-by-step guide
To add ReCAPTCHA to a presentation and set the ReCAPTCHA score:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Add Recaptcha V3 component (from Widgets & Alerts category) as a child to the Step V3 component. Typically Recaptcha V3 is added to the 'Place Order' Step V3.
Navigate to the Presentation Properties V3 component and select the Details button.
Ensure the following properties are configured:
TurnOffCaptcha set to Off
Select Save.
Recaptcha V3 is a little different than Invisible Recaptcha. Recaptcha will score every user session with a rating between or equal to 0.0 to 1.0
0.0 = Most likely a bot
1.0 = Most likely human
During the subscription process, that score is returned to Naviga. Depending on the threshold set in your Recaptcha V3 and the score that Recaptcha returns to us, will determine on the expected result.
Examples
If your Recaptcha component is set to a score of 0.3 and the score that Recaptcha returns is 0.7 then the expected result is to allow the user to continue the subscription process because their score was above the threshold.
If your Recaptcha component is set to a score of 0.7 and the score that Recaptcha returns is 0.5 then the expected result is to block the user from continuing the subscription process with the error message “There is an error placing your order. Please contact customer service to make your purchase.” Note, this message is not editable via CMS. Any changes to the message require product development assistance.
An easy rule of thumb to use when setting your score value is:
The higher the score on the Recaptcha V3, the HARDER it is to pass Recaptcha
The lower the score on the Recaptcha V3, the EASIER it is to pass Recaptcha
If you would like access, please provide your Naviga Project Manager with a gmail account(s) you want the access to be granted.
Add padding to your Presentation
There are two types of padding:
Step padding - the space between step components
Input padding - the space between input fields
This feature allows you to add precision to the look of your Presentation. For the simple theme, by default there are 10px of space between steps and 20px of space between inputs. For the default theme, by default there are 30px of space between steps and 30px of space between inputs.
To change these, follow the guide below.
Step-by-step guide
To edit padding:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to the Presentation Properties V3 component and select the Details button.
Edit/add the InputPadding property to change the input space.
Edit/add the StepPadding property to change the step space.
Select Save.
Add a newsletter signup option to the confirmation page
You can add a newsletter signup option on the confirmation screen.
Before you start
Before you continue to the steps below, be sure that you have a Confirmation V3 component configured as a child of a Page V3 component.
Step-by-step guide
To add this option:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to the Confirmation V3 component and select the Details button.
Ensure the following properties are configured:
NewsletterSignUp Show set to On - enables the Newsletter signup option
Newsletter Sign Up Show In The End set to On - shows the option at the end of the subscription confirmation
NewsletterSignUp PreferenceIDList - the list of IDs that you wish to sign your user up to
NewsletterSignUp ConfirmationMessage - the message the user sees upon signing up
NewsletterSignUp Errors Title - the error message a user sees if an error occurs
Select Save.
The above list details the recommended or mandatory. Any property with the NewsletterSignUp prefix is related to this feature.
Enable coupon codes in your Presentation
You can enable coupon codes (called multi-use codes in Solicitor) field. This allows a user to use a coupon code to access a particular offer. This feature is available on any landing type. To add this feature, you must configure properties on either the Promotion Digital V3 or Promotion Zipcode V3 components.
Before you start
Before you continue to the tutorial steps below, make sure you have completed the following tasks:
configured multi-use codes in Solicitor Concierge
Added either the Promotion Digital V3 or Promotion Zipcode V3 components as children to the Landing - Tiles V3 component
Step-by-step guide
To add the coupon code option:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to either the Promotion Digital V3 or Promotion Zipcode V3 components and select the Details button.
Ensure the following properties are configured:
Action Coupon Show set to On - enables the coupon code field
Action Coupon ShowText - e.g. "I have a coupon"
Action Coupon HideText - e.g. "Hide coupon"
Action Coupon Placeholder - the default text that appears in the coupon code field (e.g. "coupon code")
Action Coupon Validation Required Message - the message that appears when the coupon is validated
Select Save
The above list details the recommended or mandatory. Any property with the Action Coupon prefix is related to this feature.
To view the coupon in a modal window, toggle ActionsinModal to On.
Add Google's Address Autocomplete
You can add Google's Address Autocomplete feature to your Presentation. The Address Autocomplete feature displays address recommendations when user's begin to fill out address information fields.
Before you start
Before you continue to the tutorial steps below, be sure to complete the following tasks:
Add the Billing Information V3 and Delivery Information V3 components as children to the Step V3 component.
Step-by-step guide
To add the Address Autocomplete feature:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components will appear below.
Navigate to the Delivery Information component and select the Details button.
Ensure the following properties are configured:
AddressLine AutoComplete Apply set to On - enables the address autocomplete feature
AddressLine AutoComplete ApplyGeoLocation set to On - enables geolocation suggestions
Select Save.
Repeat steps 1-6 for the Billing Information component.
Enable one-time use codes for a Presentation
You can enable one-time use codes field on your Presentation that allows users to bring up a particular offer.
Before you start
Before you continue to the tutorial steps below, be sure you have completed the following prerequisite steps:
Created a Step V3 component and made it a child of a Page V3 component.
Step-by-step guide
To enable one-time use codes:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components appear below.
Add or create the component OneTimeUse Codes V3. Make this component a child of your Step V3 component.
Select Save.
The properties for the OneTimeUse Codes V3 component are optional. Some common ones are: - ShowButtonText - the default text for the coupon code field (e.g. "enter code here") - Properties with the Button Styling prefix - properties that change the styling - SuccessMessage - the displayed message when a code is used successfully
Create an international Presentation
You can create international Presentations that support non-US countries.
Before you start
Before you continue to the following tutorial steps, be sure you have completed the following prerequisites:
Create a Presentation Properties component.
Create a Delivery Information V3 component and make it a child of a Step V3 component.
Create a Billing Information V3 component and make it a child of a Step V3 component.
Step-by-step guide
To enable international functionality:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components appear below.
Navigate to the Presentation Properties component, select the Edit button, then ensure the International property is set to On.
Select Save.
To enable international address lines:
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components appear below.
Navigate to the Delivery Information V3 component, select the Edit button, then ensure the following properties are configured:
PostalCode Show is set to On - enables the international postal codes
PostalCode Title - title for the international postal code field
Country Show is set to On - enables non-US countries
AddressLine Show is set to On, and other properties with the AddressLine prefix configured
SecondAddressLine Show is set to On, and other properties with SecondAddressLine prefix configured
InternationalCity Show set to On - enables the international city field
Province Show set to On - enables the international province field
InternationalPhone Show set to On - enables the international phone number field
City Show set to On - enables US cities.
State Show set to On - enables US states.
Zipcode Show set to On - enables US postal codes.
Complete step 4 for the Billing Information V3 component.
Select Save.
Create a No-landing Presentation
You can create a No-landing Presentation.
Step-by-step Guide
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components appear below.
Search for the Landing component and select the Delete button. If this component doesn't exist, continue to the next step.
Navigate to the Presentation Properties component and select the Details button. The component's details expand below.
Add the Offer Group ID of the offer you wish to associate this Presentation with to the DefaultOfferGroupID property.
Select Save.
Change Subscription Panel's theme
You can switch Subscription Panel's theme and select between Default, Simple or Seamless themes. They are depicted below.
Step-by-step guide
From the CMS, select the Hierarchy button and choose a level (Client, Newspaper Group, or Newspaper).
Select Subscription Panel, then choose Presentations.
From the drop-down menu, select the Presentation you wish to edit. The Presentation's structure and components appear below.
Navigate to the Presentation Properties component and select the Details button. The component's properties expand below. Ensure the following property is configured: Theme - choose either Simple or Default
Navigate to the Page V3 component and select the Details button. The component's properties expand below. Ensure the following property is configured: Page Type - choose either accordion, expanded accordion, one, full page, or progressive. Note: examples are in the Overview section above.
Select Save.
Before you continue to the tutorial steps below, be sure you have
RecaptchaScore - scores range from 0.0 to 1.0, where 0.0 indicates abusive traffic and 1.0 indicates good traffic. See for more information.
Additionally, Google provides a , where users can review all requests from the past 7 or 90 days and what they scored them as. This helps in understanding what a typical score is for your userbase and ultimately guide you on how high or low to set your Recaptcha V3 score.
Enable Google's , get an API key, then provide that key to a Naviga implementation manager.
Review Google's .
Configured .
Analytics
Common query parameters
The table below defines the common query parameters. Of these, the most common (and important) are ofrgp_code and promo_code, which define what offers and promotions are presented to customers.
The table below defines the common query parameters used for analytics.
Parameter
Description
utm_medium
Google analytics tracking code used to track the marketing medium
utm_source
Google analytics tracking code used to track the source/referrer
utm_campaign
Google analytics tracking code used to track a promotional campaign
utm_content
Google analytics tracking code used to differentiate ads
utm_term
Google analytics tracking code used to identify paid keywords
g2i_source
Naviga's custom tracking code used to track the source/referrer. The tracking information is sent to G2Instights
g2i_medium
Naviga's custom tracking c track the marketing medium.The tracking information is sent to G2Insights
g2i_campaign
Naviga's custom tracking code used to track a promotional campaign. The tracking information is sent to G2Insights
g2i_or_o
In NCS circ this is used to override source code parameter
g2i_or_p
In NCS circ this is used to override sub source parameter
g2i_or_os
In NCS circ this is used to override campaign code parameter
dtmtype
loads adobe script
Parameter
Description
abdCartId
Id of previous session. Subscription Panel gets all data by this ID and auto-populate it
code
user id from BloxCMS user provider. Appended automatically after redirect from external login page
Couponcode
overrides PID in favor of any promotion with that coupon
debugMode
(boolean) sp writes events into browser console
EEproduct
overrides electronic edition product on config
email
email
giftCode
value for InputGiftCode component. If code is valid, panel will pass verification automatically
ofrgp_id
pre-selected offer for 3.X version
ofr_id
auto-select offer with the given ID
PID
Legacy PID
siteCode
way to reference a different site code. Only works when CMS paper code & SubCon paper code are the same
onetimeCode
one time code for a specific offer/promotion
Google Analytics
Google Analytics captures every triggered event on the Subscription Panel through the G2Plugin. In the table below you can find the list of the events and their description.
Card abandonments analytics are collected in two ways. For Naviga Discover clients, they are tracked and recorded by Naviga. For non-Naviga Discover clients, they are tracked with Google Analytics.
Event Name
Description
presentation_loaded_e
Event fires when presentation loaded.
offers_presented_e
Event fires when offers presented.
offer_selected_e
Event fires when user selected offer.
step_activated_e
Event fires when user came to step.
step_completed_e
Event fires when user completed step.
user_came_to_user_info_e
Event fires when user came to billing user information component.
user_info_completed_e
Event fires when user completed user information component.
address_error_e
Event fires when user got error on address component.
payment_error_e
Event fires when user got error on payment component.
user_info_error_e
Event fires when user got error on userInformation component.
user_logged_in
Event fires when user logged in.
user_came_to_billing_address_e
Event fires when user came to billing address component.
billing_address_completed_e
Event fires when user completed billing address component.
user_came_to_delivery_address_e
Event fires when user came to delivery address component.
delivery_address_completed_e
Event fires when user completed delivery address component.
add_subscription_success_e
Event fires when user created subscription.
user_came_to_payment_e
Event fires when user came to payment component.
credit_card_completed_e
Event fires when user completed payment component using credit card component.
bank_account_completed_e
Event fires when user completed payment component using bank account component.
bill_me_completed_e
Event fires when user completed payment component using bill me component.
apple_pay_completed_e
Event fires when user completed apple pay.
swg_completed_e
Event fires when user completed swg.
selected_payment_option_e
Event fires when user selected payment method on payment component.
created_new_user_e
Event fires when user registered as new user.
notification_error_e
Event fires when user got information error on page.
zip_is_not_deliverable_error_e
Event fires when user got error on promotion because zipCode is not deliverable.
no_offers_error_e
Event fires when user got error on promotion because we don’t have any offers.
presentation_failed_e
Event fires when presentation failed.
add_subscription_failed_e
Event fires when user got error when trying create subscription.
page_was_not_found_error_e
Event fires when user came with wrong url parameters.
apple_pay_presented_e
Event fires when offers presented with Apple Pay available.
landing_is_displayed_e
Event fires when landing component is displayed on page.
landing_is_completed_e
Event fires when user completed landing component.
promotion_popup_is_shown_e
Event fires when pop-up box on a landing is shown.
abandon_presented_e
Event fires when abandonment pop-up is shown
abandon_closed_e
Event fires when abandonment pop-up is closed
idle_presented_e
Event fires when idle pop-up is shown
idle_closed_e
Event fires when idle pop-up is closed
upsell_selected_e
Event fires when user selectes upsell offer
upsell_removed_e
Event fires when user deselectes upsell offer
paypal_completed_e
Event fires when user completes paypal payment method.
"paypal" property will be set to true and "paymentOption" property should have value paypal or paypalExpress or paypalDTI
mobile_app_click_e
Event fires when a user clicks on a button that redirects to a mobile application to download.
newsletter_click_e
Event fires when a user clicks on a newsletter option button that does a request to set a subscription.
continue_click_e
Event fires when a user clicks on a continue button on confirmation.
eedition_click_e
Event fires when a user clicks on a button on e-edition section on confirmation.
smart_speaker_click_e
Event fires when a user clicks on a button on smart speaker section on confirmation.
small_external_click_e
Event fires when a user clicks on a button on small external section on confirmation.
social_click_e
Event fires when a user clicks on a link that redirects to a social media.
user_came_to_place_order_e
Event fires when user came to placeOrder component.
place_order_completed_e
Event fires when user completed placeOrder component.
user_came_to_terms_e
Event fires when user came to terms&conditions component.
google_tag_manager_is_not_loaded
Event fires if errors occur during GTM loading
google_analytics_is_not_loaded
Event fires if errors occur during GA loading
promotion_code_presented_e
Event fires if offers are loaded by promotionCode
Presentation URLs
A Presentation URL consists of three things:
Base URL - Need a definition/where does this come from? (e.g. checkout-demo.subscriberconcierge.com)
Presentation URL - this is akin to a path parameter. You create this in the Presentations section of the CMS (CMS > Subscription Panel > Presentations).
Query Parameters - options that define your request further.
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Welcome
Welcome to the CMS User Guide!
Our Content Management System (CMS) aims to provide you with complete management of your Subscriber Concierge Site (also referred to as Self-Service or Account Management).
The Subscriber Concierge Site is the self-service, end-user website that allows subscribers to manage their account and subscriptions.
Guide structure
This guide is composed of the following main elements:
Overview - gives a brief introduction to the various features covered in this guide
This section of the guide contains tutorials, how-tos, and reference material for the CMS. Here you will find in depth information for working with the CMS.
This section covers the following topics:
Overview
After your users have bought the subscription, they can continue working with the Subscriber Concierge Site self-service application to manage the subscription(s).
They can also be redirected to the Subscriber Concierge Site from the Subscription panel if they are already subscribers and log in or go to their account.
Navigating CMS
The annotated screenshot below depicts the various features of the CMS. View the CMS Features & Definitions heading below to get descriptions of the core CMS Features.
CMS Features & Definitions
Manage Cache
To see the effect of the changes made in CMS at the Subscriber Concierge Site pages, it is necessary to clear the cache using the ‘Manage cache’ button with a dropdown in the header. To refresh both CMS and Subscriber Concierge Site and thus see all the recent changes made you should select the ‘Refresh CMS + Site’ option in the dropdown.
For this functionality to work properly the URL of the Subscription Panel you’re managing should be filled correctly in the Clear cache subsection of the Admin section in CMS.
Note: the URL should be written as http:// not https://
CMS Hierarchy
There are three levels in the CMS hierarchy (listed from the top one to the bottom one):
Client division (Root) - the highest level. Contains one or more divisions.
Division - unique identifier of hierarchy level where an entity value exists.
Entities are always stored on this level (entity - a record/row in the database that is stored on the Root level (e.g. in dbo.Benefit_Root). It has its own settings, properties and values. e.g. benefit, attribute, a segment of content and so on)
Newspaper group level - the middle level. Contains Newspaper Group divisions where each division is a child object of the Client division. This division can include one or many Newspapers. Objects of this division can have their own overridden values.
Newspaper level - the lowest level. Contains Newspaper division(s) where each division is a child object of the Newspaper group division. Like Newspaper group division, objects of this division can also have their own overridden values
Entity values like structure, components and properties can be stored on any level of the hierarchy.
We suggest organizing the hierarchy by configuring widely used settings at the Client level, then overriding them at lower levels when necessary.
In some cases, overriding is the best way to manage settings (e.g. overriding Attribute for different Newspapers) and doing so will enable smooth management in the future.
Attributes
This section manages Attributes.
An attribute is a specific parameter that makes content management easier.
Attributes are consumed by all the apps, even by email and CMS itself - e.g. Attributes can be used in the Benefits section. Attributes are not predefined but are freely defined by the user.
Benefits
This section is used to create and customize exclusive profits for the end-users called Benefits. Theoretically, you can customize these to display anything, but we've designed them so that you can easily communicate the benefits of your subscriptions to your customers. You can toggle whether these display for individuals not currently logged in.
The image below represents an example of a Benefit in CMS at the Home page of Subscriber Concierge Site:
Rewards
This section manages the rewards - special bonuses the subscriber can get. Rewards are displayed at the Rewards Subscriber Concierge Site page (a subscriber can be redirected to this page by clicking on the benefit containing the Reward at the Home page or select it from the header).
Similar to the benefits boxes, they are easily customizable, but we've designed them so that you can easily communicate customer rewards to your customers.
Content
This section deals with content of the Subscriber Concierge Site pages e.g. headers, button text, main text etc. Separate pieces of content are called Segments. Segments are contained within the page so the final structure looks in the following way: Page → Segment → Content.
To create a new Segment or a new Page or (re)assign Segments to a Page please go to Page/Segment Management Subsection of Admin section. The subsection has 3 forms that work independently:
Page Management - to create/edit Page; the Page should have unique Name and URL; Active toggle indicates whether the Page will be displayed to the end users or not
Segment Management - to create/edit Segment;
Assign Segments - to re(assign) Segments within an existing Page.
It is strongly recommended both to create pages and Segments manually. In case you need to manage Pages/Segments please contact the CMS team.
FAQ
This section is optional for a Client as some of them prefer to set up this page not as a part of Subscriber Concierge Site application but as a part of their own site.
Questions and the corresponding answers could be displayed in a list or arranged into FAQ groups.
Images
This feature is used to manage the various images in your Subscriber Concierge Site.
Each image has a category that determines where or how the image is used.
All the images used at Subscriber Concierge Site pages are created according to two templates. In the table below you can find the recommended sizes/resolutions for the images:
Template
Size Recommended
Where Is Used
Template A
1680x260
Banner
280x120
Auth Panel
270x100
Email Preferences
Template B
730x480
Slideshow
260x175
Email Preferences
Slideshow
From 3.0 version and higer the Slideshow is supported for the Home page only.
The Slideshow is a carousel of pre-defined Slides displayed one after another. The Slides advance to the next after a specified amount of time or a specific Slide can be selected manually using carousel navigation controls and carousel selector.
Notifications
The notifications are managed using different CMS sections: Admin User manages notification using Notification Management Subsection of Admin section while a regular user can override those parameters at the consumer level in Notifications section. This section exists on the Root level only.
There are four subcategories:
Notifications New - a list of every notification;
Notifications New Management - tool to create new notifications;
Test Notification New - tool to test notifications;
Consumer Items Management - tool to create, edit, or delete consumer items.
Navigation
Use this tool to manage links for the following categories:
Links - create, edit, or delete all of your links in your Subscriber Concierge Site;
Menu - create, edit, or delete links in the menu;
Footer - create, edit, or delete links and styling in the footer of your Subscriber Concierge Site.
Email Content
Use this tool to construct emails either by adding RSS to the email or by adding HTML pieces to the email body.
This section is not directly consumed by the Subscriber Concierge Site application but uses Subscriber Concierge Site pages as a source for RSS sent in emails.
Admin
Use this tool to manage various admin features:
User Management - add, edit, or delete users or user information.
Page/Segment Management - add, edit, or delete Pages or Segments, and assign segments to pages.
Notification Management - add, edit, or delete notifications.
Newspaper Management - add, edit, or delete newspapers (divisions).
Clearcache Urls - add, edit, or delete clearcache URLs.
CMS Settings - manage various CMS settings.
How to Create a New Page
Goal
The goal of this guide is to explain how to create a new page from scratch and fill it with all the content you'd like. The main steps would be:
create a blank page
create segments, fill them with content and assign them to the page
add menu
add footer
Before you start
Make sure you have Admin permissions in CMS
Page Creation Guide
Create a blank Page
From the CMS, select Admin from the sidebar, then select Page/Segment Management. The page and segment management screen appears.
Select the + Add button in the Page Management container. The page fields become active.
Fill in the following fields:
Name - unique name of the page;
URL - URL of the page;
Active - toggle to either On or Off to determine whether the page will be active
4. Select Submit.
Create a Segment
From the CMS, select Admin from the sidebar, then select Page/Segment Management. The page/segment management screen appears.
Select the + Add button in the Segment Management container. The segment fields become active.
Fill in the following fields:
Name - unique name of the segment;
ControlId - control id of the segment;
Description - description of the segment;
Content - the content of a segment;
4. Select Submit.
Add Menu
You can create, edit, or delete menu, as well as assign links to a menu.
Create a menu
From the CMS, select Navigation from the sidebar, then select Menu. The menu manager screen appears.
Under the Links Assignment container, select the + Add button. The link menu fields below become active.
Fill out the required fields, then select the Save Icon button. Your menu now appears in the Menu drop-down list, and you can add links to it.
Assign Links to a Menu
From the CMS, select Navigation from the sidebar, then select Menu. The menu manager screen appears.
Under the Links Assignment container, select a menu from the Menu drop-down list. The available links appear in the Available Links container to the left, and your menu's links container appears to the bottom.
Drag the desired links from the Available Links container to the Menu Links container. Arrange them to your desired order.
4. Once finished, select Save.
Add Footer
Once you have created your links, you can manage your footer. A footer can have multiple columns, each with multiple links. The columns appear horizontally, while the links stack vertically underneath each column.
If you use only a single column, the links will align vertically into a row.
Create a Footer Column
From the CMS, select Navigation from the sidebar, then select Footer. The footer management screen appears.
Select the + Add button from the Link Assignment container. The column creation window appears.
Enter a name for your column, then select Confirm. Your new column appears in the Link Assignment container.
Assign Links to a Column
From the CMS, select Navigation from the sidebar, then select Footer. The footer management screen appears.
Drag and arrange Available Links into the desired footer. The order in which you arrange the links is the order in which the links will appear on the SubCon Site.
To learn more about managing attributes please check .
Learn more about managing benefits in .
We've collected more information on how to manage rewards .
Learn more on how to manage content in .
Please, have a look at to learn more about managing the FAQ section.
Before using images anywhere in CMS they should be uploaded to section. The images could be then used for Attributes, Benefits, Links, Slideshows, RSS, Social media and Subscription Panel.
To know more about how to manage images, please study .
Learn more on managing the slideshows from .
Please study to get more information on how to manage notifications.
To get a full guide on how to manage navigations and links please study .
Get more information on how to manage newspaper groups in .
A Segment can contain not only plain text but also Attributes and Images that should have been previously uploaded to thesection. For more information on pages and content management please check .
To get more info on navigation management, please have a look at .