| Table of Contents |
|---|
Summary
This article details the configuration and use of the Quantity component. The Quantity component allows you to add multiple services of to packages at the account level
| Info |
|---|
Note: services added using the Quantity Component are also referred to as 'Optional Services' as these user-services can be configured to be optional if desired (e.g. permit the user to have from zero to five of a particular service). |
The Quantity component allows you to reduce the number of packages you have to configure within the system. For example, you would not have to configure different packages because the quantity of a particular common service needs to vary depending on the package. There is no limit to the number of Quantity components each package can have.
...
This component is available when configuring packages at on the Setup tab levelpage, it is not available when editing user-packages on accounts.
| Info |
|---|
Note: Required fields are marked in RED. Validation is applied to these fields, if the field remains red the value entered is not valid and the form cannot not be saved. All other fields are optional (black label field names) and may be left blank. |
Click the on Setup tab
Under the Packages and Services section select Packages
Select the package from the list
Scroll down to the Components section and click the Add button
Select Quantity from the drop down list
Enter appropriate information in the fields provided as outlined below:
Package Service Connector - select the service which you have added to the Package that will become an optional service
Maximum - limit the total number of instances of this optional service. If not specified there is no limit to how many they can add. A value of zero will be treated as 'nothing' or no maximum for this field as well
Minimum - this is the minimum number of services that must be present in the user-package at any one time. For instance if this value was set to 5, and the user-package contained six optional services, you would only be able to remove one of the optional services
Default - this is the number of optional service that will be added automatically when the user-package is added to an account. If there are profile questions on the optional service it will only add them if the answers have been provided. The default setting doesn't impose limits, it simply dictates that a user-package should include x number of optional services when the user-package is added to an account. You can add or remove these optional services as needed provided you don't exceed the maximum or drop below the minimum
Threshold - this setting indicates when to charge for optional services, i.e. charge for each optional service that exists beyond the threshold. If no threshold value is specified then every instance will be charged. If you set the threshold to 3 then the customer could have three 'included' optional services and not be charged for them. If the same customer added a fourth optional service the base fee for the fourth service would be charged
Inactive - if this is checked, the connected service will be considered inactive and you will not be able to add any optional services to the user-package. However, if you have the min and defaults set it will still assign the default number of the optional service in question and observe the minimum value, you simply won't be able to add more of the inactive optional service. The optional services that are added by default can still be canceled if inactive is set but you will not be able to add them back again. If you do not want the optional service in question being added to the user-package going forward when the package is added to the account, you should check the inactive box AND set the 'Default' value to zero. When the package is added the optional service will not be present nor will it be available to be added to the user-package after the user-package exists on the account
Click Save
...
Add package
On screen click 'Add Service' link below the package - NOTE if the minimum or default is 1 or greater, there may already be optional services reflected under the package you're adding. From here you can add more.
select the optional service as needed
Finalize date setting, etc. on screen
Click Save
Adding after the user package has been created on account:
...
Effective Date - this is the initial bill date of the Optional Service. Once the Optional Service has been billed, this field is simply for reporting purposes.
Transaction Date - this isn't used when billing using Bill Account or Billing Service, the actual date on the transaction when the optional service does bill out is the bill date
Bill Date - this is the date which is stamped when the optional service bills out for the first time. Voiding an invoice will blank out this value so it can be set again during the next billing process
...
Billing of Optional Services
...
Optional services can be cancelled with options provided to prorate as is seen below.
| Info |
|---|
Note: the DATE field can be used to stamp an arbitrary date on the optional service for the date you want to recognize that the optional service was canceled on, however the date entered is not used in the calculation of the prorate. The Service simply prorates out AS OF TODAY, there is no relation in the calculation to the date entered. To cancel services in a user-package and have them calculate out a prorate as of a date, you need to cancel the package as a whole and use the 'as of specific date' options. |
...
Editing Optional Service Effective Dates
This feature is new in EngageIP 9.3.0 and is explained in the managing user-packages article along with the rules for editing optional service effective dates.