Versions Compared

Version Old Version 9 New Version 10
Changes made by

Mahnoor Khan (Deactivated)

Greg Walsh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Module Required

The functionality described below requires that you have the Commission module enabled in the EngageIP AdminPortal. If the module is not active the commission features detailed in this article will not be present in your EngageIP installation. Contact your LogiSense [glossary_exclude] account [/glossary_exclude] representative if you wish to discuss adding the Commission module to your installation.

...

  • The ability for commission to be payable either when billing occurs or when payment is made

  • Commission paid out at a flat rate or percentage of the service charge

  • Commission paid out for a specified number of occurrences (once, multiple times or indefinitely
    as long as the qualified service is being billed/paid)

Payment details are configurable per Agent, e.g. you can setup one Agent to receive a 5% commission on hardware sales and another agent to receive 3% commission on hardware sales).

Additional payment options are available depending on your EngageIP version, continue reading below to review these features.

...

  • Specific types of calls (e.g. international, long distance, etc.)

  • SMS

  • Data

  • All usage on an account

Commission Retirement

...

  • Email delivery as pdf or html

  • File export as html/pdf

  • Setting Statements as Paid, Closed

  • Reprocessing Statements (in the event the event commission was applied at the incorrect rate)

  • Templates that can be customized to display additional commission details, your desired layout or branding

  • Bill Run integration so that Statements can be rendered and closed on a specified schedule (e.g. monthly)

...

  • The Agents, Accounts and Services the commission relates to

  • How much commission is payable/how much advancement is payable

  • What Commission Type is being paid out for and at what Rate

  • Related Invoice and Statement details and statuses

...

  • Setting up any number of 'Commission Details' per each Agent which dictate what the Agent earns commission for (one-time commission, recurring commission, hardware sales, etc.)

  • Defining how each agent is paid for each Commission Type and for how long, e.g. pay out a flat rate of $20 a month for 6 months for a particular monthly service, pay 5% one-time commission for the sale of hardware, etc.

  • Configuring an Agent to receive commissions on specific customer accounts

  • Configuring an Agent to receive commission on specific services on a customer account

  • Configuring Agents to be shared from a Top Level Owner to other Branded Owners (in the event Sales Agents are selling products for multiple companies setup in EngageIP)

...

  • Retire Agents stopping commission payments

    • Configurable globally (stop all commission payments for the Agent in question), or at lower levels (retire commission payment on an Account or Service)

  • Reassign Agents so that another Agent can take over their accounts and services, automatically setting the previous agent as 'Retired'

...

  1. An Agent must be defined and assigned (this determines which sales agent receives the commission and for what user-service/account)

  2. A service must have a Commission Type Component on it (without this component commission is not applicable to the service sold)

  3. Commission types must be setup (used in combination with the Agent and the Commission Type Components to define if commission should be applicable. e.g. Commission Type = hardware, Agent is setup to earn commission for type hardware, commission is earned)

...

Below the three types of Agents are explained and how they interrelate.

  • User-Service Agent:

    • The User-Service Agent component is added to a User-Service within a User-Package that resides on a User/Account (via edit Package -> edit Service on the Packages or Overview tab)

    • The User-Service Agent component will take precedence (override) User-Agent settings on the account (if a User-Agent is configured on the account or parent account) If 'Commission Details' are configured on the User-Service Agent then commission will be applicable regardless of which Commission Type is configured on the User-Service. Matching the exact Commission Type specified on the User-Service is not required when Commission Details are defined on the User-Service Agent, any commissionable Service will result in commission being earned in this scenario

    • If Commission Details are not configured on the User-Service Agent then Agent commission settings (Setup tab -> Agents -> Agent Commission Details) will be referenced. If the 'Commission Type' on the User-Service matches the Agent Commission Details -> Commission Type then commission will be earned based on the the Agent Commission Detail configuration. If the Commission Type does not match, no commission will be applicable (Note: how commission is applied is laid out in a flow chart below this section)

  • User-Agent:

    • The User-Agent added to a User/Account (from the Tools tab)

    • The User-Agent commission settings will not be referenced for a User-Service on the account if the User-Service has a Agent Component on it (the lower level User-Service Agent agent takes precedence over the User-Agent)

    • If UserAgent Commission Details are configured for the User-Agent then a "Commission Type" defined in one of the UserAgent Commission Details must match the Commission Type setup on the User-Service. If the Commission Type does not match then Agent Commission Details (commission details configured for the Agent on the Setup tab) will be evaluated to see if commission is applicable, i.e. if the User Service -> Commission Type matches the Agent -> Commission Type then Agent commission settings will be applicable, if not no commission will be paid

    • If no UserAgent Commission Details are configured for the User-Agent then Agent commission settings will be evaluated, if there is no type match at the Agent level then no commission is applicable

  • Agent:

    • The Agent settings are configured on the Setup tab (Setup -> Commission -> Agents)

    • Agents are tied to and created from existing EngageIP accounts, i.e. accounts need to exist/be created for each sales agent that earns commission

    • Once Agents are defined they will be selectable when adding a User-Service Agent component to a User-Service or a User-Agent to an Account

    • Agent commission details are not referenced independently, they are only evaluated if a User-Service Agent/User-Agent is present on a User-Service/User and the Commission Detail Settings for these Agents are either:
      a. Not configured or .
      b. The User-Agent Commission Details > Commission Type does not match the User-Service
      Commission Type

    • Like the User-Agent, the Agent Commission Detail settings will only be applied if the "Commission Type" (for instance 'One Time' commission) matches the Commission Type set on the Commission Type Component that is connected to the User-Service. If there is no Commission Type match (Service Component -> Commission Type matches Agent Commission Details -> Commission Type) then commission is not applicable

    • Agents and their commission configuration under one Owner can be shared with other branded owners (configuration steps are listed in this article below)

...

  1. Load the Admin account and click on the select Configuration link at the top of the screen

...

  1. Beside the field Commission Pay Type select either Billing or Payment

...

  • Billing - the commission will pay out when billing occurs

  • Payment - the commission will pay out when the invoice is paid

...

Adding Commission Details to Agents

  1. Load the Setup tab

  2. Locate the Commissions section and click on Agents

  3. Click on the name of the Agent you wish to add Commission Details for

  4. The Agent Commission Detail page will load, click Add on this page

  5. Enter the Agent Commission Details (required fields are in red):

    • Select the CommissionType in the drop down list

    • Select the Commission Calculation Type (Flat rate or Percentage)

    • Enter the Rate to be in sync with the Commission Calculation Type. For example entering 5 with the type of Flat is $5.00, entering 0.05 with the type as Percentage is 5%

    • In the Occurrences field enter number of times commission should be applied when the service is billed/payment is collected (leaving this field empty or blank means keep applying commission indefinitely)

    • Calculate Commission On First Invoice Only (Introduced in EngageIP 8.5.19.0): should be selected if you want to pay out commission on the initial invoice only
      Note: the invoice must be paid for commission to be granted, not merely issued

      • If an agent should earn commission for both the first invoice and for subsequent Service billing/payments for the Commission Type in question, then Agent Commission Details will need to be added at least twice. I.e. if the desired configuration is to pay out commission for the first invoice and to pay out monthly commission each time a particular Service is billed then define:

        • Agent->Add Commission Detail->Configure for proper Commission Type (matches the Service Component Commission Type), enable 'Calculate Commission On First Invoice Only'

        • Agent->Add Commission Detail->Use the same Commission Type, do not enable 'Calculate Commission On First Invoice Only'

        • Result: if the Commission Type on the Service (component) matches the Agent Commission Type -> Payout once for the first invoice when billing/payment occurs & also pay commission out as the service is billed/paid going forward based on the "Occurrences" setting

    • Clawback (Introduced in EngageIP 8.5.24.2): can be used to change the rule from a commission payout rule to a Clawback commission rule

      • Clawback rules allow commission payout to reclaimed in whole or in part when services are canceled on a new account prior to meeting a minimum number of billed months

      • For example: you can configure a commission rule to pay out 10% commission for each service (Type Percent, Rate 0.10) and a separate Clawback rule to take back 5% commission (Type Percent, Rate 0.05) for each service if the Minimum Period is not met.

    • Clawback Minimum Period (Introduced in EngageIP 8.5.24.2): used when Clawback is enabled in order to specify the number of billing periods that need to be billed for clawback rules to be ignored

      • For example: if set to 3 (three months) then commission will be taken back (at the Rate specified in the Clawback rule) for commission paid out prior to reaching the third month. If the new account is canceled in the fourth month however, no commission will be reclaimed
        Note: the Clawback Minimum Period will be considered when Commission Detail Types of 'Default' or 'New Order' are used but not 'Renewal' types. A Clawback minimum period will always be calculated against the start of a contract (New Order), it will not factor in renewal periods

    • Commission Detail Type (Introduced in EngageIP 8.5.26.0): determines in what scenario the commission applies

      • Default: the stock behavior, apply commission based upon Commission Detail Type matching (User Service Component > User Agent/Agent Commission Detail rules). Detailed in the How Commission is Applied section above

      • New Order: trigger commission calculations when a new User-Contract is activated on an Account. When the User-Contract is activated the normal commission calculation rules will be executed to determine if commission is applicable (i.e. Commission Types on User-Services within the User-Contract must match Commission Types configured in User Agent settings on the Account or failing that Commission Types configured at the Agent level). New Order Commissions will continue to pay out for subsequent months (they are not one-time bonuses), if you wish commission to be paid out only once for the new User-Contract then set the Occurrences value to 1

      • Renewal: trigger commission calculations when a User-Contract is manually Renewed on an Account. Commission calculations will not occur if a User-Contract is set to 'Auto Renewable' (as in that scenario the Agent had nothing to do with getting the Contract Renewed). Renewal commission will only be calculated if a new User-Contract is created when the old User-Contract expires and the new User-Contract > 'Renewed From User Attribute Contract' field is set to the ID value of the expired User-Contract. Once the User-Contract is renewed the normal commission calculation rules still apply to determine if commission is applicable (Commission Type matching). Like the New Order functionality, Commission for a Renewed User-Contract will continue to pay out for subsequent periods if the renewed contract and applicable User-Packages remain active, to control the payout length define an Occurrences value

    • Advancement (Introduced in EngageIP 8.5.26.0): when enabled permits sales agents to earn commission for services connected to a User-Contract in advance of Services in the Contract being billed/paid. For more information see the Configuring Advancement section below

    • Retire (Introduced in EngageIP 8.5.26.0): allows you to retire the Commission Detail so that the Agent no longer earns commission for it. Used in conjunction with the 'Effective Date' field

    • Effective Date (Introduced in EngageIP 8.5.26.0): is used when the Retire option is enabled to indicate the exact date a Commission Detail will be retired. Commissions will continue to be calculated in relation to the Commission Detail rule until this retirement date is reached

  6. Click Save

  7. Repeat the process above for all the Agents you wish to setup commissions for

...

Bonus Commission can be paid out when a certain commission threshold is reached across all accounts that an agent receives commission for. Bonuses can be tiered and multiple bonuses can be configured so that more than one Bonus is applicable for an Agent. Bonus commission is determined when the Commission Statement for an Agent is closed. For example if an Agent is configured to receive a bonus of 10% commission when $1,000 of commission is earned for any Commission Type, then when the Agent's Commission Statement is closed a $100 bonus will be applicable if the commission payable equals or exceeds $1,000.

  1. Load the Setup tab

  2. Click Agents

  3. Click on the Name of the Agent you want to setup Bonus Commission for

  4. On the Edit Agent page under the Agent Bonus Commission Detail section click Add

  5. Fill in the Bonus detail (required fields are in red)

    Image Modified

    • Name: enter a name (label) for the bonus commission

    • Retire: this option will disable the Bonus Commission Detail for the Agent until it is unchecked

    • CommissionType: this field will indicate what Commission Type will be shown in the Commission Type field on Reports

    • Conditions: click 'Add Condition' to define what Commission Types Bonus Commission will apply to
      Note: you must set at least one Condition for Bonus Commission to be used

      • All Commission Types: set this if you wish to total up the commission for all Commission Types that the Agent receives commission for

      • Other Commission Types: if you wish to calculate the bonus (tier threshold) against the total commission for specific Commission Types specify them here

      • Add Condition: use this option to total up the commissions for multiple types (one-time commission + hardware commission for instance)

      • Tiers:

        • Threshold: set this to pay out on the total commission earned for the Commission Types defined in Conditions above (e.g. if Conditions = Commission Type hardware and you want to pay out a bonus once $2,000 of commission has been earned for hardware sales in a period enter 2000 in the threshold field)

        • Calculation Type: set either a percentage bonus payout or a flat bonus amount to payout

        • Rate: works in conjunction with the Calculation Type. If set to 100 and Flat, a $100 payout will occur when the commission threshold is reached, if set to 0.10 and Percent, a 10% bonus will be paid out on the commission earned

...

  1. Click Save

Adding the Commission Type Component to a Service

  1. Load the Setup tab

  2. Click Services

  3. Click on the name of the service you wish to add the commission component to

  4. Under the Components heading click Add

  5. Select the Commission Type component

  6. In the CommissionType field select the appropriate type
    Note: if this field is empty then Commission Types are not setup, ensure you have followed the instructions under 'Adding Commission Types' above first

  7. Click Save and the Component will be listed on the Service edit page

...

  1. Access the MSSQL Server Management Studio and enable the following option on the 'EngageIP' database
    insert into EngageIPOption (Name, Value) values ('CreateUDRBillerUDRClassSummary', 'True'

    Code Block
    insert into EngageIPOption (Name, Value) values ('CreateUDRBillerUDRClassSummary', 'True')

  2. Restart IIS on the EngageIP Server

  3. Load the EngageIP AdminPortal and access the Setup tab

  4. Click on UDR Classes

  5. Click on the Name of the UDR Class you wish to allow commission to be earned on

  6. Under the Components section click Add

  7. Click Commission Type

  8. Select the Commission Type you wish to use (if you have not setup Commission Types for usage see the Setting up Commission Types section above)

  9. Click Save

Ensure an Agent is setup to receive commission for the Usage Commission Type and they will earn commission for it.

...

A Package that is connected to the User-Contract has a User-Service with the appropriate Commission Type (in this case Recurring) configured. (Commission Type Components are added via Setup > Service > Configuration)

...

Example Outcome: when the User-Contract > User Contract Status is switched to an Active status the following will occur:

...

If you are unfamiliar with Role Permissions see the Roles – Adding Roles, Setting Role Permissions and Importing guide for instructions on adding permissions.

...

  • ID - Similar to invoiceID, the ID of the statement in the database

  • Name - Name of the statement if different than the ID

  • Owner - Owner to which the Agent is associated

  • Agent - Name of the Agent receiving the commissions

  • Date - Date on which the statement was created initially

  • Amount Billed - Total amount billed on the customers invoice which had commission calculated on it

  • Amount - Total commissions calculated on the amount billed

  • Status - Current status of the statement, if CLOSED, no more commissions can be added to it.

  • Sent Date - Date the statement was delivered to the Agent

  • Closed Date - Date the statement was closed - by billing or manually

  • Payable Date - Date set on statement open and calculated by the 'Hold Period' if it exists in the definition of the commission

  • Paid - Flag indicating that the commision commission was paid out to the agent

  • Paid On Date - the date on which the commission was paid which goes along with the Paid flag

  • XML - Data file you can download of the statement itself - similar to the Invoice xml

  • Void - Flag indicating if the statement was voided or not

...

  1. Load the Setup tab

  2. Click on Commission Statement Templates

  3. Click Add

  4. Enter a Name for the template (for instance 'Commission Statement Template')

  5. Enter a Subject (this will be populated in the email Subject line if the Statement is configured to be delivered via email, so 'Commission Statement' would suffice)

  6. In the Template field enter the XSLT which will define the statement [Sample Statement](sample xslt statement provided below)

  7. Click Save

View file
nameCommissionStatement.xslt

Next the Commission Statement needs to be connected to an Invoice Configuration so that delivery options can be configured

...

If you are unfamiliar with Role Permissions see the Roles – Adding Roles, Setting Role Permissions and Importing guide for instructions on adding permissions.

...

  • The Owner, User, Agent and Parent Account

  • User-Service details the Commission relates to

  • The Commission Type and the payout (e.g. fixed $20 Commission Payable for 'Hardware' Commission Type)

  • The Advancement Amount which indicates what an agent was paid for prior to a User-Contract being billed/paid for. See the Configuring the Configuring Advancement section for more information on how Advancement is configured and applied

  • The Commission Source which indicates which Commission Detail was used (i.e. a UserServiceCommissionDetail, UserAgentCommissionDetail or AgentCommissionDetail)

...

  1. Load the Setup tab

  2. Select Roles

  3. Once you select Roles, you will see a list of all of the Roles that you have configured in EngageIP.  In this example, we have 2 roles: Admin and Customer

  4. Click on the name of the Role that you would like to add or alter the permissions for

  5. Scroll down to where you can locate the Commission entries in the permissions list

    Image Modified

...

  1. Once the permissions are selected click Save

Viewing the Commissions Report / Setting Commissions as Paid

...

  • A specific Commission Detail at a User-Service level can be retired (for instance stop paying an Agent recurring commission on a particular service on a particular account)

  • A specific Commission Detail at a User level can be retired (for instance stop paying an Agent one-time commissions on a particular account)
    Note: this will not disable User-Service Agent components on User-Services on the account

  • All Commission Details at a User level can be retired (for instance stop paying an Agent for all commissions on a particular account). As above, this doesn't apply for User-Services with User-Service Agent components

  • A Commission Detail at the Agent level can be retired (for instance stop paying commission for all hardware sales the Agent makes).

  • All Commission Details at the Agent level (stop paying the Agent for commissions entirely). This will disable commission payments for the Agent entirely, including Agent configurations implicitly set at the User and User-Service level.

...

If you wish to both Retire an Agent from receiving commissions and have another Agent take over earning commission for the same User-Services and Accounts, see the Reassigning Agents section below.

Retiring Agents at the User-Service level

...