Restarts (NCS Circ)

Goal

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.

Pre-requisites

Prior to 3.16.0 Release

1. Have Subscribe 3.14 or above

2. 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

3. 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

Details

1. The subscription should be eligible for restart. The following criteria should be met:

   1. The Subscription has been stopped for less than X days (set up for the client in MG2 control)

   2. The Subscription is not Complimentary

   3. No payments made during last 24 hours

   4. The Rates are returned from the NCS Circ OR the Rates are not returned but the balance is negative

2. The final submit of the page will POST a payment of (+ Donation/Tip optional):

   1. If the balance<0, then the payment is SelectedRate.Amount (from GetRates or GetSubscriptionInfo) + Subscription.BalanceDue (from SubOcc)

   2. If the balance>0, then the payment is only SelectedRate.Amount (from GetRates orGetSubscriptionInfo)

For real-time restarts the latest extracts are required

Implementation technical details

Prior to 3.16.0

1. For getting previous outstanding balance: SubscribeAPI calls subOcc circAPI program to get previous outstanding balance.

2. 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.

3. Project Manager must create a ticket for the implementation team to turn on the Restart feature and provide the following details in the ticket:

   1. provide the URLs for get/ratecodedetails and get/ratesInfo. Please ensure the microAPI is working before creating an implementation ticket.

   2. the maximum number of days a stopped subscription must be considered to restart.

   3. whether donation/tip is used for restarts for both One CSR portal and Self Service

Starting from 3.16.0 onwards

1. For getting previous outstanding balance: SubscribeAPI calls subOcc circAPI program to get previous outstanding balance.

2. For getting restart rates: SubscribeAPI calls GET/Subscriptions/subscriptionid/SubscriptionInfo microAPI to get details.

3. Project Manager must create a ticket for the implementation team to turn on the Restart feature and provide the following details in the ticket:

   1. provide the URLs for GET/Subscriptions/subscriptionid/SubscriptionInfo.Please ensure the microAPI is working before creating an implementation ticket.

   2. the maximum number of days a stopped subscription must be considered to restart.

   3. whether donation/tip is used for restarts for both One CSR portal and Self Service

UI examples

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.

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 our public documentation).

Account management

Stopped subscription with rates returned from the circ system

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).

Stopped subscription with NO rates returned from the circ system

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).

One CSR Portal

Stopped subscription with rates returned

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).

For more details please see the Flowchart