3.16.2.X Hotfixes
This page containes the description of the hotfixes related to 3.16.2 version
DISCLAIMER
Product Information contained within this document, including technical information and functional specifications, is subject to change without notice. Naviga reserves the right to make any changes to the information in this document at any time without notice. Naviga makes no warranty, representation, or guarantee regarding the suitability of its products and services for any particular purpose.
Please note that all the 3.16.2.X hotfixes are by default included in both the next minor and major versions, which are 3.16.3 and above and 3.17.0, respectively.
If you want the fix to be applied, please input a Salesforce case.
Please note that upgrades to this version are no longer available since the Amazon S3 bucket now requires a minimum of TLS 1.2 security protocol, which is not supported by this version.
Note added on June 20th, 2023.
Lite Subscriptions Expiration Data & Status fix
Within Lite Subscriptions, the functionality to edit and update Expiration date from One CSR Portal UI was not working completely. The expiration date was being updated in one of the two dependent tables in the database and subscription status also remained Expired even if updated expiration date was set to a Future Date. This issue has been fixed by introducing new endpoints within One CSR Portal application.
Lite subscriptions: One CSR Portal tab renamed
When a user clicks on ‘Start call’ push button, the first tab displayed contains the selected account information. For Lite subscriptions, this tab name is renamed as ‘Lite Account Information’ to give it more clarity from this release.
Lite subscriptions: Currency field added
A new field Currency is introduced in Lite Account Information tab under Account Details section. By default, the field displays the value of the currency entered by the user/CSR while creating the Subscription through the Subscription Panel Presentations. The field is editable and provides the following options in a drop-down to choose from: 1) Euro 2) US Dollar 3) Swiss Franc and 4) Pound Sterling
The above UI changes and the corresponding functionality works in tandem with the following updates in the API side.
A new endpoint is created
api/startCall/Currencies/{CountryCode}
to get the currencies listThe
/Billing/Currencies
endpoint from SubscriptionsAPI is called to verify the validity of the currency being sent. Only valid currencies can be sentTo the
Update Subscription API
endpoint, the Currency parameter is added
One CSR Portal: Registration search within Subscription
In Subscribe, there are corporate accounts where each account having almost 2000 users registered under it. With the new enhancement, it is possible to search for a specific user within a corporate account.
Within the Digital Tab of Start Call push button, a new section ‘Search Registrations’ is added now. It has three search fields: Login name, First name and Last name along with Clear and Search buttons.
A new column Full name is also added in the result grid which shows the combined value of First name & Last name that brings more clarity.
The CSR can now filter the data of registrations grid by entering the login name (usually email id), by combination of First Name & Last Name, or all of them. The search results will be based on partial or exact match of the names given in the search fields.
When the Search button is clicked without any data being entered in the search fields, the grid displays all data related to active registrations under the subscription, without applying any filters.
One CSR Portal: Subscription Search by First Name or Last Name only
The Subscription Search is enhanced to be able to search with just one search field compared to the prior three search fields. With this new development, it is possible to search for user account(s) by giving either First name and/or Last name in the respective search fields.
This enhancement is enabled by an MG2Control App setting (Client Components Permission) with the key ‘SubscriptionSearchBasedOnFirstAndLastName’. If this key value is set to 1(true), then ‘Search only by First name or only by Last name’ is permitted. Or else, the current behavior follows (i.e, the user should enter value in First name, Last name and Newspaper). By default, the key value is set to 0 (false).
While the key value is 1, if the user attempts to search with fields such as House number, Street or Zip/Postal code that do not work independently, then the following error message will be displayed:
“Either First Name or Last Name or Account number or Phone number or Email or Company name or three other fields are required.”
Configuration Notes:
Created new App setting key (Support Viewer > Management > App Settings > Setting type - Client Components Permission, App type - SubCon Admin, Key - SubscriptionSearchBasedOnFirstAndLastName)
When key value is set to 1, it is possible to search with First name and/or Last name. However, a search with only House number, Street or Zipcode will trigger an error message.
By default, the key is set to 0.
One CSR Portal: User Accounts Search by First Name or Last Name only
Certain clients can have a large number of users and hence it might get difficult to search registrations only by Login Name i.e. Email Id. Hence this new development.
The User Accounts → Search Module is enhanced with additional search criteria for First Name and Last Name. With this new feature, users can now search for user accounts either by giving First name and/or Last name in the respective fields. The search results will be based on partial or exact match of name given in the search fields with the only requirement being that the initial characters of the search text must match exactly. For instance, a search using the text "HE" will return a match for "HELLO", but not for "LLO".
A new column ‘Full Name’ is added in the search results grid to provide users with more accurate search outcomes.
In addition, the "Show only registrations" checkbox is removed from the user interface. The checkbox was previously checked and disabled in all cases, rendering it redundant. However, this change does not affect the backend logic.
The above enhancement is made possible with the following API changes in the backend.
The
SearchUserByEmail
endpoint is renamed to SearchUser.The APIs are modified to include FirstName and LastName as parameters.
One CSR Portal: Capture Additional Registration Data when creating a New Registration
Certain clients have corporate accounts in which each account can have a large number of registrations under it. The registrations data can be used by the client for their external activities and campaigns but currently the system does not capture enough information to fulfill this purpose. From this release, the Subscribe system is enabled to capture extra information for each user Registration. However, this is an optional function and can be switched on/off with a MG2Control App setting, RegistrationAdditionalData.
When the MG2Control RegistrationAdditionalData is set to true, the following happens:
When a user clicks Invite / Invite Without Registration, additional fields for Company Name, Position (Job Title), Phone, Address, City, Postal Code, Country are displayed. Data entry to these fields are optional.
Data entry to these fields are free text except for the Country field, which will be a dropdown. The Country drop-down has the same options as that are available under Lite Account Information tab.
When the MG2Control RegistrationAdditionalData is set to false then the additional fields are hidden.
One CSR Portal: Additional user details available in Profile settings of User account
Once the additional user registration data is captured in the system, it will be available under the Profile settings of User accounts (User accounts > Search > Registration > Profile settings). The additional user data fetched from the database will be editable with a Submit button. This functionality also depends on the value of the MG2Control App setting key, RegistrationAdditionalData.
Configuration Notes: The additional fields will be available under Profile settings only if the key value of RegistrationAdditionalData is set to 1 in MG2Control > App settings.
One CSR Portal: Downloadable CSV Template
From this release, a CSV template file is available for download with extra fields such as Company Name, Position, Phone, Address, City, Postal Code, and Country, along with existing fields. A push button Download CSV Template will be displayed side by side with the Import from CSV button. The headers in the downloaded template are in sequence with the expected import order. This helps the end user to identify the sequence of columns to be maintained while importing the CSV for registration invites.
Clicking Import from CSV captures additional data columns and stores them in the Registration table without impacting existing import behavior. Country field values are validated from Subscribe Country Setup. Error messages are displayed if columns are missing or out of sequence.
Configuration Notes: The Download CSV Template button is displayed only if the MG2Control App setting key ImportRegistrationButton value is 1. The value of RegistrationAdditionalData MG2 Control App setting determines if extra fields are to be included in the template or not. If the value is 1, the template file will have all the extra fields and if the value is 0, the template will have only the default fields (Email, First name, Last name and User Type). When this setting is 1, the additional fields are also saved in the Invitation table at the time the Registration invitation is sent.
One CSR Portal: Append action added for Registration Import from CSV
In the Bulk Invitations Import window, when importing the uploaded file, all existing entries were deleted and replaced with the records in the file. It was difficult to handle the requirement to add a couple of entries to an existing list of over 500 entries. Enhancements have been made to add records to the existing list rather than totally replace the entries.
The Bulk Invitations Import window now includes the option "Choose an action." By default, the action has been set to "Append." An alert message— “This action will add the new records without deleting the existing ones." for the selected action will be shown at the bottom.
The "Upload" button that appeared after choosing a file has been replaced with an "Import" button. Only after a file has been chosen for upload will the "Import" button become enabled.
If a record in the uploaded file matches an existing registration (Pending or Active), the log file generates the message “Record already exists” against the record.
Note: Since records are now appended rather than overwritten, the import limit will be defined by pending invitations rather than the total registration limit.
One CSR Portal: Add Address fields in Lite Account Information
On the Lite Account Information tab, a new section called "Billing Address" has been added. This section consists the subscriber's Address, City, State, Postal Code, and Country.
Note: The Country field, which was previously located under the Personal Details section, has now been moved under the Billing Address.
The information in this section is already filled in based on the information given when the subscription was created. The values can be modified by clicking the Edit button at the bottom of the section.
Note: All fields in this section are mandatory and cannot be left blank.
One CSR Portal: Change Resend Invitation endpoint
One CSR Portal now uses the
POST /Invitations/{invitationId}/Resend
instead ofPUT /Invitations/{invitationId}
to resend the invitation email.
SubCon Site (Self-Service) - Change Resend Invitation endpoint
The SubCon Site (Self-Service) now uses
POST /Invitations/{invitationId}/Resend
instead ofPUT /Invitations/{invitationId}
to resend the invitation email.
API - Modification in GET/User/{customerRegistractionId}/{type}, GET/User/{type}
, and GET/User
endpoints
GET/User/{customerRegistractionId}/{type}, GET/User/{type}
, and GET/User
endpointsThe above endpoints now include a new output parameter called "metadata" that returns the additional registration details that are added when creating a new registration (see the point above). Note: The metadata can contain any information in JSON format and is not restricted to the registration's additional fields.
API - Modification in POST User (Create User)
and PUT User (Update User)
endpoints
POST User (Create User)
and PUT User (Update User)
endpointsWhen a user is created using the
POST /User
endpoint, metadata information can now be added and stored in the database under the Registrations table.When using the
PUT /User
endpoint to update the user details, the provided data will be used to update the user information in the Registrations table, including the metadata.
API - Modification in POST /Invitations
and POST /Invitations/{Id}
endpoints
POST /Invitations
and POST /Invitations/{Id}
endpointsWhen creating an invitation using the
POST /Invitations
endpoint, metadata information can now be added and stored in the database under the SubscriptionInvitations table.Once the invitation has been accepted, the metadata details in the SubscriptionInvitations table will be copied to the Registrations table.
API - Modification in PUT /Invitations/{Id}
endpoint
PUT /Invitations/{Id}
endpointThe PUT Invitations endpoint has been modified so that the API can only be used to change information about an invitation that is still pending registration.
The API modifies the information of an invitation in the SubscriptionInvitations table with the provided details, including the metadata.
API - New endpoint POST /Invitations/{invitationId}/Resend
POST /Invitations/{invitationId}/Resend
To resend the invitations email, a new endpoint
POST /Invitations/{invitationId}/Resend
was developed.
API - Modification in GET /Invitations
and GET /Invitations/{Id}
endpoints
GET /Invitations
and GET /Invitations/{Id}
endpointsThe above endpoints now include a new output parameter called "metadata" that returns the metadata details that are added when creating an invitation.
API - Modification in PUT /Subscriptions/{subscriptionId}/Address
endpoint
PUT /Subscriptions/{subscriptionId}/Address
endpointThe above endpoint has been updated so that the Billing and Delivery address details of offline subscribers who don't have a Circ system can now be modified.
Except for CircPro, the API modifies the address of the subscription in the repository (Subsvc) and the Lite Account Information tab with the provided details for all clients.
If the specified City and State do not match the provided Postal Code, the address will be standardized with Melissa, and the response will return the correct City and State based on the Postal Code. Melissa will fail address standardization if an invalid address is provided, resulting in an error in the response.
Missing First Name and Last name for Registered Users in Profile Settings - fix
When the CSR sends an invite to an end user to register an account or when invites were sent via bulk upload, the first name and last name were entered alongside the email and guest/owner fields. However, after registration, the First Name and Last Name fields were not populated in the user's profile settings in One CSR Portal.
The root cause of this issue was that the first name and last name of an invited user were getting saved only on the Subscriptioninvitations Table and not in the Registration table. This data was not getting stored or introduced in any other scenario of the entire Invitations flow.
To rectify this, we have added an extra step. When a user accepts an invitation, the site calls /Invitations API as always, and the /Invitations API also pass first name and last name information to /Users API (endpoint PUT /User
). This results in an update of firstname and lastname in the Registration table (Subsvc DB of a specific client).
Thus, with this new release, the first name and last name fields are now correctly populated in the user's profile settings upon registration.
PayPal Braintree Autorenewal - fix
Paypal via Braintree Renewals have been getting declined in circulation. It was identified that the PaypalBAID parameter while purchasing the subscription on EzPay was not being sent accurately to Circ. The issue has been fixed by passing the appropriate parameter from payment vendor to circulation system.
This particular fix was also merged to 3.16.1.6 and 3.16.1.10
Areas covered:
API, One CSR Portal, SubCon Site (Self-Service)
Last updated