Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This document contains information about Complimentary subscriptions, including the setup 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.
Please note that this information has been moved from the New Starts page.
Please note that this document is currently under revision. Last changes were made on Oct 10th, 2023.
A Complimentary Subscription Purchase does not require the subscriber to provide payment information or payment. Subscribe clients may offer Complimentary (free) Subscriptions to their employees, partners, advertisers, etc.
The goal of this section is to explain how to configure a Complimentary Subscription Purchase in Naviga's Solicitor Concierge and CMS dashboard.
Starting from Release 3.15, the ‘Comp Subscription’ payment method is hidden from the available Payment methods section. If the ‘Complimentary’ checkbox is enabled, all the other payment method options will be disabled.
This feature allows users to create a fixed term (with an end date) or unlimited (no end date) free subscription.
Unlimited Complimentary subscriptions (Subscription Kind = Comp with the option 'No end date' selected) are supported from Subscribe 3.16.2 onwards.
If the subscription is set up as unlimited, the subscription can be stopped at any time via Account Management or by calling a CSR rep.
Complimentary Subscriptions cannot be turned into paid subscriptions. If you are interested in this functionality, please check Trial-with-Payment Subscriptions.
Complimentary subscriptions do not have access to payments, including EZPay, payment method updates, complaints, or vacations.
Please note that in the 3.16.2 Release, the flow was reworked with the following changes:
A new 'Complimentary' option is available under Offer Groups → Additional Options → Subscription Kind, replacing the earlier 'Comp' option. The Complimentary subscription can be either with 'No end date' or 'With end date'.
The complimentary subscription with no end date will be available for an unlimited period of time. If the user selects the option With end date, two additional fields are displayed under Complimentary Unit: a dropdown with values Day(s), Week(s), Month(s) and a text field that accepts Integer values greater than 0.
The options available under Subscription Kind are Complimentary, Lite, and Trial Subscriptions. Only one option from Subscription Kind can be selected for an offer.
The other validations added to Solicitor Concierge for Complimentary Offer Groups (Offer Groups → Coding → Billing system codes) are:
These validations will be applicable to existing Comp offers when a user tries to modify them.
The Purchase flow corresponds to various Start Types from the Offer API. Within the SP logic, the Complimentary flow has been mapped to the 'isComp' flag from the Offer API.
Complimentary subscriptions do not involve any payment from the subscriber. From an application perspective, a default PaymentTypeID value of '13' has been set for Complimentary subscriptions within the Subscription Panel.
The Purchase API for Complimentary flows has been revised as part of code clean-up and to distinguish between Complimentary and Trial Subscriptions.
The Purchase API has also been updated to accommodate Payment Method ID 5, which is 'Billed,' to support the Matrix client.
The 'Comp' option is configurable from MG2control or Support Viewer, with a new property added to App settings ('OfferGroupAdditionalOptionIsCompFlag').
To configure the 'Comp' option, you need to follow these steps:
Navigate to Support Viewer → Management → App settings.
In the Filters section, set the following parameters:
Setting type: Client Component Permission
Key: OfferGroupAdditionalOptionCompFlag
App type: SolCon Admin
Click 'Search' and select a value from the 'Setting keys' grid.
Choose a value from the 'Clients group' dropdown (e.g., Mg2 Groupstripe) and 'Environment' drop-downs. Note: Set the value as either 0 or 1 for any selected client.
After making the change, click 'Update.' A popup will appear, click 'Execute.'
Due to changes in the 3.16.2 release, the setup for Complimentary subscription differs between previous releases and versions 3.16.2 and above. Please refer to the relevant section below.
For this feature to be implemented the following prerequisites must be met:
The minimum Subscribe version is 3.13 and the minimum NCS circ version is 2020.2.0. The client must be on the latest subscribe extracts that include demographics data
To set up a Complimentary offer with an end date in Solicitor Concierge please perform the following steps:
Select offer groups from the left sidebar.
Select an offer group from the list, or create a new offer group.
Set the price as $0. Please note that even if you set the price >0 then it will not be charged but can be displayed on UI during checkout.
Select the additional options category, then select the Subscription Kind section, select 'Complimentary' and enter the number of trial days that are offered (please note that you can enter up to 10 digits). Once the offer group the number of comp days cannot be edited and the 'Complimentary' checkbox cannot be unchecked
In the additional options category go to EZPay section and select the No EZPay option.
Select the coding category, then select the billing systems code drop-down menu.
Designate the billing method as UnPaid Comp.
Select update or save as new.
The steps described above are mandatory. As the majority of complimentary subscriptions don't have print products, we recommend using ZIP-only checkout for them.
To configure an offer for ZIP-only checkout please go to the additional options category, then select address requirements section and uncheck the billing address, delivery address and run product delivery check checkboxes.
No additional CMS setup is required.
Even if the presentation has one or more payment methods added as children of Payment Method V3 component they will not be displayed if they are not checked in Solicitor Concierge.
As the majority of complimentary subscriptions don't have print products, we recommend using ZIP-only start. Please see the guide for more details
As the proper Complimentary Subscriptions (SubscriptionKind = Comp) without an end date were not supported in NCS prior to 3.16.2, this guide is merely a roundabout, describing how to set up a free-of-charge subscription valid for an unlimited period of time. SubscriptionKind will be Standard.
To set up a Free-of-charge offer with an end date in Solicitor Concierge please perform the following steps:
Select offer groups from the left sidebar.
Select an offer group from the list, or create a new offer group.
Set the price as $0.Please note that even if you set the price >0 then it will not be charged but can be displayed on UI during checkout.
Select the additional options category, then select the Payment Method section and select the Billed checkbox.
In the additional options category go to EZPay section and select No EZPay option.
Select the coding category, then select the billing systems code drop-down menu.
Designate the billing method as Unpaid Comp.
Select update or save as new
Some additional CMS setup is required for this method to work as expected: under the Payment Methods V3 component, please add Bill Me V3 as a child component.
Prerequisites for the implementation of Complimentary Subscription:
The minimum Subscribe version: 3.16.2
The minimum NCS Circ version: Rapid Release 2020.4.1
If you were previously using Comp subscriptions, please ensure that your existing Comp offers include a Reason code and Delivery method for correct functionality.
Prerequisites for the implementation of Complimentary Subscription:
The 'Comp' option should be configured from MG2control or Support Viewer by setting the value 1 to the key OfferGroupAdditionalOptionIsCompFlag. Check here for the configuration steps.
Comp offer must be set up in the Subscription Presentation in the CMS application.
To set up a Complimentary offer in Solicitor Concierge perform the following steps:
Navigate to the Solicitor Concierge application. Select the menu option Offer Groups from the left sidebar.
Either select an already created Offer Group from the list available at the right panel or create a new Offer Group.
Enter the name of the Offer group.
Set the Price as $0. Note that even if you set the Price >0, it will not be charged but can be displayed on the UI during checkout.
Click Divisions section. The Divisions available will be displayed in the right panel. Click any Division name to select that Division.
Click the Coding section to open its options in the right panel.
Click open the Custom codes section. Enter a value in the Source field
Click open the Billing systems code section. Enter the Reason code, Billing method (either Paid Comp or Unpaid comp), and Delivery method.
Click the Additional options section to open its options in the right panel.
Click open the Subscription kind section. Check the option Complimentary.
Select either With end date option or No end date option as per your requirement.
If you are selecting 'With end date' option, select the unit (Day(s), Weeks(s) or Month(s) from the below drop-down. Also, enter an integer value greater than 0 in the below text field to denote the validity time period for the offer. Note: If you set the offer time duration a warning message will be displayed in case the subscription duration is set >720 days in any selected units: Please verify your publishing calendars and ensure the date is supported.
If you want to collect the user's address during check-out, click open the Address requirements section. Check the option Billing Address.
Check the option Active (if it is not checked) to make the offer group active.
Note:
In Additional options > Payment Method, the "Comp Subscription" checkbox, which was present in previous versions, has been disabled and hidden via configurations since it is not relevant for Comp Subscriptions. Even if it is enabled on the UI, it will remain unchecked. Added on 10-Oct-2023.
Click Publish if you are creating a new offer group. Click Save as new or Update if you are editing an existing offer group. The option 'Save as new' will create a new offer group from the current offer group whereas the option 'Update' will save the changes to the current offer group.
Click Clear Cache button at the top right panel of the SolCon. Click Sync button next to Clear Cache if you are creating a new offer group. This action will sync the new offer group with the CMS.
Added on 10-Oct-2023
Previously, the Comp presentation for Digital Zip-Only subscriptions required both a Payment Method and a Bill Me component. Payment Method and Bill Me components are no longer valid for Comp presentation, and Independent Address Component should be used instead.
For Print Comp Subscriptions, the Billing Address and Delivery Address Components should be added with the Address fields enabled. The Address Requirements: Billing Address and Delivery Address checkboxes must be selected at the Offer level in SolCon.
As the majority of complimentary subscriptions don't have print products, we recommend using ZIP-only start.
The Comp option is Configurable from MG2control or Support Viewer. A new property ('OfferGroupAdditionalOptionIsCompFlag') is introduced in the App setting. Follow the steps explained at the top of this page to configure the Comp option.
For Matrix we are calculating the expected end date based on the complimentary days set up in Solicitor Concierge.
For this feature to be implemented for the Matrix circ system the following prerequisites must be met:
The minimum Subscribe version is 3.14.1 and the minimum circ version is 38.00.034 P4
The client must be on the latest subscribe extracts that include demographics data
To set up a Free-of-charge offer with an end date in Solicitor Concierge please perform the following steps:
Select Offer Groups from the left sidebar.
Select an offer group from the list or create a new offer group.
Set the Price as $0. Please note that even if you set the Price >0, then it won't be charged anyway but dependent on the presentation setup might be displayed on UI during checkout.
In the Complimentary section check "Enable" and enter the number of free days that are offered (please note that you can enter up to 10 digits). Note: Offer group cannot be saved without the number of free days entered. Once the offer group is published the number of free days cannot be edited.
Select the Additional options category, then select the Payment Method section and select the Billed checkbox.
In the Additional options category go to EZPay section and select No EZPay option.
Select the Coding category, then select the Billing systems code drop-down menu.
for the fixed term Complimentary offer: set the Rate code to IEDGPRM_TR. This code is set up in Matrix to NOT renew the subscription at 0 cost. Then define source code, reason code, and paper code.
for the unlimited term Complimentary offer: Set the Rate code to IEDIGPRMFR. This code is set up in Matrix to bill 0 dollars forever. Then define source code, reason code, and paper code.
Select Update or Save as new.
Some additional CMS setup is required for this method to work as expected.
Under the Payment Methods V3 component, you will need to add Bill Me V3 as a child component.
This document contains information about Trial-with-Payment subscriptions, including the setup 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.
Please note that this document is currently in progress
Trial-with-Payment subscriptions allow end-users to try the subscription for free before they decide whether they are going to purchase it.
Unlike traditional Trials (which have been redesigned as Complimentary Subscriptions), Trials with Payments have been introduced as a new Subscription Kind with the value ‘Trial’ for clients with NCS circulation system.
Please note that for now only digital subscriptions are supported. Print/hybrid are on the way
However, this feature lets a publication collect payment information like CC, Bank details when an end user subscribes to the Trial. The payment information is collected and only authorized for $1 without actually deducting any money from the subscriber’s account at the time of Trial purchase. The payment information is tokenized and submitted to NCS circulation system.
Publications can define a Trial duration in Days, Weeks or Months within the SolCon Application independent of the actual rate & term for that offer.
EZPay (Auto-renewal) is mandatory for Trial offers, hence at the end of trial period, a subscriber is charged for a standard subscription using the tokenized information.
Regardless of payment success/failure, when Trial End Date is reached, the subscription kind in Subscribe changes from Trial to Standard. The actual status of subscription, however, will depend on the payment status, it can be Active when payment is successful or Perm Stopped / In Grace depending upon Trial specific Grace period setup in NCS. For more details on Trial features within NCS, click here.
In Account Management a new banner has been added for Trial subscriptions as a reminder of Trial end date. It is displayed every time a subscriber logs in to Account Management till the Trial period ends. The user can close this banner if required using the X option.
In One CSR Portal a similar banner with a warning message is displayed above the tabs.
For this feature to be implemented the following prerequisites must be met:
The minimum Subscribe version is 3.16.2 and
the minimum NCS Circ version is 2020.4.0
Subscribe extracts version 5 is required
Please note that during implementation the sync job has to be updated to 3.16.2.
To set up a Trial-with-Payment offer with an end date in Solicitor Concierge please perform the following steps:
Select offer groups from the left sidebar.
Select the additional options category, then select the Subscription Kind section, select '
Trial and enter the number of trial days/weeks/months that are offered. Once the offer group is published, the number whole Subscription Kind section including the number of trial days cannot be edited.
In the additional options category go to EZPay section and ensure EZPay required option is selected.
Select the coding category, then select the billing systems code drop-down menu. Set Delivery method to Online as for now the feature is supported only for subscriptions without print products.
Select update or save as new.
In CMS no specific setup is required
The trial option is configurable from MG2control or Support Viewer. New property has been created in AppSetting ('OfferGroupAdditionalOptionTrialFlag').
Follow these steps:
Go to Support Viewer → Management → App settings
In Filters section → Setting type: client component permission, Key: OfferGroupAdditionalOptionTrialFlag , App Type : SolconAdmin
Click Search → Select value from Settings Keys Grid.
Select a value from the Client Group dropdown (Ex. Mg2 Groupstripe) Note: Update the value as either 0 or 1.
After changing the value click Update. A pop up will open. Click Execute.
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.
Prior to Release 3.14.2, the Newstart flow was using Subscription API which had issues like poor performance (more than 20 seconds), multiple authorizations when auth event fails and user retries, missing support to reprocess events etc. In order to solve all these issues, Subscribe refactored the SubscriptionAPI and named it PurchaseAPI.
The purchase API has two execution parts: synchronous and asynchronous.
Please note that the synchronous part of the flow can be turned off for a consumer application using the Purchase.ProcessSync flag.
This can be useful for LTE. In case Purchase.ProcessSync flag is set to OFF user will get a permanent account number in the receipt
The synchronous part performs the input model validations and successful processing of the key events before showing success to the end-user. The asynchronous events continue to process in the background. In other words, the end-user sees failure on the screen if one of the synchronous events fails. On the other hand, the asynchronous step(s) would fail silently without any notification to the end-user.
A business user or customer service representative should review Event Viewer section of One CSR Portal on a regular basis to view, update, reprocess or close failed events.
Starting from 3.16.0 Release PurchaseAPI must be used for all new starts instead of SubscriptionsAPI.
Also, from 3.16.0, it is mandatory that consumer applications pass on the parameters for the Subscriber component (i.e., at least FirstName, LastName, and Email) in the Purchase API. Clients can achieve this by using either of these options in CMS: Billing Information, Payment Information, or the Independent Address component.
Note updated on July 11, 2023.
The Release 3.14.2 covers the refactor for Standard and Complimentary starts for NCS Circ+Payway. The rest of the start flavors and circ systems will continue using SubscriptionAPI. There is a plan in future releases to upgrade those.
Starting from the release 3.14.2 onwards Braintree support was added
Since the account in NCS Circ gets created as part of the asynchronous events, then the end-user will not see the account number on the confirmation page of the Subscription Panel as well as in the LTE receipt. They would however get this information in the confirmation email.
Database occupant lookup was replaced by real-time occupant lookup in NCS circ starting from 3.16.0 onwards. There are two types of lookup: standard and email only (default). Please see the details below:
Email Only: If this mode is set up, send Email and Exact Match=true to NCS. We should always expect NCS to return one Occupant.
Standard: If this mode is set up, send Email and Exact Match=false to NCS. We might get multiple records. The result set is filtered by First Name, Last Name and Email (all of them should match) and the first occurrence is picked.
to switch between the lookup types please use Purchase.GetSubscriber.LookUpStategy setting in mg2control
Last changes made July 5th 2022
The following table represents events that occur in the purchase API flow.
When using the Synchronous flow, the API returns a success only if all events get processed successfully. However, in the case of an Asynchronous flow, the API returns a success first, and events marked "🗶" occur in the background.
Note updated on July 11, 2023.
The subscriber concierge admin displays the failed events. When the user process the failed event, the Subscribe API process all failed events. The business user will need to check why the start failed and fix it before reprocessing.
To understand how the reprocessing works let’s follow this example:
The user submits the form in the consumer application
PurchaseAPI accepts the Input model (everything passed: Validations, Address Standardization, Auth, etc.) and creates STARTSTD event
PurchaseAPI returns a successful response back to the consumer application and triggers the asynchronous steps behind the scenes
PurchaseAPI fires CREATESUBSCRIBER as part of the asynchronous steps.
NCS Circ returns an error because the Last name contained a special character that is not supported. As a result, CREATESUBSCRIBER is marked withevent_status=3(failed)
To reprocess this Newstart event, first we need to make the necessary changes to avoid the issue to happen again. In this case, we need to update the last name in STARTSTD event to remove that special character that caused the failure.
Once that’s fixed, the Reprocess endpoint can be called.
PurchaseAPI will get the events of the previous execution. In this example, only CREATESUBSCRIBER with event_status=3 will be found
PurchaseAPI will determine this step needs reprocessing. As a result, it will create a new CREATESUBSCRIBER event with the new Event Log data from STARTSTD event
NCS Circ will succeed this time and the event will be marked withevent_status=2(success)
PurchaseAPI will update the previous failed event from event_status=3 (failed) to event_status=11 (reprocessed)
Purchase API will continue the execution of the rest of the asynchronous
steps
To view, update and reprocess failed starts in One CSR Portal user should go to Event Viewer section and set the filter to display Failed New Starts while processed events should be hidden.
Please note that 'View event viewer' toggle of the 3 STARTSTD event should be set to YES to view this events in the grid. This flag can be found under Event management -> Event types
Filtered results set will be displayed in a grid where a CSR can see event information like Event ID, Event create date, Account Number, Error Message etc. In the Error message column you will see the information about the error that caused the start to fail. Same information can be found in the detailed information about the event.
Please note that the Account Number displayed in the grid is the temporary account number. If the start will be reprocessed successfully then this Account Number will be replaced by a permanent one.
To view the information about the event, update it, and reprocess please click 'Edit' button. The button will open a pop up with detailed information about the event
The fields below are available for an update before reprocessing the start, it’s advised not the update other fields
Delivery Address, including City, Code and Unit Number
Billing Address, including City, Code and Unit Number
First name
Last name
Edit field(s)
Click the 'Update' button
Refresh the page and confirm data update is successful
Make sure event updates, if needed, are complete
Click the 'Reprocess Newstart' button
View the success message displayed
The reprocessing creates a new child event with success status (id 2). The status of the previously failed event gets changed from failed to reprocessed (3 to 11). The reprocessed events do not appear in the event viewer
Please note that 'Allow resubmit' toggle of the 3 STARTSTD event should be set to YES to reprocess new start. This flag can be found under Event management -> Event types
A CSR can also click 'Mark as closed' button in case the failed start has been reviewed and the decision was made not to reprocess the event. In this case, the event will be updated with the event_status= 9(closed) and no longer displayed in the list of failed starts.
These are the scenarios when the failure is caused by the bad data entered by user on Subscription Panel. The most common case in this category is special characters in user name or surname, e.g. John Doe's . For these types of failures the best practice is to update the data in the Event viewer and reprocess new start.
To update the first and/or last name please open the Address info tab and update Billing first name and/or Billing last name field(s). Then click Update button and Reprocess.
This category covers all the failures caused by bad offer setup in Solicitor Concierge like wrong rate code and other billing codes. This data cannot be fixed via One CSR Portal so the CSR has to go to Solicitor Concierge, fix the offer setup and then reprocess the new start via Event Viewer.
There is an edge case where the business user has made major updates in offer data of the failed start in NCS Circ like billing codes, price, divisions etc. The reprocessing of failed starts will not work in this case as the data wouldn't match. It is advised to close the failed start and ask the customer to create a new start.
In this category we have the issues related with payment systems, APIs etc. Updating the new start data via One CSR Portal will not help in this case. It is recommended to make an attempt to reprocess (it will be successful if the third party issue is resolved). Or to close the failed start and ask the customer to create a new one.
The Restart feature allows an end-user/CSR to restart a stopped subscription that will be processed in the Matrix Circulation system. The restarting can be done through either Self-Service (SubCon Site) or SubCon Admin (One CSR Portal). A stopped subscription can be restarted only if the subscription meets a set of eligibility criteria.
To avail of the Restarts feature depicted below, the client should have
Subscribe 3.17.0 or above
Matrix 38.00.034.ITSP9 or above
A stopped subscription (that will be processed in the Matrix circulation system) can be restarted only if the subscription
is already Stopped
is stopped within a certain number of days (the number of days can be configured using the MG2 Control key Restart.MaxStoppedDays)
is not a Trial subscription
is not a Complimentary subscription
does not have any Payment events in the last 24 hours
does not have an already pending Restart event (with a DateEffective of today or future)
This information is returned by the CheckRestartAvailability endpoint of Subscribe.
The Mail Order Telephone Order (MOTO) transaction flow is enabled in both SA and SP which is specific to the Stripe payment vendor. This feature allows users to make payments without 3DS confirmation. Consequently, users can complete payments using both 3D and non-3D Stripe cards without encountering the 3DS pop-up window for authentication. As a result, even cards that typically require 3DS confirmation can now function without it.
When an eligible user opts for restarting a stopped subscription, Subscribe MicroAPI defaults the restarting date to the current date in the client’s time zone. However, the restarting happens only after the sync job and the restarting request is processed at the Matrix end.
It is possible for a user to opt for a future date for restarting a stopped subscription from 3.17.0. However, the user will not be permitted to select a restart date earlier than the current date in this flow.
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 in Subscribe. Even if the subscription status changes to 'Active' immediately, as per the Matrix settings, the subscription will ideally start for the user only on the selected date.
Please note that, even when the user is opting ‘Restart immediately’ option, the restarting will be in effect only after the sync process at Matrix end.
Note: MatrixAPI will receive a parameter named RestartDate as part of the "Suborderrestartid" request. This endpoint is called during the processing of the RESTARTSUBSCRIPTION (1149) event when restarting a subscription.
Starting from version 3.17.0, the Credit balance of a subscription is configurable for both SubCon Site (Self-Service) and SubCon Admin. This is achieved through the introduction of a new MG2 Control API setting key called 'Restart.ApplyCreditBalance', which has a default value of 0.
When this setting key is turned on (value 1) and the subscription has a credit balance (meaning the user owes money to the publisher), that balance will be displayed in the UI and will be deducted from the total restart subscription amount to be paid. However, if the setting is turned off (key value 0) and the subscription has a credit balance, then the balance will NOT be displayed in the UI, and the restart subscription amount remains the same without any deduction.
On the other hand, if the subscription has a negative balance (meaning the customer owes money to the publisher), the balance amount will always be added to the restart subscription amount irrespective of the value of the setting key. In this case, the total amount (negative balance + restart subscription amount) should be paid in the Restart payment transaction.
The Restart workflow in SS starts when the end-user clicks on the ‘Restart’ hyperlink on the Dashboard page.
The visibility of the ‘Restart’ hyperlink is determined solely by the CMS link restrictions.
When the user clicks the ‘Restart’ hyperlink,
If the value returned by the endpoint is ‘true’, it means that the subscription is eligible for a restart.
If the value returned by the endpoint is ‘false’, it means that one or more eligibility conditions are not met, and the subscription is not eligible for a restart. The user will be displayed an error message stating the reason (ex: “Subscription has been stopped for too long.”) for not opening the restart page. The user will be redirected to the Dashboard page.
When the Restart page is loading, the getOptions call is made to populate the Rate grid with all available Rate options. Each Rate option includes a ‘Term’ (the validity period for the subscription in weeks, days, or months) and an ‘Amount’ (the rate amount that needs to be paid for the corresponding term length).
If the getOptions call fails, the end-user will be redirected to the Subscription Panel where the currently existing offers will be displayed.
Note: The getOptions call might just fail due to a bad configuration in the Circ system. In some instances, there may be no available rates to be displayed on the page leading to the failure of the getOptions call.
If the getOptions call succeeds, the Rate Grid will be displayed on the Restart page.
When the getOptions call succeeds, the getAvailableDates API is called to fetch the available dates for the restart.
If all the API calls are successful, the Restart page will be completely loaded for the user.
Note: All of these error messages can be customized in CMS.
Step 1: Click the Restart hyperlink on the Dashboard page.
Step 2: Select the desired Rate option on the Restart page.
Note: The credit balance feature is configurable from 3.17.0 with the setting key Restart.ApplyCreditBalance. If a subscription account has a credit balance, it will be displayed in the field CREDIT, only if the MG2 control setting Restart.ApplyCreditBalance is turned on with the value '1'. On the other hand, if the account has a Debit balance, irrespective of the value of the setting key, the negative balance will be displayed on the UI and will be added to the restart subscription amount.
Step 3: By default, the option ‘RESTART IMMEDIATELY’ is selected. If the restart is immediate, the first AvailableDate returned by the getAvailableDates API will be used as the restart date.
Step 4: Select the payment method Credit card. Click the Next button. (Refer to the Rate Grid image above).
Step 5: On the next page, the Payment Information will be displayed. Enter the credit card details in the following Payment Details section.
Step 6: Click the SAVE button. A success message will be displayed.
The Restart workflow is completed.
From Subscribe version 3.17.0, new Payments API endpoints are used for the payment transactions while restarting a stopped subscription.
Clicking on ‘Restart’ button initiates a series of API calls as listed below:
To get the restart offer rates from the Matrix system, Subscribe calls the API GetBillingInformation/options{SubscriptionId}, and the Restart offer rate options will be displayed on the Rate grid. Term, Rate, Other costs (if any), Tax, etc. are the details available in the rate grid for each offer.
The api/paymentProvider/getSettings call gets the details of the Payment provider, in this case, it is Stripe.
The api/GetBillingInformation/{SubscriptionId call gets the details of the current payment balance and displays the total amount to be paid.
After selecting the offer rate from the rate grid, selecting a restart date (immediate or a future date), and entering the credit card details, clicking on ‘Save’ button initiates a series of calls as stated below:
In the API call api/common/Billing/PaymentSession/StartPaymentSession Subscription Id, Account number, Subscriber Id, PaymentMethod, etc. are sent to Stripe. This call returns the paymentIntentId. paymentIntentId refers to the unique identifier assigned to a Payment Intent object. A Payment Intent represents the payment attempt and its current status, including any errors or actions required to complete the payment. This can also be used to track the state of the payment.
api/common/Billing/PaymentSession/EndPaymentSession - Along with the Subscription Id, Account number, and Subscriber Id, the paymentIntentId is also sent to Stripe and as a response, all the authenticated card details of the customer along with the status of the transaction are returned.
The API call api/PaymentMethod is used to create a payment method that will return the "PaymentMethodId” as a response. This “PaymentMethodId” will be then used in the api/RestartPayment call that finally completes the payment transaction.
Step 1: Select a stopped subscription account from the Subscription search result grid and click Start call button. If the selected account has a negative balance, it will be displayed to the user.
Step 2: Click OK. The Account information tab details are available to the user. If the selected account is eligible for a restart, then the Restart button will be visible at the bottom right corner of the Account information tab.
Note: Regardless of whether the account has a negative or positive balance, if the conditions specified in the eligibility criteria for restarting a stopped subscription are not met, the Restart button will not be available for the user to initiate the Restart flow.
Step 3: Click the Restart button. The user is directed to the Payment/Billing tab. The current Payment information is displayed. The current offer rates from Matrix are populated in the Rate grid. Select any offer.
If the selected account has a Debit balance (negative), it will be added to the selected restart offer rate. If the account has a credit balance (positive balance), then the publisher owes the user money. Deduction of credit balance from the offer rate is configurable using the MG2 control key Restart.ApplyCreditBalance. If the setting key is configured for the Matrix client, then the positive balance of the user will be deducted from the offer amount.
Step 4: Click the Pay with credit card button. The credit card fields will be displayed. Fill in the details.
Step 5: Click the Save button. The payment with the credit card will be processed by the payment gateway and vendor. If the payment is a success, the final success message will be displayed. The financial transaction will be displayed in the below table as well.
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 Active Subscription Check is an internal validity check that can be performed in the backend to make new starts conflicts-free. This feature ensures that a new subscription can be created only if certain specific criteria are met. With this check, Subscribe will allow new subscriptions only if there are no conflicting subscriptions are found. The main advantage of this feature is that this check ensures users will not create duplicate subscriptions for the same product and address.
This feature has undergone refactoring in version 3.17.0.
This feature exists in Subscribe both in 2.X and 3.X versions, the flow is almost the same with little difference. Active subscription check was introduced in 3.X version starting from Release 3.10 via SubscriptionAPI. In Release 3.13 the check was refactored to increase productivity.
Starting from Release 3.14.2 onwards the Active subscription check was switched to consume PurchaseAPI, the check is performed during the async part of the flow as a part of the AddSubscription call. Please find more info about PurchaseAPI and its flows here.
This document describes the Active check flow for 3.X version starting from Release 3.14.2 onwards
For Active check via SubscribeAPI the minimum Subscribe version required is 3.13.0. The check covers only Print/Hybrid/Digital subscriptions.
For Active check via PurchaseAPI the minimum Subscribe version required is 3.14.2. The check covers all types of subscriptions including ZIP-only.
Please see the Active subscription flowchart and its description below:
Step 1. User enters first name, last name, and address information on Subscription Panel/One CSR Portal.
Step 2. The lookup is made in the Subscribe database for a subscription with all fields matching the entered information. Based on the offer setup in Solicitor Concierge the following info is checked:
for a ZIP-only offer:
Zipcode
Last name
Phone
Product (ProductType should be DIGITAL)
for NOT a ZIP-only offer:
Address (Billing or Delivery, Zipcode included)
if both delivery and billing address are required then the active sub-check is performed for the delivery address only.
If the offer setting only requires a billing address, then the active sub-check is performed for the billing address only.
Last name
Phone
Product
Outcome
If NO exact match is found then the check is PASSED and a new subscription is allowed to be created.
If an exact match is found and the start type is not 'restart', then that subscription will be evaluated based on the three Solicitor flags. If the 3 flags are turned off, the new start flow continues despite the exact match existing. If at least one of the flags is enabled and matches the found subscription, then the check is FAILED and a new start is rejected.
The information about Solicitor flags can be found below:
No existing subscription at address: If turned off this check is skipped, and the user can purchase a subscription though there’s an active subscription found.
No existing 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 the 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.
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.
At Step 1 the Deliverable check can be also performed to see if the Product can be delivered to the address - this is part of another flow.
The Active subscription check is performed via Purchase API and is applicable for Digital, Print, and Hybrid subscriptions.
The three main factors of Active Subscription check are SolCon flags, Address requirements, and Search Criteria (SolCon Additional flags).
The Active subscription check primarily depends on the three SolCon flags under Subscription Validation, which can be turned ON or OFF while creating an offer group (Offer Groups > Additional Options > Subscription Validation> as displayed below. If any of these flags are turned ON, the Active subscription check will take place.
No Existing Subscription: If this flag is turned off, this check is skipped, allowing the user to purchase a subscription even if another active subscription is found.
Subscription Stopped Recently: If this flag is turned on, it checks whether there exists a recently stopped subscription within the last “X” days, where X (default value is 30) is configurable in the Subscribe database using the MG2 Control Api key Restart.MaxStoppedDays. If the flag is turned off, this check is skipped and the user can purchase a new subscription even if there exists a recently stopped subscription.
No Outstanding Balance: If this flag is turned on, the Subscribe checks there exists a stopped subscription with an outstanding balance > 0. If the flag is turned off, this check is skipped and the user can purchase a subscription even if they owe a balance to the publisher.
The Address Requirements section defines whether a subscription should be Address-only or Zip-only.
If the subscription is address-only, then at least one of the address options (Billing Address, Delivery Address, or both) must be selected for the offer setup.
If the subscription is ZIP-only, the Billing Address and Delivery Address checkboxes can be kept unchecked.
If any of the SolCon flags are turned ON (one, or two in any combinations, or all three), a new Search Criteria is displayed where the additional flags for the Active subscription check can be set.
If any address options are selected in the Address Requirements section (the subscription is address-only), then the Address option under the Search Criteria will be enabled (auto-selected), and the Postal/Zip Code option will be disabled for the user.
For an address-only subscription, selecting additional flags (Email, Phone, and Last Name) is optional.
If no address options are selected under the Address Requirements section (the subscription is Zip-only), the Postal/Zip Code option under the Search Criteria will be enabled (auto-selected) and the Address option will be disabled for the user.
For a ZIP-only subscription, selecting at least one additional flag (Email, Phone, or Last Name) is mandatory.
Note: If any of the search criteria fields (Email, Phone, or Last Name) are selected for an offer, ensure that the respective component is included in your CMS Presentation. For example, if the search option "Phone" is selected in the SolCon offer, the Phone field must be present in your CMS Presentation.
A user attempts to purchase a subscription from a subscription offer displayed on the Subscription Panel or the SubCon Admin.
At least one of the SolCon flags (No existing subscription, Subscription stopped recently, No outstanding balance) must be turned ON in the SolCon offer presented in the Panel or SubCon.
Step 1. The user enters first name, last name, and address information on the Subscription Panel or SubCon Admin.
Step 2. A lookup is performed in the Subscribe database for a subscription with fields matching the entered information. The fields that are checked depend on the flag configuration set in the SolCon during the creation of the offer.
For a ZIP-only flow:
The system will check for matching Zip Code and the SolCon additional flag(s) whichever is configured in the SolCon offer (it could be just one flag, a combination of two flags, or all three flags).
Zip Code
Last Name
Phone
For an Address-only offer:
The system will check for matching addresses (Billing or Delivery) and the SolCon additional flag(s) if they are configured in the SolCon offer. SolCon additional flags are optional here. If it is configured in the offer, it could be just one flag, a combination of two flags, or all three flags).
If both Delivery and Billing addresses are selected in the offer setup, then the active sub-check is performed for the Delivery address only.
If the offer setting only requires a billing address, then the active sub-check is performed for the billing address only.
If any of the three SolCon flags is configured for a new start:
The Active Subscription check will be performed.
While checking, if NO exact match is found, then the check is PASSED and a new subscription is allowed to be created.
If an exact match is found, then the check is FAILED and new start is rejected.
If no SolCon flags is configured for a new start:
The Active Subscription check will not be performed.
The new start flow will continue even if an exact match of the new subscription details already exists.
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.
Following is the Beta version of the Gift Subscription workflow.
Gift Subscription is a unique Subscribe feature that is currently available exclusively to NCS clients. As the name implies, this feature allows an end user to buy a subscription and gift it to a dear one.
The end user who purchases the subscription will be referred to as the Purchaser in the Gift workflow. The one who receives the gift will be referred to as the Recipient in the flow.
The Gift subscription workflow can be divided into two: Purchase flow and Redeeming flow.
Purchase flow - the purchaser purchasing a gift offer from the Subscription Panel and its associated events.
Redeeming flow - the recipient redeeming the gift subscription and its associated events.
The purchaser navigates to the Subscription Panel. Selects a Gift offer.
Enter the details of the purchaser, and recipient in the CUSTOMER INFORMATION tab. Click Continue. Note: If the purchaser is a known user (Email ID already available in the Subscribe database), after entering the purchaser Email ID, a configurable info message will be displayed, ‘This email is already in use’. If the user is a new user (user details not available with Subscribe yet), after entering the Email ID, the user will be prompted to enter a password and then to confirm the password. Refer to the image below.
Select the Payment method (Credit card or Bank Account) in the PAYMENT INFORMATION tab. Enter the payment details accordingly. Click Submit.
4. The entered payment details will be displayed once more for confirmation. If everything is fine, click Continue. If any of the payment details to be edited, click the pen icon to edit the details before continuing with the payment.
Note: It is also possible to edit the already entered Customer Information details by selecting the ‘CUSTOMER INFORMATION’ tab.
5. The ORDER SUMMARY tab gives a summary of the current order. In this tab:
Any information (customer or payment) entered so far can be edited, if required.
If the gift subscription has to be started on a specific date in future, uncheck the box ‘Start the Gift Subscription Immediately’. Click on the Date field and select an available date from the date picker.
Accepting Terms and Conditions checkbox is selected by default. Do not uncheck this option. Unchecking will restrict the user from placing the order.
Click Place your order.
Once the order is placed successfully, the purchaser will be navigated to the Congratulatory page where all the details of the gift order is displayed.
The Purchase flow is complete now.
Note: Although the purchase flow concludes here, Subscribe offers the purchaser an option to manage this subscription. To do so, the purchaser must log in to the Self-Service portal by clicking the final button displayed on the congratulatory page. This button may appear as either 'Log In' or 'Continue' depending on the purchaser's status. If the purchaser is a known user to Subscribe, they will see a 'Log In' button on the congratulatory page. If the purchaser is a first-time user, they will see a 'Continue' button instead.
7. Once the purchase is complete (upon displaying the congratulatory page), an info mail will be triggered to the Purchaser.
8. An additional email will be sent to the recipient, notifying them about the gift subscription they have received. This recipient email will contain a unique link and a gift code to redeem the gift subscription. Note: Regardless of the selected start date for the subscription, both the purchaser and recipient emails will be triggered in real-time upon successful completion of the payment.
The Redeeming flow begins when the recipient clicks the hyperlink in the gift subscription redemption email. This link will direct the user to the Redemption Presentation. The email also includes a Gift code.
The recipient clicks the hyperlink in the email.
The recipient is directed to the Redeeming presentation, where the GIFT CODE tab is automatically opened and displayed. The unique hyperlink automatically populates the gift code. Click on Continue.
The USER INFORMATION tab is displayed. Enter the recipient details. Click Continue. Note: If the recipient is a known user (Email ID already available in the Subscribe database), after entering the Email ID, a configurable info message will be displayed, ‘This email is already in use’. Refer to the image below. If the user is a new user (user details not available with Subscribe yet), after entering the Email ID, the user will be prompted to enter a password and then to confirm the password.
The ORDER SUMMARY tab is displayed. Click Place your order.
The final Congratulatory page is displayed.
Note: Although the redeeming flow concludes here, Subscribe offers an additional feature for the recipient to manage the gifted subscription. To do so, the recipient needs to link the gifted subscription with their Account number and continue the flow by clicking the final button on the page. This button may appear as either 'Log In' or 'Continue' depending on the user's status. If the recipient is a known user to the client publication, they will see a 'Log In' button on the Congratulatory page. If the recipient is a first-time user, they will see a 'Continue' button instead.
Recipient (known user) clicking on Log In button:
Recipient (first-time user) clicking on Continue button:
For the first-time user, the account linking is not required. Upon clicking the Continue button, the recipient will be directly navigated to the Dashboard page of the Self-Service portal.
Upon reaching the congratulatory page, a congratulatory email will be sent to the recipient on redeeming the gift subscription. From V3.17.0, a notification email will also be sent to the Purchaser.
Subscribe supports Digital-only gifts. This avoids potential issues with purchasing a print gift subscription that could not be delivered to the giftee's actual address.
Subscribe transactional mails (the info mail sent to the purchaser, the notification to the recipient, etc.) will be sent to purchaser and/or recipient in real time after the successful completion of payment. However, if you want to notify the recipient on a specific date, then it is recommended to use Discover OR client-preferred EMS to schedule the recipient email.
The hyperlink that navigates the user to the Redeem presentation and the coupon code with which gift subscription can be redeemed will be incorporated in the transactional emails sent both to the purchaser and the recipient.
The validity period for redeeming a gift subscription can be defined by the MG2Control App setting CountOfDaysBeforeCouponSubscriptionStartDate. If required, this value can be overridden by the date entered in the Scheduled Start V3 component in the gift offer purchase presentation.
If the gift is not redeemed by the recipient during the predefined period, then it will start automatically and will be assigned to the purchaser. This allows for handling timely revenue recognition. If the recipient redeems the gift after the start of the subscription for the purchaser, then the ownership of the subscription will change from the Purchaser to the Recipient.
To achieve a successful Gift flow as depicted above, certain settings need to be configured in:
SolCon
CMS
SubCon Admin (transactional emails)
NCS Circ
Implementation Settings
Minimum Subscribe Version: 3.16.3
Minimum NCS Circ Version: 2020.2 plus SP1
In Solcon, a Gift offer must be created.
Open SolCon. Navigate to Offer Groups. Click the '+' button to create a new Offer Group.
Add Publications, and Product. The Product should be ‘digital only’. Set the desired price.
Make sure that the product selected in the offer is ‘digital only’.
In the Marketplaces section, select ‘Subscription Panel’ as the Sales Platform. Configure the SP url without fail.
Configure Terms & Conditions only if you want Terms & Conditions to be displayed on the offer. Hence it is optional.
Configure the Marketing Text if you want to appear it on the offer. It is optional.
In the Coding section, do the following setups: 1. Under Household levels, select the Publication and the Household level from the corresponding drop-downs. 2. Under Custom Codes, select value for the Source field. The Campaign code must not be set up for Gift offer. 3. Under Billing System Codes, select the Rate Code. Depending on the value of the Rate code, Term and Term Length fields will be auto-populated from the Circ system. Select Reason Code, Billing Method fields. Keep Delivery Method as ‘Online’.
In the Additional Options section, do the following setups: 1. Check and select the Sales Platforms options, as applicable. 2.Check and select the Payment method options, as applicable. Please note that the options that are selected here can only be displayed on the Purchase presentation. 3.Make sure that the Address Requirements options are unchecked and not selected. This enables users to purchase subscriptions without entering any address since they are intended to be gifted to other people.
Click Publish to save the new offer group that is created.
In CMS application, two Presentations must be configured.
Purchase presentation which will be displayed to the Purchaser in the Subscription Panel during Purchase Flow
Redeeming presentation which will be presented to the Recipient while claiming the gift subscription during Redeeming Flow
You may configure Presentations from scratch in the CMS. However, it is highly recommended to reuse any existing Presentation by exporting and importing them. This approach ensures ease of use and convenience. Reusing an existing Presentation eliminates the risk of errors and proves to be a significant time-saver, sparing you from the need to identify and resolve issues.
It's crucial to note that the appearance and functionality of the Purchase and Redeeming presentations on the Subscription Panel depend entirely on the way you customize and configure them in the CMS.
Be it Purchase Presentation or Redeeming Presentation, the initial steps of configuring them are pretty the same.
Step 1: Navigate to CMS > Subscription Panel > Presentations.
Step 2: You may create a new Presentation, Export and import an existing Presentation, or Copy an existing Presentation and create a new one.
To Create a new Presentation: Click +Add New Presentation > Blank Presentation
To Copy an existing Presentation and then create a new one: Select a Presentation from the drop-down. Click +Add New Presentation > Duplicate Selection > Give a name and unique URL for the selected Presentation > OK
To Export an existing Presentation: Click Options > Export > Check the box to select a Presentation from the list > Export Content. To Import an exported Presentation: Click Options >Import > Select file > Import.
Step 3: Make sure that the Presentation has the main parent component Presentation P followed by a Header V3 component.
In the parent Presentation P, the property ‘isGiftSale’ should be set to ‘ON’.
The rest of the configuration varies between Purchase and Redeeming Presentations.
Followed by the Presentation P and the Header V3 components, configure a Page V3 component (Landing page)
Configure a child component Landing - Tiles. Under this component configure the next level child component Promotion Digital V3.
Configure the next Page V3 component with the following child components one after the other in the order mentioned in the following table.
Offer Selector
Step Indicator
Sticky Note V3
Step V3 (to capture User information)
Gift Recipient V3 (Captures recipient Email, First name, Lastname, gift message to the recipient, etc.)
User Information V3 (Captures the purchaser's email, displays a message if the email already exists, collects password along with its confirmation if the user is new).
Independent Address V3 (Captures purchaser first name, last name, phone number, zip code, etc.)
Step V3 (capture Payment step details.)
Payment Methods V3 (Ensure to configure the appropriate child component for each payment method you need.)
NavigaPay Payway V3
Bank Account V3
Step V3
Order Summary V3
Scheduled Start V3
Note: If this component is not configured, purchasers won't have the option to select a start date for the subscription. In such cases, the gift subscription will automatically begin with the current date.
Terms and Conditions V3 Note: The Terms and Conditions V3 component picks T&C set up in the SolCon Gift offer.
Configure the next Page V3 component.
a. Configure a Confirmation child component. Configure as many Social Media V3 child components one after the other for each social media handles such as Facebook, Instagram, Twitter (now 'X'), Google PlayStore, LinkedIn, etc. you require.
Configure finally a Footer V3 component.
Click Save to save the Presentation.
Clear app’s cache by clicking the Manage Cache button, then click Refresh CMS+Panel.
Followed by the Presentation P and the Header V3 components, configure a Page V3 component. a. Configure a child Step V3 component. Under this component configure a Input Gift Code V3 child component.
Configure the next Page V3 component with the following child components one after the other. a. Configure the Step Indicator component. b.Configure the Offer Selector component. c. Configure the Gift Details V3 component. d. Configure a Step V3 component. i. Configure the User Information V3 child component. ii. Configure the Independent Address V3 child component.
e. Configure the next Step V3 component. i. Configure the Order Summary V3 child component.
Note: If you wish to display the Terms & Conditions (set up in the SolCon gift offer) to the recipient, you can add the Terms and Conditions V3 child component either under this Step V3 component or the one above.
Currently, it's not feasible to present distinct Terms & Conditions for the purchaser and the recipient within the gift subscription flow. While it's possible to display Terms & Conditions in both the purchase and recipient flows by configuring Terms and Conditions V3 component, in both scenarios, the Terms & Conditions are sourced from the same T&C configured in the SolCon gift offer. Consequently, displaying separate Terms & Conditions to the purchaser and recipient within the gift subscription flow is not supported.
3. Configure the next Page V3 component.
a. Configure the Confirmation child component.
Under the Confirmation child comp, configure as many Social Media V3 child components one after the other for each social media handles such as Facebook, Instagram, Twitter (now 'X'), Google PlayStore, LinkedIn, etc.
Configure the final Footer V3 component.
Click Save to save the Presentation.
Clear app’s cache by clicking the Manage Cache button, then click Refresh CMS+Panel.
The transactional emails sent to purchaser and recipient during the Gift flow must be configured in the SubCon Admin. These transactional mails can be called as Event Type Emails because they get triggered and are sent to addressees at the completion of Purchase event and Redeeming event.
The emails configured in SA will be sent to the addressees in real-time. If you need to trigger the email to a recipient on a future date, then it is recommended to use Discover OR client-preferred EMS to schedule the recipient email.
In the Gift flow, the following transactional emails are typically involved:
Mails sent after Purchasing the gift subscription:
Purchaser mail: Contains recipient details, gift code, gift message, order details, etc.
Recipient mail: Notifies the recipient about the gift, provides purchaser details, includes a hyperlink to the Redeeming presentation, gift code, etc. Note: These emails should be configured to be triggered after a successful PURCHASE event (Event type 1100).
Mails sent after Redeeming the gift subscription:
Congratulatory mail: Sent to the recipient for redeeming the gift subscription.
Notification mail: Sent to the Purchaser after the recipient redeems the subscription. (This mail is available only from Subscribe V 3.17.0). Note: These emails should be configured to be triggered after a successful REDEEMING event (Event type 1101).
In both events (Purchase & Redeeming) two emails are to be triggered - one to the Purchaser and the other to the Recipient.
In SA, you can configure two categories of Event type emails: Internal and Customer. The only restriction is that, at a time, only one email can be triggered from one category for a particular event. Since Purchase event requires two emails to be triggered, for ease and convenience, it is recommended to configure recipient email in Internal category and purchaser email in customer category.
Navigate to SubCon Admin > Event Management > Event Types Emails > Add New.
The Add New Transaction Mail tabs will open. Please refer to the image below. Note: For first-time users, the ‘Internal Emails’ tab is auto-selected and without saving this tab, the other tabs will not be accessible.
Select the Publication Group. Choose the Event Type as ‘(1100) PURCHASEGIFT’. Complete the mandatory fields. You can draft the recipient mail using the Template Mail Editor. Click the Edit button to enter the mail content in the Editor. Click the Save button to save the recipient notification email template.
Ensure that the redeem flow link is included in the Recipient email template. You can incorporate the Redeem presentation URL as a hyperlink by copying and pasting it into the email message wherever its needed.
In the provided sample email template above, the link has been added to the "this link to redeem your gift" text in the email body.
Click Save Transaction to save the transaction and unlock the other tabs.
Once any email template is successfully saved, it will be listed in the Search result grid. For example, the recipient mail created above will be listed as shown below. To edit an already saved email template, click the Edit button displayed with the listed email template in the search result grid.
The Purchaser email has to be configured under Customer Emails section.
Navigate to Customer Emails Tab. Click +Add New Template.
You can either create an email template from the scratch or copy from an existing template in the Customer Emails tab.
Enter the new Template name. Click Continue.
Enter the new Template name.
Check the box 'Copy From Another Template”.
Newly created Acknowledgement Email Template
Enter values in the Mandatory fields. Click Save. Note: Uncheck Validate Email before saving the template.
3. After creating the Acknowledgment Email template, click Save Transaction to save the Email configurations.
After setting up purchaser and recipient emails to be triggered on the PURCHASEGIFT event, you should also configure separate purchaser and recipient emails to be triggered on the REDEEMGIFT event.
Navigate to Event Management > Event Type Emails.
Select Event ID in the Filter By drop-down. Enter 1101 in the Contains field. Choose the Publication Group from the corresponding drop-down. Click +Add New.
Set up the Congratulatory Recipient Email in the Internal Emails tab on redeeming the gift subscription.
Set up the Purchaser notification mail that should be triggered when the recipient redeems the gift subscription.
The Purchaser notification mail on redeeming gift is available only from V3.17.0.
Note: While setting up the emails, make sure to select the Event Type as (1101) REDEEMGIFT. This will link the emails with the REDEEMGIFT event.
This feature is highly beneficial for SubCon Admins/CSRs as it allows them to verify the reception of configured emails. How to verify the emails sent and received? You can verify the emails sent and received after configuring internal and/or customer emails for a specific event.
All emails (internal and customer) configured for a specific event will be listed under the View All Emails tab. You can navigate to the View All Emails tab in two ways:
From the homepage: a. Navigate to Event Management > Event Types Emails. b. Filter By > Event Type ID, Contains > Enter event ID, Choose Publication Group > Search. c. Select the email from the search result grid. Navigate to the View All Emails tab. OR
View All Emails tab
All emails configured for the selected event type will be listed here. Click Send Sample button along any mail.
This process ensures the sending and reception of the configured emails.
The Send Sample feature is currently unavailable for emails configured for the Redeeming event (1101). This will be accessible from V3.17.2.
Email attributes in Subscribe are dynamic placeholders that allow you to personalize and customize your email content. These attributes act as tokens or markers within the email templates. When the created mail is sent, these placeholders are replaced with real values retrieved from the database. This dynamic substitution ensures that each email sent through the application is tailored to the recipient and contains up-to-date information.
Email attributes are commonly used to insert recipient-specific data, such as names, addresses, account details, etc. into email templates.
You can easily include these attributes within the email content by enclosing the attribute within double curly brackets while setting up the email on Editor.
For example, if you include the attribute {{CouponDetails.GiftteeName}} in an email template, when the email is sent, this placeholder will be replaced with the actual name of the gift recipient.
Subscribe supports a range of predefined email attributes, and users can also create custom attributes to suit their specific needs. These attributes provide a powerful way to deliver personalized and engaging email communications to recipients. Below is a list of email attributes that you can use while configuring your email content.
Coupons.RedeemCode
Gift redemption code with which recipient can redeem the gift
CouponDetails.GifttorName
Gift purchaser first name
CouponDetails.GifttorLastName
Gift purchaser last name
CouponDetails.GiftteeName
Gift recipient first name
CouponDetails.GiftteeLastName
Gift recipient last name
CouponDetails.GiftteeEmail
Gift recipient email ID
CouponDetails.GiftteeMessage
Gift message sent to the recipient
AccountNumber
Account Number of the Subscription
CMSAttributes.CSEmail
Email of the Publisher
Have NCS Circ 2020.2 plus SP1 or above.
Set up a new Demographic, 'GiftCode,' with the Demographic Type set to "Subscription" and the Answer Type set to "Character." This will be used to store the Redemption Code. In addition, a Demographic Valid should be defined for each publication that will offer gift subscriptions. Refer to the Circulation Setup Manual for setting up a Demographic and a Demographic Valid. Note: Do not set up any records for the Demographic Value since the Answer for the Demographic, GiftCode, will be a unique value used to store the Redemption Code, and this value will be generated by Subscribe in real-time at the time of the Gift Subscription Purchase.
Configuration Setup (CircAPI Business Rules) Make sure that valid values have been defined in the Business Rules listed below. Section: CM Application → Setup → Rules → Business Rules → Sections → CircAPI
What is the default reason code for Delivery Address Change from Circ API? Enter the default reason code that should be used when creating Delivery Address Change through the CircAPI.
What is the default reason code for Billing Address Change from Circ API? Enter the default reason code that should be used when creating Permanent Stop through the CircAPI.
What is the default source code for transactions Created from Circ API? Enter the default source code that should be used for transactions created through the CircAPI.
Define a new Source Code and Reason Code, Gift, for Move-In and Move-Out transaction types. To set up a Reason Code and a Source Code, refer to the Circulation Setup Manual.
CM Application → Setup → Subscription → Address → Digital Properties In Digital Address Properties, make sure that value for all the properties have been set as Optional.
MG2 Control (Support Viewer Settings)
The below-listed MG2 Control API settings should be in place.
The MG2 Control flow setting, "Flow.CreateSubscriber," should be set to "Realtime."
The MG2 Control flow setting, "Flow.Gifting," should be set to "Realtime."
The MG2 Control internal setting, "CountOfDaysBeforeCouponSubscriptionStartDate," should have a valid number.
Subsvc Settings
Set the configuration for the event type, REDEEMEXTERNALGIFT, to have active = 1 (true) and triggers_post = 1 (true). It also should be associated with NCS in NewspaperEventProcessorAssignments.
Set the configuration for the event type, UPDATEBILLTOOCCUPANT, to have active = 1 (true) and triggers_post = 1 (true). It also should be associated with NCS in NewspaperEventProcessorAssignments.
This document contains information about 'Day Pass' subscriptions, including the setup 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.
This page was last updated on 30 July 2024.
Day Pass subscriptions are low-cost, low-commitment digital subscriptions that grant users 1-Day premium access to Publications. If a user purchases a 'Day Pass' subscription today, they can access the premium content until midnight the next day. Currently, only the NCS circulation system supports Day Pass subscriptions.
The goal of this section is to explain how to configure a 'Day Pass' Subscription offer in the SolCon application.
Subscribe supports only digital-only day pass.
The validity of a Day Pass subscription is just 1 day. The subscription will expire by midnight of the following day of subscription purchase. This means, if the subscription was purchased on August 1st (regardless of the exact time), it will expire at 00:00 AM on August 3rd.
Day passes cannot be auto-renewed.
Day passes must be purchased in advance. Grace periods are not supported.
Day passes can have discounts, but the Rate type in NCS Circ should be set as 'Normal'. It should not be 'Reduced' or 'Promo rates'.
Business Rules must be configured in NCS to indicate whether the Single-Day Passes should be counted as one day or two in AAM reporting.
Single Day Pass subscriptions are counted as single-copy digital sales for AAM purposes by default. However, Day pass subscriptions have a 24-hour window and readers can typically access the website on two different days. Hence AAM also allows a Single Day Pass to be counted as two copies.
Day pass start is always a Campaign-code start, hence
'Day Pass' Campaign code should be configured in NCS Circ.
Campaign-code start feature should be turned ON. For more info:
To implement this feature, the following pre-requisites must be met:
Minimum Subscribe version: 3.17.0
Minimum NCS circ version: 2014.5
Minimum Extracts Version: 5
Campaign code must be configured in NCS Circ
Setup the service_type and product named 'DAYPASS' in Subscribe. Please raise an SF case to get this done.
From 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.
Select the Additional options section. Expand the Payment method option from the right-side menu.
Select at least one of the physical payment methods like Credit card or Bank draft, along with Paid pass option.
Select the Coding section. Expand the Custom codes option from the right-side menu.
Enter 'Day Pass' in the Campaign Code field.
Select Update or Save as new.
No specific setup is required. If your offer is set up as a ZIP-only offer, please remember to use ZIP-only presentation.
Congratulations! You've added a 'Day Pass' Subscription offer in the SolCon and CMS dashboards.
Points to Note:
The Subscription kind of active Day Pass subscriptions will be set as ‘PaidPass’.
Whenever the Day Pass subscription is created in Subscribe, the End Date will be saved as 'Start Date + 1'.
The nightly sync process updates the HHL (HH sub level) & Access level as and when the End Date is reached.
Whenever the Subscriber status becomes ‘Stopped’ for a Day Pass subscription, access to the publication content will be denied to the user.
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.
A new Occupant is created in NCS circ during the new start from Subscription Panel or One CSR Portal in case the Occupant did not exist before. In PurchaseAPI the Occupant is created as a part of async flow, the 1103 CREATESUBSCRIBER event is fired. For more information about PurchaseAPI please check the .
Starting from 3.16.0 we use realtime lookup in NCS circ. There are two types of lookup: standard and email only (default). Please see the details below:
Email Only: If this mode is set up, send Email and Exact Match=true to NCS. We should always expect NCS to return one Occupant.
Standard: If this mode is set up, send Email and Exact Match=false to NCS. We might get multiple records. The result set is filtered by First Name, Last Name and Email (all of them should match) and the first occurrence is picked.
to switch between the lookup types please use Purchase.GetSubscriber.LookUpStategy setting in mg2control
Please see below for more details about Occupant creation
In case an Occupant already exists in NCS circ but the new phone number is entered during the new start we save this new phone as 'Primary' or Other', please check and , respectively
GIVEN A new start was posted through Subscription Panel with all the required information (product data, payment data, email, address, FirstName, LastName, Phone) being valid
WHEN the Occupant does not exist in NCS Circ based on lookup performed against Email+FirstName+LastName+AddressID) or email only, based on lookup mode
THEN the new start is created in Subscribe
AND a new Occupant is created in NCS Circ with the collected phone saved as ‘Primary’ phone
GIVEN A new start was posted through Subscription Panel with all the required information (product data, payment data, email, address, FirstName, LastName, Phone) being valid
WHEN the Occupant exists in NCS Circ based on lookup performed against Email+FirstName+LastName+AddressID)
AND the Occupant in NCS Circ does NOT have any phone assigned
THEN the new start is created in Subscribe
AND the collected phone saved as ‘Primary’ phone for the existing Occupant in NCS Circ
GIVEN A new start was posted through Subscription Panel with all the required information (product data, payment data, email, address, FirstName, LastName, Phone) being valid
WHEN the Occupant exists in NCS Circ based on lookup performed against Email+FirstName+LastName+AddressID)
AND the Occupant in NCS Circ has a phone assigned
THEN the new start is created in Subscribe
AND the collected phone saved as ‘Other’ phone for the existing Occupant in NCS Circ
The goal of this tutorial is to show you how to configure some of the Subscription Purchases in the Solicitor Concierge and Content Management System (CMS) dashboards. This guide explores the four following types:
Navigate to your desired Subscription Purchase type to learn more. You can also view the workflows for a visual representation for or .
Please note that the andwere moved to separate page
Make sure you meet the pre-requisites before starting the tutorial steps and reach out to a Naviga Implementation Manager to ensure Solicitor Concierge and CMS components are configured and structured properly.
For general offer group setup please see the proper
A Digital ZIP-only Subscription Purchase requires a subscriber to enter only a postal code (and not a complete address) while making a purchase.
The goal of this section is to explain how to configure a Digital ZIP-only Subscription Purchase in Naviga's Solicitor Concierge and CMS dashboards.
For this feature to be implemented the following pre-requisites must be met:
For NCS: the minimum Subscribe version is 3.13 and minimum circ version is 2018.5
For CircPro: the minimum Subscribe version is 3.15 and minimum circ version is 2021-3
Matrix currently does not support this flow. However, it can be developed.
From 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.
Select the additional options category, then select the address requirements drop-down menu.
Uncheck the run product delivery check, billing address, and delivery address boxes.
Select update or save as new.
From the CMS dashboard:
Select subscription panel then presentations. Be sure to apply these changes to the newspaper level.
Choose your desired presentation from the drop-down menu.
Add the Independent Address V3 as a child component to the Step V3 component. To collect other information we recommend using the User Information V3 component
Select save and clear your app's cache by selecting the manage cache button, then the relevant app.
For a successful start in circ system the following information is required: First Name, Last Name, Email and Zipcode
Please note that Independent Address V3 component supports taxing only from Subscribe 3.14.3
Please note that the tax amount (and hence the total price) is dependent on the zip code. For the best user experience, we recommend collecting zip code before the Payment Step. Otherwise, the tax amount and the total price shall be recalculated.
Congratulations! You've added a Digital ZIP-only Subscription Purchase in the Solicitor Concierge and CMS dashboards.
A start-and-bill Subscription Purchase allows the subscriber to begin a subscription and pay for it later via invoice. The subscriber is not required to provide payment information.
The goal of this section is to explain how to configure a start-and-bill Subscription Purchase in Naviga's Solicitor Concierge and CMS dashboards.
For this feature to be implemented the following pre-requisites must be met:
For NCS Circ: the minimum Subscribe version is 3.13 and the minimum NCS circ version is 2018.5
For Matrix: the minimum Subscribe version is 3.15.1 and the minimum Matrix version is 38.00.034 P5
From 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.
Select the additional options category, then select the payment method drop-down menu.
Check the billed box.
Select update or save as new.
From the CMS dashboard:
Select subscription panel then presentations. Be sure to apply these changes to the newspaper level.
Choose your desired presentation from the drop-down menu.
Add the Bill Me V3 as a child component to the Payment Method V3 component.
Select save and clear your app's cache by selecting the manage cache button, then the relevant app.
Please note that you can have other payment methods as children of the Payment Method V3 component - only those payment methods checked in Solicitor Concierge will be displayed
Congratulations! You've added a start-and-bill Subscription Purchase in the Solicitor Concierge and CMS dashboards.
A campaign-code Subscription Purchase minimizes the amount of data you need to enter. Instead of entering circulation-specific data (rate code, term, length, etc.), a single campaign code is sufficient.
The goal of this section is to explain how to configure a campaign-code Subscription Purchase in Naviga's Solicitor Concierge and CMS dashboard.
For this feature to be implemented the following pre-requisites must be met:
Minimum Subscribe version is 3.14.0 and minimum NCS circ version is 2014.5
From 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.
Select the coding category, then select the custom codes drop-down menu.
Select the NCS campaign code value from the Campaign Code 1 field. After you have selected the campaign code then the rate code, reason code, term length and billing method will be automatically prepopulated with valid values that were setup in NCS circ.
Select update or save as new.
Configure a campaign-code Subscription Purchase just as you would do for a regular Subscription Purchase, no additional setup is needed
Congratulations! You've added a campaign-code Subscription Purchase in the Solicitor Concierge and CMS dashboards.
The goal of this section is to explain how to configure a frictionless checkout for Subscription Purchase in Naviga's Solicitor Concierge and CMS dashboard.
This checkout has several main advantages:
Make it easier for users to start a subscription online. Reduce the time it takes to start a subscription as well as the number of error states
PayWay hosted page can be customized (Set labels and placeholders' text, show\hide fields, added fields for zip code and phone number, display T&C of selected offer)
Consume billing information from the external sources (PayWay form, GooglePay, ApplePay) and pass it into POST /Subscriptions even if the billing address component doesn’t exist in presentation
The minimum Subscribe version required is 3.14
Client should be using Payway payment provider
For ZIP-only starts minimum NCS circ version is 2018.5 and the minimum CircPro version is 2021-3
To configure a frictionless checkout low you need to set Seamless as the Presentation Theme:
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 Seamless
Select Save.
Starting from 3.15.3 the following changes were made:
OfferTopContainer.Styling.BackgroundColorproperty was replaced by OfferTopContainer.Styling.BackgroundColor.Left and OfferTopContainer.Styling.BackgroundColor.Right for the Sticky Note to be able to support gradient. If set only one colour then the header will have solid colour
subscription price, tax amount and total price can be shown at the Checkout step at the same time - please use the toggles in Sticky Note component: Pricing Amount Show, Pricing TaxAmount Show, Pricing TotalPrice Show
No action is required from the business user to support the new version of the Payway iFrame - all the fields in the CreditCardEdgil component should be automatically populated via a script being a part of the CMS database setup.
Also, below you can find examples of the structure templates to configure the presentations that match the designs
Presentation Properties V3
Header V3
Page V3
Offer Selector - Tiles V3
Page V3
Sticky Note V3
Step V3
User Information V3
Information V3 (to specify T&C)
Page V3
Sticky Note V3
Step V3
Payment Methods V3
Credit Card Edgil V3 (turn on zipcode)
Page V3
Confirmation V3
Footer V3
Presentation Properties V3
Header V3
Page V3
Offer Selector - Tiles V3
Page V3
Sticky Note V3
Step V3
User Information V3
Information V3 (to specify T&C)
Step V3
Delivery Information V3
Billing Information V3
Page V3
Sticky Note V3
Step V3
Payment Methods V3
Credit Card Edgil V3 (turn on zipcode)
Page V3
Confirmation V3
Footer V3
The following points are optional to match the design at the screens:
isOnlinePaymentSystemsButtonsBelow property of the PaymentMethods component should be set to ON - this flag excludes additional payments like Google Pay, Apple Pay, PayPal from the list of available options and places them below Submit/Purchase button divided by the delimeter text. Otherwise, the additional payment methods would have been shown in the dropdown under the title of the Step. Please see the Payment Step - regular start screenshot above as an example
enumer show toggle of the Step component - displays/hides the Step number
offerTopContainer.enableCustomization toggle of the StickyNote component should be enabled - this allows you to manage the sticky note background component using theofferTopContainer.Styling.BackgroundColorproperties
IsMoveLabel toggle of the PresentationProperties component should be set to ON - the title will slide above the input field when the user hovers over the field
Button.HideWhileDisabled toggle of the Step component with Payway iFrame should be set to ON - this flag supports one click instead of two clicks, e.g.
After the payment step - the user will only click on one submit button and see the confirmation page
After login (3rd party) - the user will only click 'submit' once.
NOTE: There should only be one component in such step to leverage these features
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.
Lite subscriptions are a particular kind of subscription that exist solely within Subscribe and do not have any payments associated to them.
Note: Lite subscriptions do not flow to any circulation system (NCS Circ, CircPro, Matrix etc.)
This guide provides information for the successful Lite presentation and Offer setup.
Make sure you meet the following pre-requisites before starting the tutorial steps:
Minimum Subscribe version required is 3.16.2 and above
Login to CMS application.
For a detailed guide on how to create presentations, please check the
A special component is needed to create this type of presentation. Lite form V3. This has to be added the following way: Page V3 > Step V3 > Lite Form V3.
Click the Preview button to view the glimpse of the final output of the presentation.
This is what the Lite form V3 component will look like in a presentation:
In an Offer group please go to the Additional Options section and Subscription Kind as Lite.
Please note that for the Lite subscription NO Payment Method must be selected as no payment is taken. The entire section becomes disabled when the Lite checkbox is selected.
After entering/updating all the required details, click Publish.
Congratulations! You successfully configured a presentation for a lite subscription!
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 feature is in its Beta version now.
Country-Only-Start is a new start flow designed exclusively for digital subscriptions, currently available for NCS Circ clients and supported by the payment vendors Cybersource and Payway.
The key feature of this flow is that it allows an end user to purchase a digital subscription with minimal input—only the first name, last name, email ID, and country name are required (all mandatory fields). This makes the Country-Only-Start flow quicker and more user-friendly than the standard new start flow, offering end users a simplified and efficient experience.
Note: If the Zip code field is added to the user input fields, the Country-only flow is transformed to a Zip-Only new start. With the Zip code field, the flow will no longer be a country-only start.
You can customize the look and feel of the Country-Only-Start flow in the CMS Presentation. Below is an example of a Country-Only-Start flow configured with the Default theme in the CMS Presentation.
Landing Page
USER INFORMATION Tab Enter the Email ID. If the user is already registered (Email ID is in the database), an info message will appear: "This email is already in use". The end user can still continue with the flow. For new users, a password must be entered along with the email, and the password must be re-entered for confirmation. (The user becomes registered, and the user details are stored in the Subscribe database.) Click Continue.
ADDRESS INFORMATION Tab Enter First Name, Last name, and select the Country name from the drop-down. Click Continue.
PAYMENT INFORMATION Tab Select the desired payment method and enter the required details. Click Submit.
ORDER SUMMARY Tab Review the order summary and place the order.
Final Congratulatory Page After the order is successfully placed, the final congratulatory page is displayed.
While creating the SolCon offer, if the Billing Address checkbox is checked, ensure that the Name fields and the Country field are added to the CMS Presentation via the Billing Information V3 component. If the Billing Address checkbox is unchecked in the SolCon offer, configure the Name fields and Country field using the Independent Address V3 component in your CMS presentation. (Offer Groups > Additional Options > Address Requirements > Billing Address)
To enable the Country-Only-Start flow,
The isInternationalfield must be toggled ON in the CMS presentation.
(CMS > Subscription Panel > Presentations > Select a Presentation > Presentation Properties V3 > isInternationalfield)
The Email field should be added to the Presentation from the User Information component.
The First name, Last name, and Country fields should be toggled ON in the Address component of the CMS presentation. These fields can be added via the Independent Address V3 component or the Billing Information V3 component
(CMS > Subscription Panel > Presentations > Select a Presentation > Page V3 > Step V3> Independent Address V3 or Billing Information V3 > Country)
Note:
The Country-Only flow is available for NCS Circ clients through Payway and Cybersource payment vendors.
On the circulation side, ensure the Digital Address property for "Country" is set to Required. The other properties are optional.
This guide walks you through the Restart feature that allows the user/CSR to restart a permanently stopped subscription or account in real-time in NCS Circ. Depending on the settings and stopped subscription details the end-user/CSR will either be able to restart the subscription in real-time via Self-Service/One CSR Portal respectively or they will be redirected to the Subscription Panel to purchase a new subscription.
Prior to 3.16.0 Release
Have Subscribe 3.14 or above
Have NCS Circ 2018.5+SP1+SP2+SP3 (equal to 2020.2.0) or above, For correct work we recommend to upgrade to rapid release 2020.2.2 or 2020.3 version
Have circulation microAPI working and provide the URLs for get/ratecodedetails and get/ratesInfo.
Starting from 3.16.0 Release the minimum required version of NCS Circ is 2020.4
The subscription should be eligible for restart. The following criteria should be met:
The Subscription has been stopped for less than X days (set up for the client in MG2 control)
The Subscription is not
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
The final submit of the page will POST a payment of (+ Donation/Tip optional):
If the balance<0, then the payment is SelectedRate.Amount (from GetRates or GetSubscriptionInfo) + Subscription.BalanceDue (from SubOcc)
If the balance>0, then the payment is only SelectedRate.Amount (from GetRates orGetSubscriptionInfo)
For real-time restarts the latest extracts are required
For getting previous outstanding balance: SubscribeAPI calls subOcc circAPI program to get previous outstanding balance.
For getting restart rates: SubscribeAPI calls ratesInfo of circAPI program to get RatecodeId. It then calls get/ratecodedetail microAPI to get details like term amount etc.
Project Manager must create a ticket for the implementation team to turn on the Restart feature and provide the following details in the ticket:
provide the URLs for get/ratecodedetails and get/ratesInfo. Please ensure the microAPI is working before creating an implementation ticket.
the maximum number of days a stopped subscription must be considered to restart.
whether donation/tip is used for restarts for both One CSR portal and Self Service
For getting previous outstanding balance: SubscribeAPI calls subOcc circAPI program to get previous outstanding balance.
For getting restart rates: SubscribeAPI calls GET/Subscriptions/subscriptionid/SubscriptionInfo microAPI to get details.
Project Manager must create a ticket for the implementation team to turn on the Restart feature and provide the following details in the ticket:
provide the URLs for GET/Subscriptions/subscriptionid/SubscriptionInfo.Please ensure the microAPI is working before creating an implementation ticket.
the maximum number of days a stopped subscription must be considered to restart.
whether donation/tip is used for restarts for both One CSR portal and Self Service
Below you can see how the flow will look like for Account Management and one CSR portal.
The rates should be set in NCS circulation system and they are returned from it in real-time.
At this example you can see a subscription with negative subscription balance of 20.20$ and the rates returned from NCS circ for 13 weeks.
As the rates are returned then the user is able to select the date when the subscription is restarted. If no date in the future is selected then the subscription will be restarted immediately.
The final submit of the page will POST a payment of SelectedRate.Amount (from GetRates) + Subscription.BalanceDue (from SubOcc).
At this example you can see a subscription with negative subscription balance of 8.75$ and NO rates returned from NCS.
As in case no rates are returned from the circ system then date picker is not displayed - the subscription will be restarted immediately.
The final submit of the page will POST a payment ofSubscription.BalanceDue (from SubOcc).
At this example you can see a subscription with negative subscription balance of 1.25$ and the rates returned from NCS circ for 1 month.
As the rates are returned then the CSR is able to select the date when the subscription is restarted. If no date in the future is selected then the subscription will be restarted immediately.
The final submit of the page will POST a payment of SelectedRate.Amount (from GetRates) + Subscription.BalanceDue (from SubOcc).
Subscribe calls the CheckRestartAvailability endpoint. The endpoint verifies whether the subscription is eligible for a restart by checking each of the .
Restarting a subscription through the One CSR portal is possible only if the ‘Restart’ button is visible on the Account Information tab of a stopped subscription account. The Restart button will be visible only if the API api/CheckRestartAvailability/subscriptionId returns true after verifying the .
Enter values in the mandatory fields, draft the mail content on the template editor. Click Save. Refer to the example below.
Choose the Publication Group, Select the Event Type as ‘(1100) PURCHASE GIFT’, choose the template from which you want the copy to be made, Preview of the selected Template will be displayed. Click Continue.
After configuring any internal or customer email(s), before closing the transaction, simply select the View All Emails tab.
Click the Send Sample button. Enter the trial Email ID and select the most recent event from the list of events. The events are populated in the drop-down in descending order based on the time of occurrence, with the latest event listed at the top.
Click Send. The email will be sent to the selected email ID.
See also:
For ZIP-only starts please see . For regular starts, no additional setup is needed
For more information about the component properties, please check the .
For general offer group setup please see the proper .
Donation option will be displayed only if the Client using them. Adding tip is only available from print subscriptions (please see more about adding to in ourdocumentation).
For more details please see the
Purchaser (known user) clicking on the Log In button:
Upon clicking the Log In button, an Auth0 login modal will appear, prompting the user to enter their credentials. The purchaser should input their email ID and the password used during the purchase flow. After entering the credentials, click the Login button on the Auth0 modal. Subsequently, the Log In button on the Congratulatory page will transform into a Continue button. Click on Continue. The purchaser will then be redirected to the Dashboard page of the Self-Service portal, where they can manage the purchased subscription.
Purchaser (first-time user) clicking on Continue button:
Upon clicking the Continue button, an Auth0 login modal will appear, prompting the user to enter their credentials. The purchaser should input their email ID and the password used during the purchase flow. After entering the credentials, click the Login button on the Auth0 modal.
The purchaser will then be redirected to the Dashboard page of the Self-Service portal, where they can manage the purchased subscription.
62
ADDRSTD
Address Standardization
🗸
🗸
35
AUTHCC
Card Authorization. Processed before STARTSTD creation.
🗸
🗸
3
STARTSTD
Parent Newstart Event
🗸
🗸
140
FINDADDRESSOCCUPANT
Real-time occupant lookup in NCS Circ.
🗸
🗶
1103
CREATESUBSCRIBER
Occupant creation in NCS. New occupant will only be created if no matching occupant was found
🗸
🗶
141
ADDADDRESSOCCUPANT
Address creation in NCS
🗸
🗶
1111
ADDSUBSCRIPTION
Subscription creation in NCS
🗸
🗶
56
CCFUNDCAPTURE
Capture previously authorized funds
🗸
🗶
57
PAYMENTNEWSTART
Inform Payment in NCS
🗸
🗶
58
UPDATEPAYMENTTRAN
Update Transaction in Payway to store NCS info
🗸
🗶
1033
LINKOWNER
Creates the association between the Newstart and the Registration
🗸
🗶
954
CHGEMAILPREF
Subscribes the new subscription to the set of Preferences that are configured as default preferences.
🗸
🗶
Subscription is not stopped.
the sub_status is not “S” (subscription is not stopped)
The subscription is trial.
the subscription kind is Trial.
The subscription is COMP. Payment is not allowed.
the isComp field of the subscription table is true. (Subscription is complimentary) Note: This is not yet updated to check the subscription kind = ‘comp’
Subscription has been stopped for too long. A new subscription is required.
the number of days passed after stopping the subscription is greater than the value in Restart.MaxStoppedDays MG2 Control App setting
The subscriber already made a payment over the last 24 hours.
any of these events 'PAYMENTCC', 'PAYMENTACH', 'RESRTPAYMENTACH', 'RESRTPAYMENTCC', 'PAYMENTNEWSTART' have been created for the subscription in the last 24 hours
The subscription has pending restart transactions
there is a "RESTART" event for the subscription with a DateEffective in the future
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.
Upon clicking the Log In button, an Auth0 login modal will appear, prompting the user to enter their credentials. Enter the recipient's email ID and password, click Login.
Pictorial Flow of Account linking:
Subsequently, the Log In button on the Congratulatory page will transform into a Continue button. Click Continue.
The recipient will then be directed to the ‘Verify Your Subscription’ page.
On this page, they can verify the subscription using the options for Last Name and Account Number.
Use the Account number that was received in the gift notification mail.
Finally, the user will be redirected to the homepage of the Self-Service portal where they can manage the subscription.
Note: Currently Subscribe does not support the account linking of gift subscriptions with the lookup options Zipcode+Phone Number and Zipcode+House Number.
If the restarting has to occur at a future date, uncheck the box.
Click the calendar icon to display all the possible restart dates. Select a desired date.
If the restart has to happen on a future date, uncheck the checkbox. Click the calendar icon and select the date of your choice from the pool of available dates.
Note: By default, ‘Restart immediately’ option is selected.
