Release Notes - v8.6.x

Owned by Mahnoor Khan (Deactivated)
Last updated: Sept 23, 2021 by Greg Walsh
21 min read

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.

8.6.0 Release Notes

Notice: Usage Invoicer and UUIH functions will not operate properly in EngageIP 8.6.0 without updating UUIH Workflow custom code. If you are performing your own EngageIP installation please contact LogiSense Support prior to installing EngageIP to obtain an updated UUIH Workflow.

LogiSense Support  

email: support@logisense.com

phone (Canada): 1-519-249-0508

phone (USA): 1-917-410-3584

Change Highlights

  • Bill Run Changes:

    • The 'Billing' option on bill runs is now named 'Bill Packages'. Unlike the old 'Billing' option 'Bill Packages' will not bill usage, only one-time or recurring user-package charges will be billed when this option is set

    • The 'Bill Usage Only' option is now named 'Bill Usage'. This option will observe the usage bill day defined on the 'Usage Billing Frequency' account component. See Usage Billing Changes below for more information on this component

    • Added the options 'Start Email Message' and 'End Email Message' to the bill run screen which allow you to send notification emails to an owner contact when a bill run starts or finishes

    • See the Bill Run Configuration article for more information on these settings

  • Usage Billing Changes:

    • Every account in EngageIP will display a 'Usage Billing Frequency' component

    • The Usage Billing Frequency component determines when usage will be billed and by default will be configured to 'OnMyBillDay' to bill usage when user-packages are billed

    • The Usage Billing Frequency component prior to this release was known as the 'Usage Billing Type' component. Any account setup with the 'Usage Billing Type' component will maintain their component configuration when they are updated to the Usage Billing Frequency component in EngageIP 8.6.0

    • For more information on usage billing changes and configuration see the Usage Billing Configuration KB article

    • Added a new option to the Configuration page called 'Maximum Unbilled Usage Period'. This setting restricts which usage records will be processed based on their age, preventing old usage from being accidentally processed. The system default for this value is 3 months, but it can be modified as needed. See the EngageIP Configuration Page Overview for more information
      Alert: Usage Next Bill Date is not reset when voiding an invoice. If you need to reset the the Usage Next Bill Date you will need to edit the Usage Billing Frequency component on the usage invoicer account and manually change the date. For more information on voiding invoices see the Managing Transactions – Debits, Credits, Refunds, Void / Voiding Invoices on Accounts article

  • Bill Group and Invoicer Changes:

    • Accounts must be in the same bill group as their invoicer and usage invoicer

    • New accounts will be set to the same bill group as their owner if the owner's 'OwnerParentAccountBillingType' is set to a 'Bill Owner.../Bill Branded Owner...' option

    • Invoicer options on an account's tools tab will be read-only if the account is under an owner that is setup to be billed (i.e. 'OwnerParentAccountBillingType' is set to a 'Bill Owner.../Bill Branded Owner...' option)

    • See the Bill Group Configuration and Invoicer Configuration articles for more information

  • Bill Day Changes:

    • An account's bill day must be in sync with the bill day of the account's invoicer

    • An account's bill day will be a read-only value if that account is not its own invoicer

    • Changing the bill day of an account setup as an invoicer will update the bill day of all accounts configured to use that invoicer. This bill day change is propagated down via an EngageIP job

  • UDR Bucket Changes:

    • UDR Bucket and UDR Biller Creation Changes:

      • A new EngageIP job called 'UDRBillerBulkInsert' will create all buckets and back-end billing objects (UDR Billers) as needed in EngageIP

      • The UDRBillerBulkInsert job will run each day at 1:00 am but can be rescheduled to run at a different time if desired

      • When the scheduled UDRBillerBulkInsert job runs it will determine if any billers or buckets need to be created over the next two days, if so those billers and buckets will be created

      • The UDRBillerBulkInsert job is also triggered when creating a UUIH. Typically UUIH.Create events occur when adding a user-package, although where UUIH creation happens depends on your particular EngageIP implementation

      • Buckets will no longer be created during billing, the UDRBillerBulkInsert job will handle this task before billing runs

    • Bucket effective and expiration dates have new restrictions to prevent invalid configurations. See the Enhancements section below for details on specific changes

Enhancements

  • Modified the EngageIP installer to attempt to restart EngageIP Windows Services if they should fail. Restart attempts will occur only twice, no further action will be taken after that

  • Added a back-up option to the EngageIP installer which will copy all of the contents and subdirectories of the EngageIP directory. This feature does not back-up the EngageIP database

  • Improved user-package cancelation performance in the AdminPortal and via API methods

  • Improved re-rating performance

  • Added support for 19 digit credit card numbers with Visa and JCB

  • Added pre-authorization support for credit card tokens. This feature operates identically to current credit card pre-authorization functionality

  • Added an EngageIP Option called 'Auto Disburse Credits'. When this option is set to 'false' credits generated as a result of user-package cancelation will not be disbursed. If this option is true or is not set at all then credits will be disbursed (the default system behavior)

  • Added an 'Undisburse' option on the Invoices tab > Credit Notes section. This option will remove all credit disbursements associated with the selected credit note

  • Modified user-package update logic to re-evaluate price plan threshold values when updating a bulk package's bulk quantity value

  • Fixed an issue where an exception would occur when editing a default credit card payment method if pre-authorization failed. Now if pre-authorization fails during editing the user will be prompted asking if they still want to save the credit card number

  • Fixed an issue where optional services on an account would fail to bill after voiding an invoice on the same account

  • Modified payment logic so that deposits made through a payment processor are not tagged with an InvoiceID. This prevents deposits from appearing in the payments section on invoices [ticket:103203]

  • Fixed an issue with account cancelation where selecting the cancelation option 'Immediately With No Transaction' would still result in service and usage transactions for periods between the package's effective date and the account cancelation date

  • Fixed an issue where usage would not be billed out when canceling the last remaining user-package on an account using the cancelation option 'Immediately With Prorated Transaction'

  • Fixed an issue when canceling a user or user-package using the 'As of' date option. Previously the date used to determine when to close the UUIH entry was the proration date and not the package cancelation date

  • Fixed an issue where the bill run close type 'After Each Bill Run' was not closing usage invoices if the billed account was a sub-account configured as the usage invoicer

  • Fixed an issue where an invoice was being sent when the invoice configuration 'No Charge Invoice Delivery Type' setting was configured as 'Only If Usage Exists' and no usage existed

  • Added an error message that appears during invoice closure if the account's payment day is not defined

  • Fixed an issue where the 'Bill To' country value passed to Vantiv payment gateways would default to Canada or United States regardless of the country the user entered

  • Modified TaxLog to capture details on reversed credits in AvaTax and SureTax integrated environments

  • Modified the Copy Package functionality to copy all package components, which includes Sync disable, PostPaid, Full Period Billing, Invoice Detail, Credit Card Auth Only and Profile Question answers which were not previously copied

  • Fixed an issue where greater than and less than characters entered in the name field of a quantity component were treated as tags, malforming the component name on accounts

  • Modified contract remainder calculation logic to use the user-package next bill date when the user-package is canceled with the option 'Immediately With No Transaction'. This ensures the proper remainder period is calculated. Selecting other user-package cancelation options will continue to reference the canceled date

  • Modified the user-contract configuration so that 'Day' is not an option for the contract term or renewal term BaseTimeUnit

  • Modified the 'Make SubAccount of New Parent' feature to move all usage related data to the new parent

  • Fixed an issue with the Tools > 'Make SubAccount of New Parent' function which permitted the current account to be moved to itself

  • Modified the audit log to track the cancelation type selected when canceling a user-package or user-services

  • Modified logging to include the process id and machine name when EngageIP Windows Services are started or stopped

  • Modified the event log to include an InvoiceID on CloseInvoice events when the InvoiceCloseType is set to 'After Each Bill Run'

  • Improved fraud related logging in the event log to clearly indicate that the logged message originated from the fraud service

  • Provided more detail in the event log when performing usage billing operations

  • Added 'AutoPay' and 'BillRunCollectionType' details to the Payment Decline report

  • Modified custom report functionality so that hyperlinks are presented for UserID, UserPackageID and UserServiceID data if these fields are present on the report. UserPackageID and UserServiceID will only be hyperlinked if the EngageIP user has UserPackage Edit and UserService Edit permissions

  • Added the ability to hyperlink data on custom reports to predefined URLs

  • Reduced load time of owner reports

  • Reduced load time of the Contract Forecast - Package report

  • Modified Aged Invoice reports to ignore payment disbursements that are older than the date selected when running the report

  • Modified Invoicer configuration so that changing the Usage Invoicer on an account will result in all unbilled usage being billed to the new usage invoicer on their next bill cycle

  • Modified Tools > Invoicer configuration so that canceled accounts are not selectable

  • Modified Tools > Usage Invoicer configuration so that a sub-account cannot be a usage invoicer of its parent account

  • Renamed the 'Base Unit' field to 'Base Time' on pages that use it (CreatePackage, UpdatePackage, CreateService, UpdateService, CreateUserPackageContract, AddUserPackageAttributeBillingItem, UpdateUserPackageAttributeBillingItem and CreateUserContract). Also removed the need to enter day, hour or minute values into the Base Time field

  • Fixed an issue where the next bill date on user-packages would not reset after voiding an invoice if the user-package contained only one-time services

  • Added 'Effective Date' and 'Expiry Date' fields to the Invoice Discount component page, allowing you to control when a discount begins and ends

  • Modified the user-package effective date field to only accept a date value instead of a date and time. The time will default to midnight (00:00:00) in order to align with bucket periods and prevent usage billing or bucketing issues

  • Added restrictions to the user-package effective date to prevent invalid configurations which could cause usage/bucketing issues. User-package effective dates can no longer be set to a future date or a date within a closed financial period. Editing a user-package effective date after it has been set is also no longer possible

  • Added a restriction when canceling a user-package preventing the cancelation date from being earlier than the user-package start date

  • Added a restriction when adding an optional service to a user-package which prevents the optional service effective date from being earlier than the user-package effective date

  • Fixed an issue where it was possible to change the effective date on existing optional user-services

  • Added restrictions when adding a UDR bucket to a user-service which prevents the bucket effective date from being earlier than the user-package effective date or set to a date within a closed financial period

  • Modified bucket configuration so that the 'Effective Date' and 'Expire After' fields will use a Year-Month-Day format instead of a Year-Month-Day-Hour-Minute-Second format. Existing buckets configured with the old format will be evaluated based on the Year-Month-Day values entered. Any Hour-Minute-Second values previously entered will be ignored

  • Disabled the ability to modify an existing user-bucket's Effective Date, Prorate value, UDR Bucket Type, UDR Bucket Refill Type and Expire After date. Changing these values after a user-bucket is added is not supported

  • Disabled the ability to modify the Amount (dollar value) of a monetary bucket once the bucket is added to a user-service

  • Modified an account's usage billing period to start based on the user-package effective date instead of using a bucket's effective date. This prevents issues with usage being bucketed when it should not be (applied to a bucket that is not effective yet)

  • Fixed an issue where the changing the UDR Bucket Pool Level Type on a UDR bucket did not modify the pooling level set for on the current periods bucket, resulting in the old pooling level remaining in effect [ticket:88783]

  • Fixed an issue where some usage could be pushed into a future period when canceling a user-service that contained a bucket, resulting in unbilled usage [ticket:89959]

  • Fixed an issue where a usage bucket pooled at the parent level would persist when canceling a sub-account or a user-service on a sub-account with the option 'Specific Date With Prorated Transaction'

  • Fixed an issue where an exception would occur when bucketing usage if the terminating identifier was set to '/Everywhere' and the UDR Bucket detail was configured with a UDR Location of /Everywhere

  • Fixed an issue where non-recurring buckets added after usage occurs would have incorrect expiry dates in future usage periods

  • Fixed an issue where removing an expiry date on a bucket in the AdminPortal would fail to remove the expiry date in the database in some scenarios

  • Fixed an issue where changing the UDR Bucket Pool Level Type setting on a user-bucket that was configured to prorate would trigger proration to occur and calculate an incorrect remaining amount for the bucket

  • Fixed an issue where canceling a recurring with rollover bucket which was configured to prorate resulted in the proration of rollover usage from another recurring with rollover bucket, which was also configured to prorate but attached to a separate package on the same account

  • Added a restriction preventing recurring or recurring with rollover buckets from being added to a one-time service

  • Removed the ability to set an expiry date on a recurring bucket

  • Modified bucket proration to use the user-package frequency (or user-service frequency if it is less than the user-package frequency) to determine the prorated bucket amount. Previously a monthly frequency was used which could cause an incorrect bucket amount when prorating weekly or annual buckets

  • Fixed an issue where a sub-account containing an annual package with a bucket had a duplicate bucket generated when a monthly package without buckets was added to another sub-account underneath the same parent account

  • Modified the rating engine to handle rating multiple months of bucket usage per parent account loaded in memory

  • Addressed a rating performance issue which occurred when applying usage to buckets configured with a UDR Location

  • Fixed an issue where an additional UDR rate was not applied in some scenarios if the additional rate was processed by the rating engine first, before the matching UDR rate that it was supposed to be applied on top of was processed

  • Modified the Base UUIH Workflow to close UUIH entries when an optional service is canceled

  • Disabled the ability to add or edit UUIH's on the Setup tab

  • Modified bucket logic to round amount (monetary) user-buckets by the configured UDRAmountPrecision value instead of using two decimal places

  • Removed the 'Usage Billing Sync' package component as usage billing functionality is now handled by the Usage Billing Frequency component

  • Modified bucket priority logic to include additional criteria. Buckets will be prioritized for consumption in the following order:

    • Pooling Level: of the available buckets user-service level buckets will be used first, then user level buckets and parent level pooled buckets last

    • Bucket Priority: the numerical value entered into the Service > UDR Bucket Component > Priority field

    • Expiry Date: the bucket that is set to expire first will be used

    • Bucket Refill Type: Nonrecurring buckets will be used first, followed by Recurring with rollover buckets and Recurring buckets selected last

    • Carried Forward Bucket ID: if the bucket has usage that is carried forward from a previous period (i.e. there are multiple Nonrecurring buckets or multiple Recurring with rollover buckets to choose from) the carried forward bucket with the lowest ID will be selected (the oldest bucket)

    • Bucket ID: select the bucket with the lowest (oldest) bucket ID

  • Added the ability to inherit owner settings from a branded owner when creating a new unbranded or branded owner. See the Configuring Branded and Unbranded Owners article for details

  • Modified options under the Setup tab > Owner > 'OwnerParentAccountBillingType' drop down list for better clarity. The 'Bill Top Owner' options are now listed as 'Bill Branded Owner'

  • Fixed an issue where usage transactions were not appearing on an account's transactions tab when the owner user was setup to be invoiced for usage charges (i.e. 'OwnerParentAccountBillingType' is set to a 'Bill Owner.../Bill Branded Owner...' option)

  • Renamed the 'Transfer to Other Branded Owner' option on the Tools tab to 'Transfer to Other Branded Owner/Owner' and extended its functionality to support moving accounts from any type of owner (branded/unbranded) to any other owner. Previously this feature only supported transferring an account under a branded owner to another branded owner

  • Added a new EngageIP option 'DoNotTransferSubAccountsOnOwnerTransfer' which can be added to the EngageIPOption table. If this option is present in the table sub-accounts will not be transferred to another owner when using the 'Transfer to Other Branded Owner/Owner' option on the Tools tab

  • Modified tier sync behavior to sync individual objects instead of attempting to sync large batch transactions. This reduces database locking and resolves performance and timeout issues

  • Reduced user-package and user-service sync time in tier sync environments

  • Improved tier sync related error handling and the level of detail logged for tier sync activities [ticket:103896]

  • Fixed an issue where changes to user-service profile answers were not being synced in tier sync environments

  • Fixed an issue with user-package sync in tier sync environments which caused the RefundOptionID to be populated when changing a user-package's status to another status with the same back-end status type

  • Fixed an issue with the bulk save feature failing to update all items in the list when attempting to bulk save updates to resource items [ticket:103750]

  • Fixed a hosted payment page issue where duplicate countries were appearing in country drop down fields

  • Fixed an issue where the fraud service was attempting to reference an existing transaction resulting in the service timing out

  • Modified fraud logic to retry calls to the real-time fraud service up to three times, logging each attempt. This will reduce the risk of timeouts preventing fraud notifications

  • Modified the country configuration on the setup tab to use a prepopulated 'Country ISO' list instead of the 'Country Code' text field

  • Extended webhook support to allow tokenized parameters to be attached to the URI and a security token attached to headers

  • Fixed an issue with valid data being flagged as invalid when dynamically adding rate groups

  • Fixed an issue with tickets introduced in EngageIP 8.5.27.1-Hotfix.4 where the description field width did not align with the comment field text box width

  • Modified CountryISO table to require unique country names

  • Added a new table called 'PaymentCreditDisbursementInvoiceHistory' which keeps a history of payment disbursements. Negative amounts in the table indicate a disbursement was removed/deleted

  • Added 'CreatedBy' and 'CreatedDate' fields to the UDRBiller and UDRBillerBucket tables for auditing purposes. Together these fields indicate which service was responsible for creating the bucket and when the bucket was created

  • Added a 'Canceled' field to the UDRBiller table. This field will contain a 1 (true) if the UDRBiller is no longer active (i.e. the last user-package on an account has been canceled). If this value is 0 then the UDRBiller is active and the biller will be processed by rating/billing

Developer Notes

API Changes

Notice: The EngageIP Webservice has been updated to be compliant with the WS-I Basic Profile. Some methods are renamed or deprecated as a result, please see notes below. This change will impact any processes using the EngageIP API and therefore full regression testing is required prior to upgrading to EngageIP 8.6.0 even if the legacy API endpoint is utilized

  • New Methods

    • CreateInvoiceDiscountNew: Creates an invoice discount for a user and returns the ID of the new discount

    • DisableUserPaymentMethod: Disable a UserPaymentMethod if it is not the default payment method

    • GetInvoiceDiscount: Returns configuration details on the specified invoice discount user attribute/component, throws an exception if the supplied invoice discount ID does not exist

    • UpdateInvoiceDiscountNew: Updates an invoice discount user-attribute/component, throws an exception if it does not exist

  • Renamed Methods

    • MakePayment -> MakePaymentNoCVV

    • CreateUser -> CreateUserWithCreatedByAndCreatedDate

    • AddPackageToUserWithOptionalServices -> AddPackageToUserWithOptionalServicesByDTO

    • AddOptionalService -> AddOptionalServiceWithPackageAttributeQuantityID

    • GetPackageAttributeQuantityID -> GetPackageAttributeQuantityIDByServiceID

    • GetWebhookActivities -> GetWebhookActivitiesByStatus

    • GetWebhookActivities -> GetWebhookActivitiesByDate

    • RequeueFailedWebhooks -> RequeueFailedWebhooksByIDList

    • PreAuthCreditCardToken -> PreAuthDefaultCreditCardToken

    • CreateTicket -> CreateTicketWithContactMethodID

  • API Enhancements

    • CreateUser, CreateUserWithExtendedAttributes, CreateUserWithExtendedAttributesandCreatedByandCreatedDate, UpdateUserBillingGroup and other methods that attempt to update invoicers (i.e. UpdateUserInvoicer) will return an error if the user and its invoicers are not in the same bill group

    • Modified UpdateUserInvoicer method to return an error if the target user exists under an owner configured to receive the invoice ('OwnerParentAccountBillingType' is set to a 'Bill Owner…/Bill Branded Owner…' option)

    • Modified UpdateUserBillDay to return an error if attempts to update the account's bill day are made and the account is not configured as its own invoicer

    • The following methods will no longer be permitted to set user-package effective dates to a future date, a date within a closed financial period or modify the user-package effective date after it has been set:

      • AddOptionalService

      • AddOptionalServiceWithDefaultEquipment

      • AddOptionalServiceWithPackageAttributeQuantityID

      • AddPackageToUserWithBillNowWithExtendedAttributesWithBulkQuantityAndNextBillDate

      • AddPackageToUserWithExtendedAttributesWithNextBillDate

      • AddPackageToUserWithNBDWithBillNowAndSyncBillDateAndUPStatusType

      • AddPackageToUserWithNBDWithBillNowAndSyncBillDateAndUPStatusTypeAndExtendedAttributes

      • AddPackageToUserWithNextBilldate

      • AddPackageToUserWithNextBilldateWithBillNow

      • AddPackageToUserWithNextBilldateWithBillNowAndSyncBillDate

      • AddPackageToUserWithNextBilldateWithBillNowWithBulkQuantity

      • AddPackageToUserWithNextBilldateWithBulkQuantityAndUserPackageStatusType

      • AddPackageToUserWithNextBilldateWithDefaultQuantityService

      • AddPackageToUserWithOptionalServices

      • AddPackageToUserWithOptionalServicesByDTO

    • 'baseTimeUnit' from the following APIs no longer take day, hour and minute values: CreatePackage, UpdatePackage, CreateService, UpdateService, CreateUserPackageContract, AddUserPackageAttributeBillingItem, UpdateUserPackageAttributeBillingItem, CreateUserContract (+ renewalBaseTimeUnitTypeName). These methods continue to accept once, week, month and year values

    • Fixed an issue with GetTaxEstimation calculating the incorrect taxable amount when the taxed service was configured with a discount type of Price or Percent

    • Fixed an issue with GetTaxEstimation where the supplied pcode in the call would be not be used if a pcode was already configured on the account

    • Fixed an issue where the CreateUser method would still create a new user even if an error was generated

    • Updated MakePaymentOneTimeCreditCardToken method to log activity to the Audit Log

    • Updated TransferUserToAnotherBrandedOwner method to support transferring accounts between branded and unbranded owners

    • Modified XMLImport method to check for an Owner attribute on _ExtendedAttribute type options and fail if an owner has not been provided, or the owner cannot be found

  • Deprecated Methods
    Note: the following methods are deprecated and have been moved to the Legacy Webservice. These deprecated methods have an alternative API that can be used (typically the same method name but with a different set of parameters)

    • MakePaymentOneTimeCreditCard

    • MakePaymentOneTimeCreditCardDto

    • MakePaymentOneTimeCreditCardWithCVVDto

    • MakePaymentOneTimeCreditCardWithFee

    • MakePaymentOneTimeCreditCardWithCVV

    • MakePaymentOneTimeACH

    • AddPackageToUserWithExtendedAttributes

    • AddPackageToUserWithNextBilldate

    • AddPackageToUserWithNextBilldateWithBulkQuantity

    • AddPackageToUserWithNextBilldateWithBillNow

    • CreateInvoiceDiscount

    • UpdateInvoiceDiscount

    • CreateStatementDetails

    • CreateTicket

    • CreateTicketWithTicketTypeandSubcategoryAndContact

    • CreateTicketWithExtendedAttributes

    • CreateTicketWithExtendedAttributesWithTicketType

    • CreateTicketWithAttachment

    • CreateTicketWithAttachmentWithTicketType

    • UpdateTicketWithAttachment

    • UpdateTicketWithAttachmentAndExtAttributes

    • getPackageAmountFromServices

    • getPackageDiscounts

    • GetServicesFromPackage

    • UpgradeUserPackage

    • UpgradeUserPackageWithEffectiveDate

    • UpgradeUserPackageOptionToBillOneTimeService

    • UpgradeUserPackageOptionToBillOneTimeServiceWithEffectiveDate

    • CreateUserPaymentMethodCreditCard

    • CreateUserPaymentMethodCreditCardWithPreAuthorization

    • UpdateUserPaymentMethodCreditCard

    • AddUserServiceDiscount

    • AddUserServiceDiscountSkipProrate

    • AddCountry

    • AddState:

    • AddStateNoSortOrder

    • AddCounty

    • AddCity

    • AddCityNoCounty

    • AddCityNoCountyNoSortOrder

    • AddCityNoSortOrder

    • getPackageAmount

    • getPackageTaxAmount

    • CreateUserNote

    • AddUserAttributeTaxExemptLevels

    • GetListOfAuthonlyTransactionID

    • CreateUserPaymentMethodCreditCardToken

    • CreateUserPaymentMethodECheckToken

  • Removed Methods

    • GetBillingPeriod

    • GetCurrentBillingPeriod

Custom CodeChanges

  • Fixed an issue where the custom code compiler did not exclude the classes within an existing version of custom code when updating the custom code, resulting in a duplicate classes error

  • Added the ability to display a footer message on custom reports using custom code

Permission Updates

  • New Role Permissions

    • OwnerParent (GetTemplateOwner)

    • WebhookRegistrationHeader (Add, Delete, Edit)

  • Removed Role Permissions

    • PackageAttributeUsageBillingSync

8.6.0-Hotfix.1 Release Notes

  • Modified EngageIP installer to cleanup old library files in the AdminPortal/bin folder

  • Modified cancelation logic for billing out usage when the last user-package on an account is canceled. Going forward the parent account will be also be checked to see if active user-packages exist, if they do exist then unbilled usage charges will not be billed

  • Modified UDR Rate configuration so that the UDRLocationGroup value does not get auto-populated

  • Modified statement details date to subtract a second from the statement period end date so that the statement details date range does not extend into a new billing period

  • Fixed a caching issue which caused changes to the default user-package status type to have no effect until an iisreset was performed

  • Fixed an issue where mediation exceptions were being counted by the rating engine when logging UDR processing statistics

  • Fixed an issue in tier sync environments where the tier sync activity value would not switch to pending after updating parent and child role profile answers, resulting in profile answers failing to sync to the reseller system

  • Removed the restriction introduced in EngageIP 8.6.0 which prevented user-packages and user-buckets from having an effective date within a closed billing period

  • Fixed an issue introduced in EngageIP 8.6.0 where the bulk insert job would return an exception when attempting to create bucket on a user-service with an amount value in years (1Y, 2Y, etc.)

  • Removed invalid permissions FormatReplacementValue and UpdateEditFields added in EngageIP 8.6.0

  • Reverted a change made in EngageIP 8.6.0 which caused the AddPackageToUserWithNextBilldate, AddPackageToUserWithOptionalServices and
    AddPackageToUserWithNextBilldateWithDefaultQuantityService methods to require case sensitive parameter names

8.6.1 Release Notes

Change Highlights

  • Time period specific buckets:

    • Added the ability to configure a time period on buckets. Buckets configured to a specified time period will only be deducted from during the specified time period (e.g. evenings, weekends, etc.)

    • See the UDR Buckets article for more information

  • Connection charges:

  • Rating/bucketing past usage for canceled packages/services:

    • Modified the rating engine to rate and bucket past usage for canceled packages and optional services. Usage found which occurred prior to cancelation will trigger biller/bucket creation if required. Buckets created for this purpose will expire quickly (61 seconds) so that only past usage is bucketed

  • Added Job to create future buckets:

    • Removed restrictions that did not allow user-packages and user-buckets to be set with future effective dates. A new job called FutureUDRBillerBulkInsertJob will run daily evaluating user-packages and creating billers and buckets for user-packages/user-buckets if their effective dates are three days into the future

  • File upload and custom processing:

    • Added the ability to upload files in the AdminPortal and execute jobs (custom code) to process the file. This feature can be used to execute any file processing you require, e.g. as another method to process usage files. The upload interface can be found under the Tools page / 'File Processing Upload'

    • Reports with file upload details can be found under the Reports tab > FileProcessing heading (if the proper role permissions are enabled to view them)

Enhancements

  • Improved autocomplete search performance in drop-down lists

  • Restored the ability to create services with a Base Time value of Day

  • Removed restriction that prevented optional services from having an effective date in the future

  • Improved error messaging when attempting to add a service with a duplicate name

  • Fixed an issue where services configured with a base time of 'Day' would not have postpaid charges applied accurately when billing beyond the end of a month and for fewer days then a full monthly period [ticket:104826]

Developer Notes

API Changes

API Enhancements

  • Fixed an issue introduced in EngageIP 8.6.0 which caused the CreateUserPaymentMethodCheck method to return an invalid payment type error when attempting to create an ACH payment method

Permission Updates

  • New Role Permissions

    • FileProcessingHistoryDetailReport (List)

    • FileProcessingHistoryReport (List)

    • FileProcessingType (Add, Delete, Edit, List)

    • FileProcessingUpload (Upload)

8.6.1-Hotfix.1 Release Notes

  • Fixed an exception that would occur when a rate group condition evaluated a udr record string field which contained a null value

  • Modified udr biller and bucket creation to be handled by core code instead of the EngageIP Job Service to ensure buckets and billers are created in the event the job service is not running

  • Added a new setting 'UDR Biller Bulk Insert Archive Data Retention Period' to the Configuration page. This setting controls how long historical data is kept regarding when udr billers and biller buckets were created. By default this historical data will be kept for 365 days

  • Modified the UDRBillerBulkInsert job to create initial period buckets for non-recurring buckets when the non-recurring bucket effective date is four or more days into the future

  • Fixed an issue where a user-service with a non-recurring bucket and a billing frequency of once had a bucket created for each billing period

  • Fixed an issue introduced in EngageIP 8.5.27.0 where profile questions configured as required and with the 'Select From List' setting enabled would append the string "-Required" to the final item in the Options list

  • Fixed an issue where selecting a user-package's effective date using the calendar could result in the Save button being disabled in some scenarios

8.6.1-Hotfix.2 Release Notes

  • Added the ability to rerate UDRs in batches to address rating exceptions that can occur if too many usage records exist to rerate. The default UDR batch size is 1,000 UDR billers, but the ReratingBatchSize value is configurable in the rating service config file

  • Improved event and error logging in NetSuite integrated environments

  • Fixed a credit note creation error in NetSuite integrated environments which occurred when sending credit note transaction data to NetSuite

  • Fixed an issue with Aged Invoice reports failing to filter out invoices that had a due date greater then the date entered

  • Fixed an issue with the Aged Invoice Detail report where disbursements were being factored in after the 'as of date' resulting in an incorrect balance result

  • Fixed an issue with the Aged Invoice Balance report where an account could be listed multiple times depending on the Owner configuration in EngageIP

8.6.2 Release Notes

Enhancements

  • Removed the ability to change a user-package's status after the package has been set to a canceled status

  • Modified voiding behavior so that the Usage Billing Frequency component's Usage Next Bill Date is reset when voiding an invoice

  • Added an alert message that appears when saving a bill run if the 'Bill Usage' option is not checked and the 'Bill Packages' option is selected. This is intended to prevent scenarios where packages are billed but usage is mistakenly left unbilled

  • Fixed an issue where applied discount amounts were not being displayed on accounts under the the Invoices tab > Invoices list > Discount field

  • Fixed an issue with usage credits (UDR Credit) where tax was not being calculated on the credit

  • Added 'Usage Next Bill Date' data to the Accounts, Account Services and User Package reports

  • Fixed an issue with Aged Reports where details after the user specified report date were being displayed

  • Fixed issues with the Aged Invoice Balance and Aged invoice Detail Reports that resulted in incorrect amounts in the Total, Current, Discount and period fields

  • Fixed an issue where the Aged Invoice Balance report would report an incorrect number of results when modifying the due date on the report

  • Renamed the 'Total' field on the Aged Invoice Balance Report to 'Total Overdue' for better clarity

Developer Notes

API Changes

New Methods

  • GetUserInvoicers: Gets an account's invoicers

  • GetUserUsageBillingFrequency: Gets an account's usage billing frequency

  • UpdateUserInvoicers: Updates an account's invoicers

  • UpdateUserUsageBillingFrequency: Updates an account's usage billing frequency

Permission Updates

  • There were no permission updates in this release

8.6.2-Patch.1

  • Modified AvaTax integration to log multiple tax override attempts as Info messages instead of Errors as no failure to apply tax overrides occurs

  • Fixed an issue where user-bucket's period end dates would not update when the account bill date was modified [ticket:109480]

  • Modified the Audit Log to truncate messages in the From and To fields in order to display entries that exceed 255 characters