Release Notes - v9.1.x

About the Release Notes

For new major enhancements the release notes provide:

• A brief, high-level description of the functionality

• Implementation tips to help you get started with setup and administration

• Best practices to help you maximize the benefit

• Complete end-to-end instructions (where available)

Smaller changes to existing features are also described so that you can plan for the new release. Unlike a traditional release notes document that includes only a simple list of enhancements these release notes give you everything you need to get up and running with the new features and enhancements in the latest release. If you have any questions please don’t hesitate to contact your LogiSense support representative.

9.1.0 Release Notes

Notice: EngageIP 9.1.0 requires .NET Framework 4.7.1 installed on both the Web Server and App Server

Change Highlights

• Added features for General Data Protection Regulation (GDPR) Compliance:

  • Added a 'Consented' option on the Create Account page and the Details section of the account Overview screen. Consented tracks that the customer has authorized the collection and use of their personal data

  • Integrated consent option with the LogiSense Hosted Payment Page so that consent is requested in the web portal

  • Added a 'Purge' feature on the account search results page which allows you to anonymize account data and remove any reference to it in the AdminPortal. This includes deleting previously rendered invoices which contained account data

  • Added a report called 'Account Personal Profile Report' which lists personal data for each account and if the user consented to the collection and use of their data

• Job Scheduler Enhancements:

  • A 'Start Time' field has been added to allow jobs to execute at a specific time

  • A 'Job Sync Type' option has been added with two selections, Asynchronous and Synchronous. Asynchronous jobs can run simultaneously using multiple threads, Synchronous jobs run sequentially

  • The creation of duplicate job schedules of the same job and parameters under an owner is no longer permitted

• AvaTax Cloud-based Support:

  • Added Integration support for the AvaTax cloud-based (SaaS) solution

  • Added tax estimation support with cloud solution

  • Added a new job called UDRPendingTaxesNotificationJob which runs every four hours and sends an email if unprocessed UDR pending taxes goes above a threshold value. The threshold and email address recipients are configurable on the job

Enhancements and Fixes

• Added support to apply invoice discounts at an owner level. Invoice discounts configured on the owner-user will work alongside discounts at other levels (e.g. you can have invoice discounts configured at a child account level, parent account level, owner account level and all applicable discounts will be applied)

• Added a 'Tax Precision' option on the Configuration screen which allows tax values to be presented with two to four decimal places of precision. EngageIP Reports, Tax Rates, Invoice Configuration and other screens will display/support the ability to display the specified precision

• Added the ability to edit the 'Owner Parent Account Billing Type' on an existing owner. The billing type setting can only be changed if all account invoices under the owner are closed and the balances of all accounts are zero

• Fixed a branded owner creation issue that returned an invoice configuration copy failure message and resulted in a failure creating the new branded owner

• Removed the requirement for credit note (InvoiceCredit) numbers to be unique

• Modified the Detail field on the Transactions > Credits list to include the transaction ID of refunds

• Removed the Base Time values 'Day' and 'Week' from the Package setup page and the Base Time value 'Week' from the Service setup page. Daily and weekly packages are unsupported configurations. Daily services are still supported

• Fixed an issue where adding an optional service with an Effective Date later than the user-package Effective Date resulted in a transaction End date that was earlier than the transaction Start date

• Fixed an issue when adding packages to accounts where the numbering of services listed within packages was incorrect

• Fixed a package upgrade issue where profile answers were transferred to incorrect upgrade services in scenarios where the profile question names were identical on the services in the source and upgraded package

• Fixed an issue introduced in EngageIP 8.6.0-Hotfix.1 where it was possible to set a user-package cancelation date earlier than the user-package's effective date

• Fixed an issue where a duplicate event would be written to the event log when adding a user-package extended attribute

• Fixed an issue where canceling an optional user-service prior to canceling a related user-contract would result in penalty charges being applied and potentially charged more than once

• Fixed an issue which allowed user-buckets to have an Effective Date earlier than the UDR Bucket Start date

• Merged Deferred Revenue and Recognized Revenue report into one report called Recognized and Deferred Revenue

• Modified account names submitted to LitlePaymentGateways (Vantiv) to be truncated to a maximum of 50 characters

• Fixed an issue in tier sync environments where syncing a role profile question would return an error indicating that the answer was not unique even when a unique value was set

• Added a unique index to the UserAttributeTierSync table UserId column and removed existing non-unique values from the UserId column. This configuration prevents the possibility of multiple Tier Sync components being added to an account

• Fixed an issue with the commission module where adding user-agents to accounts would return an error if the user-agent name contained commas

• Removed unused field 'Retired' field from the UDRRate table

• Modified database upgrade logic so that UdrBillerTax.Rate values of NULL are set with a value of 0.0 and modified UdrBillerTax.Rate so that it can no longer be set to NULL. This addresses incorrect format exceptions that can occur when upgrading EngageIP

Developer Notes

API Changes

• New Methods

  • AddUdrRatePlanToUserPackage: Adds a rate plan to the specified user-package

  • AddUserAttributeTierSync: Adds the Tier Sync attribute/component to the specified user

  • AddUserProfileAnswers: Adds a user attribute/component profile answer to a specified profile question

  • CreateChildUserWithConsented: Creates a new child user under an existing user with the consented value specified

  • CreateChildUserWithExtendedAttributesAndConsented: Creates a new child user under an existing user with the consented value specified, and extended attributes specified

  • CreateUserPricePlan: Creates a price plan on a user

  • CreateUserWithConsented: Creates a new user with the consented value specified

  • CreateUserWithCreatedByAndCreatedDateAndConsented: Creates a new user with created details specified along with the consented value specified

  • CreateUserWithExtendedAttributesAndConsented: Creates a new user with the consented value specified, and extended attributes specified

  • CreateUserWithExtendedAttributesAndCreatedByAndCreatedDateAndConsented: Creates a new user with extended attributes, created by details and the consented value specified

  • DeleteUserAttributeTierSync: Deletes the Tier Sync attribute/component from the specified user

  • DeleteUserContractUserPackageConnector: Removes the link between a user-package and a user-contract

  • GetFilteredCustomReport: Retrieve data from a custom report using supplied filters. Report data is returned as JSON

  • GetUserAttributeTierSync: Gets the Tier Sync attribute/component values for the specified user

  • GetUserInvoicers: Gets a user's invoicers. UserIdentifiers may specify either a UserId or UserName

  • GetUserPricePlan: Gets a user price plan

  • GetUserPricePlans: Gets all of a user's price plans

  • GetUserUsageBillingFrequency: Gets a user's Usage Billing Frequency. UserIdentifiers may specify either a UserId or UserName

  • PurgeAccounts: Purges user data for list of given usernames

  • RemoveUdrRatePlanFromUserPackage: Remove a rate plan from a user-package

  • TurnPrepaidCardToNormalUserWithConsented: Adds a new user with supplied NewUsername, NewUserPassword and consented value specified only if the supplied prepaid account is a valid account

  • UpdateUserAttributeTierSync: Updates the Tier Sync attribute/component for the specified user

  • UpdateUserConsented: Updates a user's consented value

  • UpdateUserPricePlan: Updates a user's price plan

  • UpdateUserUsageBillingFrequency: Updates a user's Usage Billing Frequency. UserIdentifiers may specify either a UserId or UserName

• API Enhancements

  • Fixed an issue with the UpgradeUserPackageNew method which resulted in optional services being charged even though the BillNow parameter was set to 'false' [ticket:107072]

  • Fixed an issue with the UpgradeUserPackageNew method which caused optional services to fail to transfer on upgrade when the BillNow parameter was set to 'true'

  • CreateUser, CreateUserWithCreatedByAndCreatedDate, CreateUserWithExtendedAttributes, CreateUserWithExtendedAttributesAndCreatedByAndCreatedDate and TurnPrepaidCardToNormalUser have been updated to create users with the new consented option set to 'false'

Permission Updates

• New Role Permissions

  • AccountPersonalProfileReport (List)

  • Pricebook (Add, Edit, List)

  • RecognizedAndDeferredRevenueReport (List)

  • SalesforceBaseOpportunityMapping (Add, Edit, List)

• Removed Role Permissions

  • DeferredRevenueReport

  • RecognizedRevenueReport

  • Removed invalid permissions from multiple role permissions, specifically: 'FormatListValue', 'DoList', 'GenerateReport', 'GetListObjects' and 'GetTemplateOwner'

9.1.0-Patch.1 Release Notes

• Modified reports to display horizontal scroll bars without the need to scroll to the bottom of the page

• Fixed a resource module issue where the pending resources flag would not be cleared from a user-package after the package's user-service > resource component was deleted

• Fixed an issue introduced in EngageIP 9.1.0 which removed the plus symbol from entries in the GeoTree

• Added an error message that appears when attempting to delete a GeoTree UDR Location that is still in use

• Modified the owner tree to appear when viewing scrolled page content

• Removed the requirement of passing in a ReferenceID when writing to the tax log as a null or missing ReferenceID would prevent the entry from being written to the log

• Fixed an issue where editing a user-package rate plan would return an error due to a reference to the Retired field which was previously removed

• Fixed an issue where a service with a Base Time of 'Once' could not have its Base Time value changed after the service was added to a package with a BaseTime value other than 'Once'

• Fixed an issue introduced in EngageIP 9.1.0 where attempts to rerate more than one thousand UDR Billers would result in a rerating loop and eventually return an out of resources exception

9.1.0-Patch.2 Release Notes

• Adjusted the left navigation bar to permit scrolling when the navbar contents exceed the navbar height

• Fixed an issue where mouse over messages on notice icons would not be visible on pop-up/modal windows due to the text appearing under the pop-up

• Fixed presentation issues with pop-up pages where lists in the pop-up page were not sized properly

• Fixed presentation issues with pop-up pages that contained multiple scroll bars

• Updated database upgrade logic to ensure TaxTypeID and TaxCodeID are properly configured when an EngageIP environment has the 'CDRLevelTax' billing option present in the EngageIPOption table

9.1.0-Patch.3 Release Notes

• Fixed an issue where attempts to load a node in the GeoTree would result in a timeout

• Fixed an issue where tax values on the Invoices and Transaction pages were not observing the tax precision setting

• Fixed an issue where the Account Services report displayed incorrect user status values

• Modified the credit note disbursement pop-up window to display the invoice number instead of the invoice id value to better identify the desired invoice

• Modified logic so that updating or adding the Usage Billing Frequency component on accounts will not automatically set parent accounts to rerate. Rerating on the parent will still occur if bucket/biller dates need to be aligned to the usage next bill day

• Fixed an issue that could cause parent accounts to get stuck in a rerating loop

• Improved performance when loading available resources on the user-package add page

• Improved performance loading tickets when adding a ticket reference

• Fixed an issue where the balance field on credit notes would display a negative value equal to the taxed amount on the credit disbursement

• Modified the AddPackageToUser methods to only bill the user-package if the default user-package status type is active or the status passed in is active. This change applies to all of the following methods:

  • AddPackageToUser

  • AddPackageToUserWithNextBilldate / AddPackageToUserWithNextBilldateWithBulkQuantityAndUserPackageStatusType

  • AddPackageToUserWithExtendedAttributes / AddPackageToUserWithExtendedAttributesWithNextBillDate
    as well as the following legacy webservice methods

  • AddPackageToUser

  • AddPackageToUserWithExtendedAttributes / AddPackageToUserWithExtendedAttributes

  • AddPackageToUserWithNextBilldate / AddPackageToUserWithNextBilldateWithBulkQuantity

• Modified the Hosted Payment Page credit card hint values to look fictitious so that they do not appear as if they are valid card numbers

9.1.0-Patch.4 Release Notes

• Fixed an issue introduced in EngageIP 9.1.0 where invoice closure could take a long time to complete or return an error when looking up tax details on a large list