Release Notes - v9.2.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.2.0 Release Notes

Change Highlights

• Added Single Sign On (SSO) capability supporting any SAML 2.0 compliant identity provider. SSO features include:

  • SSO login via EngageIP AdminPortal or the identity providers login page

  • Configurable logout URL

  • SSO configuration at a branded owner level which if desired can be shared to other owners under the branded owner

  • Ability to enable/disable SSO at an individual account level

  • Automatic reauthentication upon time-out

Enhancements and Fixes

• Modified user-package cancelation and suspension logic to prevent a user-package from being canceled or disabled with a date earlier than the user-package effective date

• Modified user-package cancelation logic to only close user-service UUIH records which are in a open state. Closed UUIH records related to user-services will maintain the cancelation date that was previously set

• Modified the account Bill Group setting to be read-only if the account is not its own invoicer

• Changing the account Bill Group setting will now set the same bill group on all accounts configured to use the modified account as their invoicer

• Added a notice message which appears when updating an account's Bill Group which indicates that all accounts using the current account as their invoicer will have their Bill Group setting updated

• Modified the Transactions page to display the account's Invoicer and Usage Invoicer in their own section for better visibility. The Invoicer and Usage Invoicer details will only be shown on the Transactions page when the account isn't configured to be its own invoicer

• Improved bill run package billing performance and reduced database load when billing packages

• Modified bill run logic to display an error if the posting date configured on the bill run is set to an earlier value than the financial periods that are currently open

• Bill Run Capture Pre Auth Enhancements:

  • Fixed an issue where bill runs would attempt to capture a pre-auth that was not associated with the account's default payment method

  • Fixed an issue where fully captured pre-auth transactions were tagged as partial captures

  • Fixed an issue where bill runs treated all capture payment operations as successful, which (when captures failed) caused payments not to be collected and bill run stats to be incorrect. Now if the capture payment operation fails the bill run will attempt to collect payment using the account's default payment method

• Modified billing logic to exclude accounts from being billed if the account setup as their invoicer is in a cancelled state

  • Attempts to bill a single account in the AdminPortal or via API when the account's Invoicer is cancelled will result in a unable to bill due to cancelled invoicer message

  • Bill runs that skip accounts due to invoicer cancelation will log an info message in the BillService.log indicating that billing was not executed due to a cancelled invoicer

• Set 'Account Statistics' on the left navigation bar to be refreshed when an AdminPortal user switches to another owner to ensure stale data is not displayed

• Added a new account component called 'Do Not Rerate' which allows you to prevent rerating on accounts when a user-package/user-service is added to an account or canceled. Adding this component at an owner or parent account level is supported to pass the rerating configuration on to all accounts under the owner or parent

• Fixed an issue where editing the Change User Package Status component on an account would result in the UserPackageStatusType field changing to the first status in the list (enable)

• Fixed an issue introduced in EngageIP 8.6.0 where editing an invoice discount component on an account would return a system error message

• Fixed an issue where you could not delete a user-contract if the contract was set to renew using its own contract ID

• Added a Deposit option when making a one-off credit card payment or one-off eCheck payment

• Modified credit card number validation to be more strict when adding a credit card payment method to an account. Card numbers entered will now validate specifically against the card type specified (visa, mastercard, etc.) [ticket:102333]

• Modified logic to clear the XmlData field in the InvoiceRender table once the invoice has been rendered and the RenderedInvoice column has been populated in order to reduce disk space usage. XML Data can now be generated for any invoice on demand by using the 'Xml' button found on an account's Invoices page

• Removed the Reverse button from the Transactions page. The existing Refund button permits full transaction refunds to be added

• Modified the invoicers displayed on the Account / Tools / Invoicer page to display the correct invoicers based on the 'Owner Parent Account Billing Type' setting configured on the account's owner

• Fixed an issue where updating a sub-account's usage invoicer would also update the usage invoicer on the parent account and other sub-accounts under the parent

• Modified usage invoicer update logic to only sync parent account usage invoicer changes to sub-accounts if the sub-account's usage invoicer is set to the parent account. If sub-accounts are not set up with their parent account as their usage invoicer then modifying the usage invoicer on the parent account will not impact them

• Fixed a validation issue which allowed the Usage Billing Frequency account component to be manually set with a Usage Next Bill Date earlier than the current date

• Removed preconfigured 'OnMyBillDay' Usage Billing Frequency. This is a back end default setting that should not be editable

• Added an 'Include in Invoice XML' setting to User Extended Attributes and User Package Extended Attributes. If this option is unchecked the extended attribute will not be included in the invoice xml data reducing invoice rendering time

• Modified billing and rerating logic to ensure rerating does not include accounts that are currently being billed

• Fixed an issue where UDR exceptions could not be deleted after reprocessing rerated exceptions

• Fixed an issue introduced in EngageIP 9.1.0 which could cause a SQL server deadlock during rating in rare rating scenarios

• Added UsageInvoicer and TaxInvoicer columns to the User Invoicer reports

• Added Sent Date, Invoice Configuration, Default Payment Type and Aging columns to the Invoice Summary Report

• Fixed an issue where the User Invoicer account report wouldn't display invoicer data when viewing the report from an unbranded owner

• Fixed an exception that would occur when attempting to load custom reports which contained Real data types in their SQL view

• Modified XML Import so that imported payments are only issued to an invoice if the specified invoice is in an open state or an open invoice exists on the account. If only closed invoices exist on the account then the payment will not be issued to an invoice but will be added to the account and disbursed as normal

• Fixed an issue with the generic XML importer which prevented StatementDetails and StatementDeatilsTax from being imported

• Fixed an issue where pagination was not working in the service dropdown list on the Setup / Edit Packages / Add Service page

• Enabled the 'Create Workflow Event' option by default on the Setup / Import screen. If this option is not selected UUIH entries will not be created when importing user-packages and profile answers

• Fixed a very rare issue where UUIH update events could be ignored due to a miscalculated value in the UUIH duplicate event detection logic

• Fixed an issue where only a single canned email would be sent when the same email address was configured on multiple contacts

• Improved error handling and logging when a non-authenticated user attempts to load a page in the AdminPortal

• Fixed a logging issue where the incorrect final four digits of a card number were written to the PaymentProcessLog when a capture payment was performed after the default payment method was changed to another credit card

• Fixed an issue where the BillRunCollectionTypeID was not set in the PaymentProcessLog when a bill run collected a payment using the Capture Pre Auths option

• Modified the fraud and rating services to process feed files by their created date (oldest first) instead of processing files according to the feed source they came from

• Added the ability to calculate tax on batches of UDR records in SureTax integrated environments instead of taxing usage one UDR at a time, improving performance

• Modified the Tools / Sub Accounts / Add page to permit User Extended Attributes to be displayed and populated

• Added the ability to set up parent/child profile questions on Setup / Server Types

• Fixed an issue where dynamic pages failed to close properly and failed to return errors when invalid data was entered

• Fixed an issue where systems with multiple cancelation account status types could not purge account data for all of the cancelation statuses configured

• Fixed purge account error messages to list all data purge failures that occur, instead of just the first purge error encountered

• Modified the Batch Payment report, Credits report and Credits section on the Transactions page to exclude listing purged accounts

• Fixed an issue where the Job Schedule link on the Setup page would not appear unless the Workorders module in EngageIP was enabled

• Modified the Job Schedule to use the Next Run field to determine when to start a job instead of the Last Run date

• Added the ability to add manually queued jobs to the jobs queue via Reports / Jobs / Add

• Added the ability to send account data to remote systems via data export jobs. When data exports are configured and running export activities will be captured in the Data Export History report

• Added the ability to configure HttpMethod (POST/PUT) on Webhooks. Previously only the post method was supported

• Modified tier sync behavior to sync data when the Tier Sync component is added to a user-package. Removing and re-adding the Tier Sync component on a package in the product catalog will also trigger a resync for all accounts that contain the package

• Fixed a tier sync contact sync issue where country values were displayed in the event log when the result message related to states/provinces

• Commission Statement Enhancements:

  • Removed the 'Subject' field from the Setup / Commission Statement Template page (this option exists on the Setup / Invoice Configuration page)

  • Modified the Setup / Invoice configuration page to separate the invoice template and commission statement template configuration into two separate sections

  • Modified the 'Custom Email Body field' (previously labeled 'Text') to be displayed in commission statement emails when selected. Previously commission statement emails could not contain a custom message, only the attached statement

• Added support for GPG encryption when sending or receiving files using the EngageIP File Mover Service

• Added a new configuration setting called 'AlertInProgressLongerThanPeriod' which can be configured within service .config files and is used to diagnose if a service is functioning or if it has stalled on a task. This setting is time period specific (e.g. set to '15m', '1h', etc.) and once the time period specified has been reached EngageIP log files, thread states and database details will be collected and written to a stall-log file for review

• Improved performance loading Event Log data

• Modified rating service 'Flushing remaining UDR' log message to instead write 'Processed file: {fileName}, linecount: {rowCount}' and ensured that messages are only logged when a data source destination is specified

• Enhanced logging to indicate what action triggered rerating. Rerating entries in the Event Log will have a Module value of 'Rerating' and a Action value of 'Set User To Rerate'

• Added a new table to the database named CurrentBillingUsageInvoicer to track accounts that are currently billing

• Added a CreatedDate field to the UDR table. The created date is set when first rating a record at the start of the mediation process

• Added DateProcessed and DateRerated fields to the UDR table. DateProcessed is set after mediation, taxing and bucketing when the record is ready to be saved. DateRerated is set any time the record is rerated

Developer Notes

API Changes

• New Methods

  • DeleteUserAttributeSingleSignOnConfiguration: Deletes single sign on configuration for the supplied user. Returns success if the configuration is deleted, or if the user has no configuration

  • DisableSingleSignOnConfiguration: Disables single sign on for the user with the supplied federation id. The user must have a federation id configured or this will fail

  • EnableSingleSignOnConfiguration: Enables single sign on for the user with the supplied federation Id. The user must have a federation Id configured or this will fail

  • SetUserAttributeSingleSignOnConfiguration: Adds/updates single sign on configuration for the supplied user

• API Enhancements

  • The GetRenderedInvoiceXml and GetRenderedSnapshotInvoiceXml methods will now trigger the generation of invoice xml as this data is no longer persisted in the database

  • Improved UpdateService failure response messages to make the update failure issue clear

Permission Updates

• New Role Permissions

  • DataExportHistory (List)

  • JobSchedule (DisplayLastRun, DisplayNextRun)

  • OwnerSingleSignOnConfiguration (Delete, Edit)

  • UserAttributeDoNotRerate (Add, Delete, Edit)

  • UserAttributeSingleSignOnConfiguration (Add, Delete, Edit)

• Removed Role Permissions

  • Payment (Reverse)

9.2.0-Patch.1 Release Notes

• Modified owner configuration to support updating the Owner Parent Account Billing Type setting on unbranded owners

• Modified owner configuration to disallow editing of the Owner Parent Account Billing Type setting if undisbursed payments, credits or partial refunds exist on the owner/owner to be invoiced

• Modified the usage invoicer setting to be editable on accounts when the owner configuration is set to bill owner/bill branded owner

• Fixed an issue where UDR Taxing in SureTax environments would fail with an invalid invoice number error when the identifier sent to SureTax contained non-alphanumeric characters

• Fixed an issue where using the month forward or back buttons on pop-up calendars would trigger scrolling to the top of the page

• Fixed an issue where a static value was being checked for each UDR record processed, resulting in errors in the RatingService.log

• Fixed an issue where the JobService would schedule duplicate jobs if a job of the same type was in exception status

• Fixed an issue where attempts to resend email that had previously failed to send would fail again if the email contained attachments

• Fixed a Hosted Payment Page issue where the Countries list was empty when configuring a payment method for a user under an unbranded owner

9.2.0-Patch.2 Release Notes

• Fixed an issue where pagination links on lists could be hidden by a horizontal scroll bar when the browser zoom level was above 100%

• Modified bill group selection logic in tier sync environments. New accounts synced to the wholesale system will inherit their wholesale owner's/branded owner's bill group if the owner/branded owner is configured to be billed (Owner Parent Account Billing Type = 'Bill Branded Owner/Bill Owner..'). Otherwise, the synced account will be set to use the same bill group that it was configured with on the retail system. In the latter scenario, an error will occur if the bill group set on the retail system cannot be found on the wholesale system

• Fixed an issue with the GetUserInvoicers method returning the incorrect invoicer values

• Modified the Detail text field on the add payment page to permit a maximum of 255 characters (previously this was 355 characters)

• Fixed an issue with list provider values being cleared when editing profile questions/extended attributes if the list value contained special characters

• Fixed an issue with required user-package extended attributes not being set as required when performing a user-package upgrade

9.2.0-Patch.3 Release Notes

• Modified user-package upgrade logic to move resources and equipment from source user-packages to target-user packages by matching resource/equipment types instead of matching by service name

• Fixed an issue where optional services were displayed twice on the package upgrade page

• Fixed an issue where optional services were displayed in a nested format on the package upgrade page

• Fixed an issue where the remove button on the package upgrade page would remove all services

• Restored the missing Add Service option on the package upgrade page

9.2.0-Patch.6 Release Notes

• Error handling improvements

• Improved bill run performance by reducing the number of times price plan discounts are evaluated and applied

• Modified package upgrade logic to use the 'Default' quantity configured on optional user-services in the upgrade package to determine how many optional user-services to add to the upgrade user-package. Previously the number of user-services in the source package was used to determine how many optional user-services to create in the upgraded user-package

• Fixed an issue where adding a bucket to an account with multiple open usage periods could cause a bucket to span multiple usage periods

• Fixed an issue where the bulk creation of buckets would fail in error when the bulk insert job (UBRBillerBulkInsert) encountered deleted buckets with bucket ID's set to Null

• Fixed an issue where differing service tax types or service tax codes on accounts could cause usage charges to be applied to subsequent usage periods instead of the current usage period

• Fixed an issue where usage buckets were not created for active user-packages when the account the package's resided on was switched from a canceled status to an active status

• Fixed an issue where rating usage on a canceled account would open up a new billing period, resulting in usage being billed out in a post cancelation billing cycle

• Fixed an issue where canceling an account or user-package with the option "Immediately with prorated transaction as of a specific date" would result in UUIH entries being closed at the system's current time instead of the time supplied by the user

• Fixed a workflow issue related to the Event service which caused 'record not found errors' to occur