Circulation Release Notes
NavigaContact Support
  • Circulation Release Notes
    • NCS Circ Maintenance Release: 2025-2.0
    • NCS Circ Rapid Release: 2025-1.1
    • NCS Circ Maintenance Release: 2025-1.0
    • NCS Circ Major Release: 2025-0.0
      • 2025-0.0 - Resolved Issues
      • 2025-0.0 - Enhancements
      • 2025-0.0 - Schema Changes
    • NCS Circ Rapid Release: 2020-6.4
    • NCS Circ Rapid Release: 2020-6.3
    • NCS Circ Rapid Release: 2020-6.2
    • NCS Circ Rapid Release: 2020-6.1
    • NCS Circ Maintenance Release: 2020-6.0
      • 2020-6.0 - Resolved Issues
      • 2020-6.0 - Enhancements
    • NCS Circ Rapid Release: 2020-5.1
    • NCS Circ Maintenance Release: 2020-5.0
      • 2020-5.0 - Resolved Issues
      • 2020-5.0 - Enhancements
    • NCS Circ Rapid Release: 2020-4.3
    • NCS Circ Rapid Release: 2020-4.2
    • NCS Circ Rapid Release: 2020-4.1
    • NCS Circ Maintenance Release: 2020-4.0
      • 2020-4.0 - Resolved Issues
      • 2020-4.0 - Enhancements
    • NCS Circ Rapid Release: 2020-3.2
    • NCS Circ Rapid Release: 2020-3.1
    • NCS Circ Maintenance Release: 2020-3.0
    • NCS Circ Rapid Release: 2020-2.2
    • NCS Circ Rapid Release: 2020-2.1
    • NCS Circ Maintenance Release: 2020-2.0
Powered by GitBook
LogoLogo

COPYRIGHT © 2025 NAVIGA

On this page
  • Circulation Management (CM)
  • Customer Service
  • Route Service
  • Tools
  • Vindicia
  • Setup
  • Reporting
  • Extracts
  • Payments
  • Credit Card Surcharge
  • Naviga Pay
  • Naviga Subscribe Integration
  • Naviga Subscribe
  • MicroAPIs in support of Naviga Subscribe Integration
  • Application Programming Interface (API)
  • Circulation (Circ) API
Export as PDF
  1. Circulation Release Notes
  2. NCS Circ Major Release: 2025-0.0

2025-0.0 - Enhancements

Previous2025-0.0 - Resolved IssuesNext2025-0.0 - Schema Changes

Last updated 3 months ago

Circulation Management (CM)

Customer Service

  • Previously, when creating a Temp Stop for Mail subscribers, the Temp Stop Reason codes with “OnlineVacation” set to “Yes” in Reason setup were not displayed in the “Stop Reason” drop-down menu of the customer services screen. Enhancements have been made to NCS Circ and the MicroAPI “AddVacation” to ensure the correct display of Reason Codes based on subscriber type:

    1. Route Subscribers: Both types of Reason Codes, with “Online Vacation” = “Y” or “N,” will be displayed.

    2. Online Subscribers: Reason Codes with “Online Vacation” = “N” will be displayed.

    3. Mail Subscribers: Both types of Reason Codes, with “Online Vacation” = “Y” or “N,” will be displayed.

    (CM2-10694)

  • In the Payment Information screen of Customer Services, the character size limit of the Payment Source field has been increased to 20 characters. This change allows for the incorporation of payment source categories such as MPAN ApplePay and DPAN ApplePay for ApplePay transactions made through Payway.

    (CM2-11137)

Route Service

  • The maximum allowed character length for the Burt Alt Zone Codes fields has been increased:

    1. Graphical Route Service > Setup > Route Setup Utility

      The “Burt Alt Zone Code 1” and “Code 2” fields in Route Setup Utility now support up to 10 characters, increased from 8.

    2. Character Setup > Distribution > Route > Distribution Point > Specifics > Distrib Point Publication Setup

      The “Burt Alt Zone Code 1” and “Burt Alt Zone Code 2” fields in Distrib Point Publication Setup now support up to 10 characters.

      Note:– These changes apply only to Distribution Point Publication records and do not affect Distribution Point Zip records.

    (CM2-10913)

Tools

  • A new utility, PymtAuth_BizRules, has been added to the standard scrub program for the TEST/UPG database. This utility will be included in the crypt purge process and will perform the following tasks after a database refresh:

    1. Update Payment Authorization Business Rules based on values specified in the parameter file (CSV) located in the TEST/UPG database directory.

    2. Update HostName and PhysicalDB Business Rules as needed.

    (CM2-10813)

  • Utilities > Import > Demographic Answer The Import Demographic Answers screen has been upgraded to support the import of demographic answers for both Subscription and Account demographics from a flat file.

    The flat file should have the format as follows:

    1. Subscription Demographic Answers: Subscription ID | Answer

    2. Account Demographic Answers: AccountID | Answer

    This utility accepts a range of data types for both Account and Subscription demographics, including:

    1. Integer

    2. Character

    3. Decimal

    4. Logical

    5. Date

    (CM2-10863)

  • Utilities > Subscription/Address > Extend Expire Dates The Extend Expire Dates utility has been updated with the addition of a new “Use Import File” option. When this option is selected, the “File Name” field (name of the file to import) will be available.

    Only two types of data should be included in the import file: the SubscriptionID and the number of days to extend, separated by a pipe delimiter (SubscriptionID | Days to extend). Any additional data present in the import file will result in an error.

    Note:– After updating to 2025-0.0, make sure to recreate/resave the input files.

    (CM2-11207)

  • A new add-on, ChurnRetention, has been introduced in NCS Circ. This add-on enables users to activate or deactivate churn-related features, such as Churn Extract and Churn Statistics Import, within the application. Add-On Activation:

    To activate the add-on, please contact Naviga Support. Once the password has been received, enter it in: Setup > System > Security > Add-On Activation > ChurnRetention.

    Note:– If the ChurnRetention add-on is deleted, the menu security for churn-related features will remain active, but the corresponding menu items (Churn Extract and Churn Statistics Import) will be disabled in the Graphical User Interface.

    (CM2-11627, CM44#30)

  • A new menu option, Churn Extract, has been added under Graphical Utilities > Export. This utility is designed to extract data used to identify customers at risk of churning.

    • The Churn Extract utility includes the following input parameters:

      Field
      What to enter

      Product

      Select the product for which the churn data is required.

      Status to Dump

      Specify the subscriber status: Active, Inactive, or Both.

      Delivery Method

      Specify the delivery method: Print, Digital, or Both.

      Cut-off Date

      Enter the cut-off date.

      The data will be extracted from this date onwards.

      Export File Name

      Specify the file name for the churn export file. The file will be placed in the churn/out subfolder of default exchange directory.

    Note:–

    After deploying this release, create a new subdirectory, ‘churn/out’, within the default exchange directory to store the extracted churn files.

    Path: [defaultdir]/churn/out

    (CM2-11633)

  • A new menu option, Churn Statistics Import, has been added under Graphical Utilities > Import. This utility allows users to import churn statistics received from the Common Data Platform (CDP) server. The imported churn data will be displayed on the Customer Service screen, categorized by the subscription churn score range.

    • The Churn Statistics Import utility includes the following input parameters:

      Field
      What to enter

      Read Option

      Specify whether the import should be executed in commit mode (importing churn statistics into Circulation) or in edit mode (reading the file without importing and displaying any errors). It is recommended to first run this option in edit mode to confirm that there are no errors during the import.

      File Name

      Enter the file name for the import.

      The churn statistics will be imported from this file located in the churn/in subfolder of default exchange directory.

    • The Churn Statistics Import utility will import the below fields into Circulation:

      Field
      Description

      BusinessID

      Business ID

      DatabaseID

      Database ID

      ProductID

      Product ID

      SubscriptionID

      Subscription ID

      DeliveryMethod

      Current delivery method of the subscription

      RateType

      Current rate type of the subscription

      PercentOfFullPrice

      Comparison of current rate code to the last rate code in the rate chain

      WeeklyRateAmount

      Weekly rate amount

      IsWasInGrace

      Indicates whether the subscription has ever been in grace

      IsWasAutoRenew

      Indicates whether the subscription has ever been on auto renew

      TotalRelationshipDays

      Total number of days since the last start

      TotalActiveDays

      Total number of active days since the last start up to today

      TimesInGrace

      The number of times the subscription was in grace excluding temporary stop days

      NumOfComplaints

      Total number of complaints since the last start

      NumRateChange

      Total number of rate changes since the last start

      NumRenewals

      Total number of renewals since the last start

      NumPayments

      Total number of payments since the last start

      NumNewStarts

      Total number of new starts

      WeeklyDeliveryDays

      Total number of delivery days per week based on the delivery schedule

      LastTermLengthInDays

      Number of days purchased with the last payment

      ChurnLevel

      Churn level of subscription calculated by the CDP server (e.g.1,2,3, etc.)

      ChurnScore

      Churn score of subscription calculated by the CDP server (ranges between 0.00 and 1.00)

      Note:–

      1. Validation has been implemented for five fields that will be saved in the NCS Circ database: SubscriptionID, ProductID, Delivery Method, Churn Level, and Churn Score.

      2. After deploying this release, create a new subdirectory, “churn/in,” within the default exchange directory to store the churn files for import.

        Path: [defaultdir]/churn/in

    (CM2-11634)

  • A new tab, Churn, has been introduced on the Customer Services screen. This tab displays churn information returned from the Common Data Platform (CDP) server, which analyzes circulation data to provide NCS with the Churn Level and Churn Score. The Churn Level represents customer satisfaction on a scale from 1 (lowest) to 5 (highest).

    The Churn Status screen includes the following three fields:

    1. Churn Level: Displays the churn level of the subscription as calculated by the CDP server and feedback.

    2. Churn Score: Displays the churn score of the subscription calculated by the CDP server.

    3. Churn Date: Indicates the date on which the churn data was imported into circulation.

    To visually represent customer satisfaction levels, emojis will be used, corresponding to the following scale:

    • 1: Not Satisfied

    • 2: Slightly Satisfied

    • 3: Satisfied

    • 4: Very Satisfied

    • 5: Extremely Satisfied

    Note:– The Churn Retention table, located to the right of the Churn tab, displays the churn offers available to the customer. Currently, this table is blank and will be populated in a later phase when the feature is fully developed.

    (CM2-11790)

  • Utilities > Export > Churn Extract Utilities > Import > Churn Statistics Import

    Menu security has been enabled for the Churn Extract and Churn Statistics Import menu options to regulate access at the user level. The default security value is set to “Not Activated,” which prevents users from accessing these menu items.

    Only users who are part of the Menu Security ID will have access to these options, while users not included in the Menu Security ID will be denied access. For any required assistance, please contact Naviga Support.

    (CM2-11630)

Vindicia

  • The CIT/MIT (Cardholder Initiated Transaction/Merchant Initiated Transaction) functionality has been implemented in NCS Circ for Braintree payment processing. A new sciToken parameter has been introduced in the SEND Payment request to Vindicia. This sciToken will now contain the Network Transaction ID (networkTransId) received from Braintree.

    Note:– In cases of multiple autopay declines, the networkTransId will be updated with the most recent value, and only the latest networkTransId will be sent to Vindicia.

    (CM2-10971)

Setup

  • Character Setup > Accounting > General Ledger > Bank A new electronic file format, CIBC2, has been introduced for Bank Setup. This format is specifically created for client sites using CIBC Bank.

    (CM2-10699)

  • Setup > Rules > Business Rules In the Business Rule Setup screen, a new section called Subscribe has been introduced, along with a set of new Business Rules. These Business Rules have been added at the Business level.

    1. What is the URL to access Subscribe Webhook?

      Default Value: Blank

      Enter the URL to access the Subscribe Webhook.

    2. What is the Media Group code used for Subscribe Webhook?

      Default Value: Blank

      Enter the Media Group Code of the tenant for the Subscribe Webhook.

    3. What is the Media Client code used for Subscribe Webhook?

      Default Value: Blank

      Enter the Media Client Code of the tenant for the Subscribe Webhook.

    4. What is the Client code used for Subscribe Webhook?

      Default Value: Blank

      Enter the Client Code of the tenant for the Subscribe Webhook.

    5. What is the Paper code used for Subscribe Webhook?

      Default Value: Blank

      Enter the Paper Code of the tenant for the Subscribe Webhook. This Business Rule can be set at both the Publication level and the Business level.

    6. What is the Authorization code used for Subscribe Webhook?

      Default Value: Blank

      Enter the JSON Web Token to be used for accessing the Subscribe Webhook.

    7. What is the Source system used for Subscribe Webhook?

      Default Value: Blank

      Enter the consumer or the source system from where the Subscribe Webhook is being accessed.

    8. What is the time interval for which the batch job for Push Notifications should sleep?

      Default Value: 0

      Enter the time interval (in minutes) in which the Webhook endpoint should receive the next batch of notifications or convert records.

      The Webhook will receive push notifications in batches, and based on the value defined in this setting, the notifications will be paused every time after each batch has been sent.

    (CM2-10880) (CM2-11833)

  • The DigiCert license, originally valid until May 20, 2024, has been updated. The JAR files have been re-signed with a new certificate, extending the validity until May 20, 2027. (CM2-11301)

  • Graphical Setup > System > Security > Menu Security The ‘Menu Security’ option, which was previously accessible through the Character User Interface (CHUI), is now available through the Graphical User Interface (GUI).

    (CM2-11353) (CM2-10372)

Reporting

Extracts

  • The occupant_name.txt file in Subscribe Extracts has been updated to include two new fields: Occupant.OtherName and Occupant.OtherNameUsage.

    1. Occupant.OtherName: Provides details of the alternate name for the occupant.

    2. Occupant.OtherNameUsage: Specifies the usage of the alternate name.

    Note:– The new changes are available in Subscribe Extract’s export versions 8 and above. Please contact Naviga Support for this change to be implemented.

    (CM2-11079)

  • The non_subs.txt file of Subscribe Extracts has been modified to reduce the total number of columns from 38 to 9 due to its limited use. The updated extract now includes only the following columns:

    1. pub_code

    2. occupant_id

    3. pbs_address_id

    4. occupant_type

    5. first_name

    6. last_name

    7. email

    8. creditstatus

    9. site

    Note:– The new changes are available in Subscribe Extract’s export versions 9 and above. Please contact Naviga Support for this change to be implemented.

    (CM2-11483)

  • Character Utilities > Export > Subscribe Extract Previously, the address_master.txt file in Subscribe Extracts contained a row for each address and publication/route ID combination, leading to excessive data duplication. To optimize this, the following changes have been made:

    1. The columns listed below have been removed from address_master.txt and moved into a new file, address_master_detail.txt:

      1. address_id (This column will remain in both files.)

      2. route_id

      3. DistrictID

      4. Redelivery

      5. ProductID

    2. In addition, a new input parameter, “Full Address,” has been introduced on the Subscribe Extract screen.

      1. When set to ‘yes’, the system will export the entire Address table.

      2. When set to ‘no’, the system will export only incremental data, where Address.ModifyDate is greater than or equal to the Export Start date.

    Notes:–

    1. The new changes are available in Subscribe Extract’s export versions 9 and above. Please contact Naviga Support for this change to be implemented.

    2. After updating to 2025-0.0, make sure to recreate/resave any input files.

    (CM2-11511)

Payments

  • The Circ application has been integrated with the third-party vendor Enghouse’s Pause and Resume API so that the call recording between the CSR and subscribers now includes an automatic Pause and Resume feature, which the CSR previously handled manually when collecting credit card information or making any other payment-related entry. This functionality pauses call recording when the Payment Hosted Order Page (HOP) is opened and resumes recording immediately once the HOP is closed.

    Note:– To utilize this feature, the customer should make sure that all the open modules have been closed and then reopen only the required modules; otherwise, any existing open modules will return an error.

    (CM2-10593)

  • Two new payment vendors, Eigen and ImpressPay (now FluidPay), have been introduced to the NavigaPay suite for payment processing. Changes have been made in NCS Circulation to support these new vendors.

    Note:– While ImpressPay payments are supported in NCS Circulation, the Hosted Order Page integration is currently incompatible due to the existing JX Browser version (v6). An upgrade to JX Browser v7 is underway to enable full support. In the meantime, payment processing through ImpressPay remains fully functional via the Subscribe application.

    (CM2-11324) (CM2-11563)

  • The maximum character length for the Credit Card Account Holder Name field has been increased from 30 to 64 characters. Users can now enter or submit up to 64 characters for the Account Holder Name throughout the NCS Circ application. (CM2-11476)

Credit Card Surcharge

  • The add-on, CreditCardSurcharge, has been modified to allow a predetermined surcharge to be applied to Subscription Rate Terms. This surcharge will be added to the base rate, with an additional option to apply taxes to the surcharge.

    • Add-On Activation:

      To activate the add-on, please contact Naviga Support. Once the password has been received, enter it in: Setup > System > Security > Add-On Activation > CreditCardSurcharge.

    • Business Rules:

      Two new Business Rules have been added under the Subscriber Payments Section:

      1. Should the CC surcharge be applied on term/grace value only?

        Default value: No.

        This setting determines whether the Credit Card surcharge amount should be calculated against the total payment or just the term/grace value.

        1. If the value is set to Yes and the add-on is activated, the CC surcharge will only be applied to the Term/Grace value.

        2. If the value is set to No, the surcharge amount will be applied to the Total Payment amount.

      2. What is the default percent to use for Cash Discount?

        Default value: 0 (zero percent).

        This setting specifies the default surcharge percentage to be applied to the transaction. For example, to apply a 6% surcharge, enter the value as 6, and for a 5.5% surcharge, enter the value as 5.5.

    (CM2-11282) (CM2-11307)

  • A new column, CC Total Amount,’ has been added to the Rate Terms subtab under the Rates tab in Customer Services. This column displays the sum of the Rate Amount and the Credit Card (CC) surcharge. The surcharge is calculated based on the value defined in Business Rule BR2 as referenced below.

    The ‘CC Total Amount’ column will only appear when the following three conditions are met:

    1. ADD ON: CreditCardSurcharge should be activated.

    2. BR1: Should the CC surcharge be applied on term/grace value only? (Subscriber Payments Section). The value should be set to ‘Yes.’

    3. BR2: What is the default percent to use for Cash Discount? (Subscriber Payments Section). The value should be greater than 0.

    (CM2-11308)

  • A new field, “CC Payment Amount,” has been added to the ‘Price Quote’ subtab under the ‘Rates’ tab in Customer Services. This column displays the sum of the Payment Amount and the Credit Card (CC) surcharge. The surcharge is calculated based on the value defined in Business Rule BR2 as referenced below.

    The ‘CC Payment Amount’ column will display an amount only under the following conditions:

    1. ADD ON: CreditCardSurcharge should be activated.

    2. BR1: Should the CC surcharge be applied on term/grace value only? (Subscriber Payments Section). The value should be set to ‘Yes.’

    3. BR2: What is the default percent to use for Cash Discount? (Subscriber Payments Section). The value should be greater than 0.

    (CM2-11514)

  • When processing payments through the Customer Services screen and the CircAPI with the ImpressPay payment vendor, two new parameters have been introduced to the NavigaPay API’s createVaultTransaction endpoint. These parameters enhance transaction handling by separating tips and donations from taxes and processing fees:

    1. splitAmount: Specifies the amount allocated for tips, donations, or cash adjustments.

    2. adjustmentAmount: Defines adjustments made to the transaction, such as credit card surcharges.

    The API response now includes the following additional parameters:

    1. adjustmentAmount

    2. splitAmount

    3. splitTransactionId

    Notes:–

    1. This functionality is specific to ImpressPay. For other vendors, the payment process will continue to function as it did in previous versions.

    2. The CreditCardSurcharge add-on must be activated to apply credit card surcharge amounts to a transaction.

    (CM2-11345) (CM2-11614)

  • Convert Records: The SplitTransactionID received during payment transaction processing will now be stored in the Convert.NewCharacter[1] field for the TransferKey “SplitAmount”.

    (CM2-11616)

  • A new field, “CCSurcharge”, has been added to the API response for the following APIs:

    1. CS APIs:

      1. AutoRenew Form Page (autoform1.html)

      2. Single Payment Form Page (payinfo.html)

    2. Micro APIs:

      1. GetRateCodeDetails

      2. GetSubscriptionInfo

    This field will now display the calculated credit card surcharge as part of the API response for these endpoints.

    The ‘CCSurcharge’ field will be returned in the API response only under the following conditions:

    1. ADD ON: CreditCardSurcharge should be activated.

    2. BR1: Should the CC surcharge be applied on term/grace value only? (Subscriber Payments Section). The value should be set to ‘Yes.’

    3. BR2: What is the default percent to use for Cash Discount? (Subscriber Payments Section). The value should be greater than 0.

    (CM2-11453) (CM2-11660)

Naviga Pay

  • Payway now supports secure tokenization of merchant tokens (MPAN—Merchant Pay Account Number) for ApplePay transactions, in addition to device tokens (DPAN—Device Personal Account Number).

    • NavigaPay will now return the parameter “isMPAN” to differentiate between DPAN and MPAN transactions:

      1. If the value of “isMPAN” is True, the token will be identified as an MPAN.

      2. If the value is False, it will be considered a DPAN.

    • Convert Records:

      The value of "isMPAN" returned by NavigaPay will now be stored in the New Integer[1] field for the TransferKey "ExtSubPayment" as follows:

      1. If NavigaPay does not return the “isMPAN” parameter, the integer value 0 will be stored in the Convert Record Table.

      2. If NavigaPay returns “isMPAN” with a value of True, the integer value 1 will be stored.

      3. If NavigaPay returns “isMPAN” with a value of False, the integer value 2 will be stored.

    (CM2-10972)

  • A new parameter, isFirstRecurringPayment, has been introduced in NCS Circ for requests sent to NavigaPay. This parameter helps in mapping and sending transaction information to Braintree, distinguishing between Cardholder-Initiated Transactions (CIT) and Merchant-Initiated Transactions (MIT). The mapping of Transaction Mode and frequency will now work as follows:

    1. Transaction Mode = Moto/eCommerce and Transaction Frequency = Initial:

      • These are the first payments in a recurring series.

      • Circ Action: isFirstRecurringPayment is set to true.

      • NavigaPay Action: Sends “recurringinitial” to Braintree (CIT).

    2. Transaction Mode = Moto/eCommerce and Transaction Frequency = Recurring:

      • These are subsequent payments in a recurring series.

      • Circ Action: isFirstRecurringPayment is set to false.

      • NavigaPay Action: Sends “recurring” to Braintree (MIT).

    3. Transaction Mode = Moto and Transaction Frequency = Single:

      • These are one-time Moto transactions.

      • Circ Action: isFirstRecurringPayment is set to false.

      • NavigaPay Action: Sends “moto” to Braintree (CIT).

    4. Transaction Mode = eCommerce and Transaction Frequency = Single:

      • These are one-time eCommerce transactions.

      • Circ Action: isFirstRecurringPayment is set to false.

      • NavigaPay Action: Sends “Null” to Braintree (CIT).

    Note:– The isFirstRecurringPayment parameter is generic and will be sent to all vendors from the NCS Circ side. However, NavigaPay will only use this parameter for Braintree transactions.

    (CM2-11042)

  • A new “Retryable” flag has been introduced in the Braintree response to indicate whether a transaction is a hard decline (false) or soft decline (true). Now, when a subscriber’s AutoPay payment is declined by Braintree for any reason, the subscriber will now be automatically removed from AutoPay and a Billing Change transaction with remarks will be created on the publishing date for the declined payment.

    If the value returned by the Retryable flag is True (indicating a soft decline), the Billing Change transaction will be created with the remarks “Removes from autopay. Set as suspended. Marked for Vindicia.”

    Notes:–

    1. The Retryable flag is only included in the Braintree response if the setting isRetryable is added to the properties file and set to True/Yes.

      • If isRetryable is not added or is set to Blank/False/No, the Retryable flag will not be returned.

      • If isRetryable = True/Yes and the Braintree decline code returns Retryable = No, NCS triggers a billing change to end-date the Auto-Renew Subscription.

    2. Only transactions with soft declines will be sent to Vindicia, as it is not necessary to send hard declines.

    3. The Reason Code for the Billing Change can be defined in the Business Rule— What is the default Billing Change Reason Code for Discontinued AutoPay when Credit Card account is closed? (Customer Services section).

    4. The Remarks will contain the Decline Reason Code and its description.

    (CM2-11117)

  • When processing the initial Credit Card AutoRenew payment, the transactionFrequency was previously sent as “Initial” to NavigaPay. This value has been updated to “RecurringInitial,” as “Initial” is no longer accepted by payment vendors integrated with NavigaPay. In addition, the isFirstRecurringPayment flag, which was previously sent to NavigaPay for Braintree transactions during Credit Card One-time Payments, has now been removed. (CM2-11576)

Naviga Subscribe Integration

Naviga Subscribe

  • When creating a New Start or Restarting a subscription that is either Perm Stopped or Expire Stopped, a push notification will now be sent in the Subscribe application. Additionally, a conversion record will be added to the NCS Circ.

    Note:– The push notification conversion record will only be produced if the Business Rule— What is the URL to access Subscribe Webhook? (Subscribe Section) is not set to blank.

    (CM2-10883)

  • Previously, the GetInvoices MicroAPI retrieved the storage path for invoice PDFs (or acknowledgment receipts) from a hardcoded location: .../[defaultdir]/subscribeinvoices. Changes have been made so that the path for fetching the PDF files is now dynamically obtained from the Document Setup (Setup > Miscellaneous > Document).

    (CM2-11211)

  • A new Business Rule, What is the public URL to access the invoice PDFs?’ has been added under the CircAPI section, with the default value set to blank. This rule specifies the public URL path for accessing invoice PDFs (e.g., https://www.example.com/renewals/).

    1. The GetInvoices API will now retrieve this public URL path from the Business Rule and append the invoice filename (e.g., Renewal-DM-59917-04222024.pdf) to it.

    2. The full URL returned in the API response will be: https://www.example.com/renewals/Renewal-DM-59917-04222024.pdf.

    (CM2-11382)

MicroAPIs in support of Naviga Subscribe Integration

  • MicroAPI GetPaymentDetail Enhancements:

    1. The GetPaymentDetail API now includes three additional output fields:

      1. Premium Amount

      2. Activation Fee

      3. Printed Bill Fee

    2. The API now returns the Payment Transaction details with the Cancel Transaction Number for declined transactions.

    3. When the isAdjustment flag is set to true, a new field, “Description,” is included in the API response. This field displays the web description for the Adjustment Code, providing additional context.

    4. A new parameter, “Payment Type Details,” has been added to the API response. This parameter specifies whether the payment was made through Credit Card or Bank Draft.

    (CM2-10716) (CM2-11179) (CM2-11272)

Application Programming Interface (API)

Circulation (Circ) API

  • A new output parameter, “Receive Bonus Day”, has been added to the “FindSubscription” CircAPI response. This parameter indicates whether a subscriber has opted to receive papers on special days that are not part of the normal delivery schedule. (CM2-10351)

  • The error message for Error Code 19 was misleading when creating transactions using CircAPIs. Previously, the message incorrectly stated, “PayPalEmail field contained invalid characters that were removed,” even though the transaction was rejected due to invalid characters in the PayPal Email field. The error message has been updated to correctly reflect the issue. It now states, “PayPalEmail field contains invalid characters,” providing a more accurate description of the error.

    (CM2-10730)

  • Previously, attempting to permanently stop a Non-Office Pay/Comp subscription using the “Add/Update/Delete/Get Permanent Stop” Circ API with the StopType parameter set to “next billing cycle” resulted in an invalid date error due to missing date logic. Changes have been made in NCS Circ to ensure that the system now correctly uses the next publishing date for the billing cycle when StopType is set to ‘next billing cycle’ in CircAPI to permanently stop the subscription.

    For subscriptions with future start dates, an error message will be displayed, prompting users to “Re-enter a stop date after the current subscription start date of mm/dd/yyyy.”

    (CM2-10989)

  • In the FindSubscription CircAPI, the EndGraceDate parameter was being returned in the API response even when the subscriber's End Grace transaction had already been processed. The API has been updated to return the EndGraceDate parameter only if the End Grace Date is greater than the current Start Date. (CM2-11113)

An example of AutoRenew Form Page response