EngageIP Configuration Page Overview

Owned by Mahnoor Khan (Deactivated)
Last updated: Feb 22, 2023 by Greg Walsh
6 min read

Summary

This article describes the options and information presented on the Configuration page in the EngageIP AdminPortal.

The Configuration page provides access to the License key on your system, User and Owner limits and information on your SQL server and EngageIP Services. The Configuration page also contains various system wide configuration options for EngageIP.

Configuration Details and Options

The configuration page can be accessed by navigating to the root (highest level) owner clicking the Configuration link in the top right corner of the AdminPortal. The Configuration link will not be displayed unless you load the Admin account (the owner-user for the top-level owner in the system).

  • Name - the name of the product (read only)

  • Version - the EngageIP version number (read only)

  • Product Key - this is an encrypted license key provided by LogiSense which holds details about the company name, license limits, expiry dates and modules included. From here the licence key can be updated

  • User Count - the total amount of accounts/users currently in the system. User count includes Owner accounts. To validate/view active accounts load the Reports page and use the Accounts report to filter users by 'Enabled' User Status

  • User Limit - the total number of active users/accounts allocated to the installation (read only).

  • Owner Count - the total number of owners currently in the system (branded, unbranded and the root owner)

  • Owner Limit - the total number of owner accounts allocated to the installation (read only). Owner limit value includes the root owner

  • Expiry Date - when the product key will expire

  • Plugin Folder Path - path where library files can be found which provide additional system functionality

  • Domain Model Logging - if checked the Event Log will display all *.Create, *.Update actions taken in the database when they occur. Normally this option is not selected as logging to this extent can impact performance

  • Web GUI Logging - if checked the event log will display all web GUI interactions or account navigation

  • Event Log Retention Period - number of days to keep event log records. If drive space is not a concern 365 days is a good standard to follow, otherwise 90 days is the suggested minimum. Once the number of days has been reached the Event Manager service will purge the aged log entries at midnight

  • RADIUS Log Retention Period - number of days to keep RADIUS log records

  • Use System Status Level - this option (if selected) uses the system user statuses (Active, Canceled, Suspended). If unchecked custom statuses will be displayed

  • Maximum Grid Rows - this value allows you to specify how many rows to return on a list. By default, EngageIP will attempt to return a number of rows that fit the page length dynamically. You can set it to 10 for example or 20 to return that specific number of rows every time a list is loaded (you cannot use an entry lower than 10). Once you have modified this value you will need to perform an IIS Reset for the change to take effect

  • Set Due Date On Open Invoice - if unchecked this option will result in no due date being set on any newly created open invoice or reopened invoice. If an invoice does not have its due date set then the invoice's balance will not be added to the 'Balance Due' value for the account
    Note: The 'Aged Invoices Balance' Report provides information based on the Invoice Due date value, if you use this Report be mindful that the 'Set Due Date On Open Invoice' setting will effect the data that is presented within the report. See the article Aged Reports for more information

  • Audit Log Retention Period - number of days to keep Audit log records

  • Purge Account Name - if selected account names will be anonymized when accounts are purged from the account search screen. If deselected account names will persist as is (e.g. account names from purged accounts will still be displayed on previously generated data such as invoices)

  • UDR Biller Bulk Insert Archive Data Retention Period - 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

  • Show Consented Dialog On Hosted Payment Pages - if enabled a pop-up will appear in Hosted Payment Pages which will ask the user to consent to the collection of personal account holder data

  • UDRAmountPrecision (introduced in EngageIP 8.5.26.5) - specifies the maximum and default decimal precision amount that usage records can be rounded to (defaults to 4). For more information on amount precision behavior see the Setting up UDR Rate Groups, Rates and Rate Plans article. Configuration options exist to increase the amount precision up to a maximum of 11 decimals via back-end changes, contact LogiSense support if you require greater amount precision to be configured

  • Maximum Unbilled Usage Period (introduced in EngageIP 8.6.0) - this setting limits the number of months in the past that usage periods (UDRBillers) and buckets can be created. When creating buckets or billers the effective date of these objects will be restricted by this maximum period setting (i.e. a biller/bucket cannot be created further into the past than the maximum unbilled usage period value allows). The default value for the maximum unbilled usage period is 3 (months), but can be increased/decreased as desired. This setting should not be set above 13 months. Modifying this setting will not impact existing UUIH, billers or buckets in the system. Usage imported for periods prior to the maximum period here will be imported into current UDRbiller periods only up to the max usage period range

  • Tax Precision - 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 tax rates in the precision set here

  • Commission Pay Type - this field will be present if your installation has the Commission module enabled. It allows you to define when commission is paid out to an agent (when billing occurs or when payment is made).  For more information see the Commission Module article or contact us at sales@logisense.com

  • Batch Taxing On Usage - this option enables usage taxation to be handled in batches to improve system performance. A Windows Service named 'EngageIP UDRBatchTax Service' handles batch usage taxing operations, attempting to process pending taxes every 30 seconds (this polling time is configurable in the EngageIP\Services\UDRBatchTaxService.exe.config file). UDR batch tax processing is multithreaded, the MinThread and MaxThread values can be set in the UDRBatchTaxService.exe.config file. The UDRBatchTax Service also purges old tax data in a process pending state should the data exceed a certain age (UDRBatchPendingTaxRecordRetentionPeriodInDays is set to 365 days by default, but this value can be changed in the .config file). See the Avalara AvaTax Cloud Integration article for more information on batch taxing

System Check Information

This section provides System Status Details, such as:

  • Product Key - indicates if the system has a valid product key installed

  • EngageIP Services (various) - indicates if EngageIP Windows Services are running or not.  See the EngageIP Windows Services Overview article for more information on EngageIP Services

  • Scripts - indicates if custom or predefined scripts are functioning properly

  • Custom Code - indicates if custom code is functioning properly

  • SQLServer - indicates if the SQL Service is running, configured properly and up to date

  • SQLServer Memory - provides server memory usage stats

  • Integration health information such as whether the BillSoft EZTax integration (if in use) is working

  • Branding errors or items that may need attention

  • Jobs - indicates if the Job Service is running and if any Jobs are queued

Updating Your Product Key

If your key will expire soon on production environments, LogiSense will reach out either with a new key, or simply add a new key for you. If a key on a development server is expired, you can simply copy it from your production environment and use the same one.

Steps: 

  1. On production, go to top owner account, usually 'Admin'

  2. Click 'Configuration' link in the top right corner of the screen

  3. Select the whole key and copy it

  4. GO to the same top owner configuration link on the test / dev system

  5. Paste in the key

  6. Click Save

  7. Verify that the expiry date is accurate / as expected

  8. Proceed and use EngageIP as normally