Usage Licensing

Notification Example

Where usage licenses are used, each day Softdial CallGem™ writes the license usage in XML form for the previous day/ period. This XML is also known as the License Map, and is written

  1. in the first dialer syslog of the day
  2. in the body of the notification email, which is sent to Sytel

Below is an example and a description of a License Map.


<MagicXMLDocument>
  <LicenseMap Year="2018" Month="2" Day="8" Start="43139.73467572" Now="43140.00347438" Version="Softdial Plugin 10.6.915.29677 (06 February 2018)">
    <Usage PRED="0.00787349" ACD="0.00000000" PBX="0.00000000" VIR="0.00000000"/>
    <Peaks>
      <Peak Name="PREDACDTOT" Count="2" BorrPRED="0" BorrACD="0" Timestamp="43139.73606516"/>
      <Peak Name="PRED" Count="2" BorrPRED="0" BorrACD="0" Timestamp="43139.73606516"/>
      <Peak Name="ACD" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
      <Peak Name="PBX" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
      <Peak Name="VIR" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
    </Peaks>
    <Tenant Name="default">
      <Usage PRED="0.00787349" ACD="0.00000000" PBX="0.00000000" VIR="0.00000000"/>
      <Peaks>
        <Peak Name="PREDACDTOT" Count="2" BorrPRED="0" BorrACD="0" Timestamp="43139.73606516"/>
        <Peak Name="PRED" Count="2" BorrPRED="0" BorrACD="0" Timestamp="43139.73606516"/>
        <Peak Name="ACD" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
        <Peak Name="PBX" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
        <Peak Name="VIR" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
      </Peaks>
      <Campaigns>
        <Campaign Name="system">
<Usage PRED="0.00000000" ACD="0.00000000" PBX="0.00000000" VIR="0.00000000"/>
          <Peaks>
            <Peak Name="PREDACDTOT" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
            <Peak Name="PRED" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
            <Peak Name="ACD" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
            <Peak Name="PBX" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
            <Peak Name="VIR" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
          </Peaks>
        </Campaign>
        <Campaign Name="Campaign1">
<Usage PRED="0.00787349" ACD="0.00000000" PBX="0.00000000" VIR="0.00000000"/>
          <Peaks>
            <Peak Name="PREDACDTOT" Count="2" BorrPRED="0" BorrACD="0" Timestamp="43139.73606518"/>
            <Peak Name="PRED" Count="2" BorrPRED="0" BorrACD="0" Timestamp="43139.73606518"/>
            <Peak Name="ACD" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
            <Peak Name="PBX" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
            <Peak Name="VIR" Count="0" BorrPRED="0" BorrACD="0" Timestamp="0.00000000"/>
          </Peaks>
        </Campaign>
      </Campaigns>
    </Tenant>
    <Checksum Value1="42801" Value2="15319"/>
  </LicenseMap>
</MagicXMLDocument>

As shown in the License Map example above, there are 2 data sets (Usage, and Peak per license type) provided at each of 3 levels of scope:

  1. Platform (LicenseMap) (for the entire platform)
  2. Tenant (for each provisioned tenant)
  3. Campaign (for each active campaign)

LicenseMap contains the following items:

  • Year/ Month/ Day - the day containing the Start time
  • Start - the start time of the period covered
  • Now - the end time of the period covered (and the time when the log was written)
  • Version - the SCC version and release date

The user types are:

  1. PREDACDTOT: total of PRED + ACD (for peak only)
  2. PRED: Predictive
  3. ACD: non-predictive (i.e. Progressive + Preview + Inbound)
  4. PBX: “on hook” campaigns
  5. VIR: virtual agents

The data sets are:

  • Usage: records the hours/ minutes each license type was used (as an OLE automation date time format floating-point decimal)
  • Peak: for each license type, records
    • the peak usage (maximum concurrent users)

    • the number of borrowed licenses from regular (ACD) and predictive pools (if any)

    • the time the peak occurred

So in the License Map example above, we can see that:

  • The installed version of SCC is 10.6.915 (LicenseMap Version)
  • The reporting period
    • starts - 08/02/2018 17:37:56 (LicenseMap Start)
    • ends - 09/02/2018 00:05:00 (LicenseMap Now).
  • The global usage of agent hours:
    • PRED: 00:11:20 (HH:MM:SS)
    • ACD: zero
    • PBX: zero
    • VIR: zero
  • The global peaks:
    • PRED: 2 licenses (also reflected in PREDACDTOT: 2 licenses).
    • Used by agents on Campaign1 that was running on tenant default.