Available Package, Service and Account Components

Summary

This article provides links to the different components available on Packages, the Overview page (at the user level) or added to Services. This is not an exhaustive list however as some components can be custom made and therefore may also show up as components in your installation.

You may not see certain components listed below due to your EngageIP configuration (i.e. version of EngageIP or EngageIP modules installed).

'User' denotes a component available at the user/account level. Package and Service components listed without the prefix 'User' are configured on the Setup page under the Product Catalog section. Depending on your role permissions you may not have access to the Setup page.

Account/Overview Components

• Change User Package Status - this component allows you to set a date for when a package's status should change. For example, if you would like to cancel an account’s package at the beginning of September then you could create a Package Status event to trigger the package to be cancelled on that date. Once the Package has been cancelled on the date specified, the status will be removed from the Components list on the account’s overview screen
  Note: Prior to 8.5.27.x, the EngageIP Event Service processed user package status changes. Restarting the Event Service would result in user package status changes being processed first (moved to the top of the queue). As of EngageIP 8.5.27.x and higher versions the EngageIP Job Service processes user package status changes once per minute (this schedule is shown on the ExecuteUserPackageStatusChange job in the JobSchedule table). In the event the EngageIP App Server is busy (multiple workflow events or jobs are running) the ExecuteUserPackageStatusChange job may be delayed and run less frequently than once per minute

• Change User Status - this component allows you to set the status of an account on a specific date. For example, a customer calls and requests that their account be temporarily disabled for the month of July as they will be on vacation. To do this you would add two Change User Status entries on the account, the first will change the status of the account to Disabled on July 1st and the second will change the account’s status to Enabled on August 1st

• Do Not Rerate - introduced in EngageIP 9.2 this component allows you to prevent rerating on accounts when a user-package/user-service is added or canceled. Adding this component at an owner or parent account level is supported and will pass the rerating configuration on to all accounts under the owner/parent. As of EngageIP 9.3.4 there is also a 'Disable All Auto Rerate Events', which when set will disable rerating events that are added by the system (i.e. make rerating a manual process for the account or accounts in question). When 'Disable All Auto Rerate Events' is set on an account all other accounts using that account as their usage invoicer will have rerating disabled as well

• User Contract - the User/Account level contract component allows you to put multiple packages on an account under a single contract. In addition to the package level contract features the User Contract supports automatic renewal of the contract, a threshold control which determines if cancelation charges are applicable and the ability to apply a minimum invoice charge

• Invoice Discount - this is an option that allows you to discount an invoice by a set amount, or allow tiered discounts based on purchasing power or orders for example

• Lockout - this component allows you to lockout an account (prevent logging in to the EngageIP AdminPortal) for a specific period of time. Once the lockout period has passed the component is automatically deleted from the account

• Note - this component allows agents to create notes which are displayed on the Overview page of an account

• Schedule - this component allows you to specify a schedule that a technician/installer is available to be assigned to work orders

• Account Tax Category - Account Tax Categories work in conjunction with the tax codes specified in the system and allow you to distinguish account level attributes for determining taxes. Adding a tax category to an account provides the ability to allow a different tax rate to be applied for accounts within the same or surrounding geographic location or residential versus business accounts

• Price Plan - this allows you to bulk add discounts to multiple services on a customer account and its sub accounts

• Tax Code - this component allows you to specify which tax code is applicable to the account (and corresponding the tax rates for the given code/region)

• Tax Exempt - this component will exempt the user from all taxes, including taxing on usage

• Tier Sync - this component is needed in a Tier Sync environment to sync the owner account from the reseller system to the wholesale system along with all its accounts

Package Components

The following Components are available to be added to a Package at the product catalog level (on the Setup page) and/or at the User-Package level (to a package on a user/account).

Components Available at the Package and User-Package Level

• Contract - allows you to add a contract to a package. If a package is canceled prematurely for example you can configure this to apply a penalty to the user as a percentage or the full fee of the package

• Discount - this allows out increase or decrease the price of a package at the setup page level or user level (price override)

• Service Contract - allows you to put a particular service within the package under contract

• UDR Rate Plan - this component adds a rate plan on packages (EngageIP UDR system specific component)

• Usage Rate Plan - this component adds a rate plans / buckets on packages (EngageIP CDR system specific component)

Components Available at the Package Level Only

• Bulk Package - this allows adding a package with a predetermined quantity. So to add 100 units of package x, you would set this at the setup page level and instead of adding it 100 times, it will just multiply the package value by that many times

• Credit Card Auth Only Component - this component allows you to tag a package so that when a customer signs up for this package the system will authenticate the credit card first before allowing the customer to sign up

• Full Period Billing - When this component is added to a package, prorating will not occur, user-packages will be billed for their full period without prorated charges. If the package is canceled, no refund will be added. Similar to ‘Sync Disable’ (detailed below) component this also will disable bill date synchronization for this package and it will bill on the effective day each period going forward.

• Invoice Detail - this allows you to specify text that can be displayed on the invoice. Your invoice template needs to be configured to display this value

• PostPaid - configures a package to bill for the period prior to the current period

• Profile Answer / Question Component - this component allows you to add a profile question to a package and populated with an answer on the user account when adding a package to the account

• Quantity / Optional Services Component - this allows you to configure a package to be dynamic and allow you to add or remove specific services as needed based on quantity or billing requirements

• Resource - allows you to attach a virtual asset to a package (IP Address, DID, etc.). Only applicable to environments with the Resource Management Module enabled

• Sync Disable - allows a user-package to bill independently of the account's Bill Day. Prorated charges will not result when adding a sync disabled user-package as no partial period needs to be billed to sync up to the account bill date

• Tier Sync - configured on an owner’s account in a Tier Sync setup (two instances of EngageIP, one a wholesaler system and another a reseller system). This component tells EngageIP that you want to sync the account from the reseller system to the wholesale system along with all accounts under the owner

• TransferDefaultPackage - sets a package as the default package to be created when package names do not match during account transfer to the owner (account transfer is done via Tools > 'Transfer to Other Branded Owner/Owner'). When an account is transferred its user-packages are compared against the packages in the target owners product catalog, if the package names do not match then a check is performed for a package that contains the profile question 'TransferDefaultPackage'. If this profile question is present all unmatched packages from the account being transferred will be converted over to the default package when the account is transferred to the new owner. If the package names do not match and there is no package with the 'TransferDefaultPackage' profile question in the destination owner's catalog then unmatched user-packages on the transferred account will not be created when the account is transferred to its new owner

• Upgrade - this allows you to configure the upgrade path on a package. i.e. it allows you to upgrade package x to package y and z (or downgrade as well)

Components Available at the User-Package Level Only

• Additional Billing Item - allows a one time or recurring service associated to a user-package but billed independently of that user-package

Service Components

Components Available at the Service and User-Service Level

• Radius Attribute - this component allows radius attributes to be specified for the service in question (timeout, bandwidth configuration, etc.) and passed to the Radius server

• UDR Bucket - this component allows you to add UDR Buckets to services so that you can provide pooling or included time, data, or events. For example, an account’s service could include a UDR bucket which provides 1 GB of data for the service in question

Components Available at the Service Level Only

• Commission Type - when this component is added to a service you can specify a commission type to pay out to a sales agent (for example a commission type of 'hardware', 'one-time', etc.). To use commission type you must have the Commission Module enabled in EngageIP

• Cost - this component does not affect billing, it is used as a reference tool to allow you to report on your cost of the service versus total revenue

• General Ledger - this component allows you to attach your predefined general ledger (GL) codes to services for accounting purposes

• Inclusive Taxes - causes taxes to be calculated within the set price of the service in question. This component is only functional in AvaTax integrated environments

• Invoice Detail - this allows you to specify text that can be displayed on the invoice. Requires that your invoice template is configured to display this value

• Invoice Group - this component adds a category name to the service so that the category name can be used in invoice XML (for example to sort this service under the category name on the invoice vs. the typical invoice section the service would be displayed in)

• Prepaid - this component allows you to tag services as pre-paid as apposed to post-pay. This further enables you to set an expiry date on this service or allow customers to refill time allocated to the service

• Profile Question - this component lets you add a profile question which can gather additional information about a particular service. These can either be questions about the customer signing up for the service, about the service or equipment associated with the service (asking for a MAC Address or a Security question response for example) or can be additional information that your organization wishes to collect

• Provisioning - provisioning refers to the communication between the billing application and your servers within the field. For example, you may have to authenticate or pass information to a particular server in order for the service to be correctly allocated and billed for. This is done by indicating which server each service (if applicable) should provision to. When the service is added to an account, it will be configured to use the account’s username and password. If these values are changed at the account level, the provisioning service will also be updated to reflect the change

• Service Tax Category - added to services to denote the type of tax applicable to the service

• Tax Code - this component allows you to specify which tax code is applicable to the service (and corresponding the tax rates for the given code/region). If the Tax Code component is configured at the user level, this service level component will override it (but only for the service in question)

• Tax Exempt - this component allows you to tag specific services for which taxes will not be applicable. However, if other services within a package are not tax exempt then applicable taxes will be applied to those services

• Transaction Code - a transaction is considered to be any event that results in a monetary value being added or subtracted to an account. Every transaction can have a Transaction Code associated with it and each service can be assigned a specific transaction code

• Workorder - Generates a workorder when the package the service resides in is added to an account. This feature is only available for environments that have the Workorder Module enabled

Components Available at the User-Service Level Only

• Agent - a sales agent who earns commission for selling the user-service. The Commission Module is required to use this feature

• Contact - if a Tax Code does not exist on an account then a service contact's address may be used when determine which tax is applicable to the service

• Equipment - used to associate equipment (hardware) with the service. Only available with the Equipment Module enabled