Unused Port

Program ID

MetraPipeline.MTUnusedPort.1

Description

The Unused Port plug-in is used to calculate the number of unused or overused ports in audio conference rating.  The number of unused ports is adjusted, possible given the user a number of unused or overused ports that aren’t factored into the price of the conference call. The adjustment can be made in three ways—simple, threshold, or advanced. 

Required Input Properties

Tag name

Value type

Description

ScheduleCon

Long

Number of connections that were scheduled.

NumConnections

Long

Total number of connections that occurred.

UserNumConnections

Long

Number of connections that were not CSRs, operators, translators, or other “special” users.

ExcludeRoles

Boolean

If true, exclude “special” users.

UnusedPortDef

Long

1 = simple
2 = threshold

3 = advanced

ThreshFree

Long

Number of free connections if using threshold  rating.

AdvPercentage

Long

Percentage used for advanced adjustment.

PortDelta

Long

Free connections when using threshold adjustment.

Required Output Properties

Tag name

Value type

Description

UnusedPorts

Long

Adjusted number of unused ports.

Additional Configuration Tags

Tag name

Value type

Description

UseType

String

Underused or Overused.  This plug-in can perform both types of adjustments.

Configuration Example

  <configdata>
    <ScheduleCon>ScheduledConnections</ScheduleCon>
    <NumConnections>ActualNumConnections</NumConnections>
    <UnusedPortDef>UnusedPortDef</UnusedPortDef>
    <ThreshFree>ThresholdFree</ThreshFree>
    <AdvPercentage>AdvancedPercentage</AdvPercentage>
    <PortDelta>PortDelta</PortDelta>
    <UnusedPorts>NumUnusedPorts</UnusedPorts>
    <ExcludeRoles>ExcludeRoles</ExcludeRoles>
    <UserNumConnections>UserNumConnections</UserNumConnections>
    <UseType>Underused</UseType>
 </configdata>

Remarks

The plug-in was overloaded to perform both unused and overused adjustments.  The calculation is made differently depending on the type. 

The advanced percentage is typically over 100% for overused port adjustment.