Versions Compared

Key

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

...

Field

Description

Id (int)

The unique product ID.

Name (string)

The name of the product.

Capacities (list<Capacity>)

Defines the capacities for all counter items relevant for this product. A capacity is used to measure threshold values for enforcements and notifications. For unlimited capacity ignore this field.

Price (int)

Optional price information.

Currency (string)

Currency of price, e g USD, EUR, etc.

Duration (int)

When creating a bucket this field can be used to set the value for the bucket stop time.

DurationUnit (int)

The unit of the duration, for instance day, week, or month. 1 = minute, 2 = hour, 3 = day, 4 = week, 5 = month and 6 =year. ResetType (int) The type of reset, reset from start (1) or reset from date (2).

Enforcements (list<Enforcement(PCC. Product)>)

Holds a list of enforcement definitions, see the section below, Enforcement UDR.

Notifications (list<Notification(PCC.Product)>)

Holds a list of notification definitions, see the section below, Notification UDR.

ResetType (int)

The type of reset; reset from start (1), which means that if the reset interval is set to "Month", for example, then the buckets connected to the product in question will be reset at the start of the month, even if the day and time in the bucket's StartTime is something else, or reset from date (2), which means that the bucket will be reset at StartTime plus ResetInterval .

 


Note
titleNote!

This is just an example configuration which may be changed in the Workflow template.


ResetInterval (int)

The interval with which this product is reset. Resetting a product involves clearing the bucket associated with this product. If set to 0 the product is never reset.

ResetIntervalUnit (int)

The unit of the reset interval, for instance day, week, or month. 1 = minute, 2 = hour, 3 = day, 4 = week, 5 = month and 6 =year.

RetainedCounters (int)

Controls the number of counters that are retained in the bucket counters list at reset.

For example, if the product has an hourly reset interval and RetainedCounters is 24 the bucket will hold discrete usage counter statistics for the last 24 hours.

Periods (list<Period (PCC.Periods)>)

Determines the list of periods during which the product should be active. The periods in the stated list can contain one or several sub periods, which means that you can combine different time settings in one period. See 2.4 Periods Data Model for further information.

StartTime (date)

The start time for the product.

StopTime (date)

The stop time for the product.

StopFallthrough (boolean)

Used in the product selection process. When usage is reported, the first step is to determine the products associated with the reported usage. This results in a product priority list. The next step is to iterate the list and report usage in the associated bucket. If StopFallthrough is true on the product then iteration stops with this.

StopAtCapacity (boolean)

Determines if the counter for a bucket should continue to count or not when 100% capacity for the bucket has been reached. If set to false, the counter will continue counting. If set to true, the counter will stop once 100% capacity for the bucket is reached.

Misc (map<string, any>)

See 2.1 Misc Field for more information.

...

Info
titleExample - Notification UDR

The following values:

Code Block
ID=700
Name='FIRST'
CounterType=2
Level=0.60
Required=false
Type='SMS'
Address='10.10.10.700'
Message='PCC Notification: 60% reached'

ID=702
Name='SECOND'
CounterType=2
Level=0.90
Required=true
Type='SMS'
Address='10.10.10.700'
Message='PCC Notification: 90% reached'

ID=703
Name='THIRD'
CounterType=2
Level=1.00
Required=true
Type='SMS'
Address='10.10.10.700'
Message='PCC Notification: 100% reached'

will give the following setup:

  • The three notifications with IDs 700, 702 and 703 have the names First , Second and Third .

  • All three notifications will trigger based on the total number of bytes.

  • The First notification will be triggered at 60 %, the Second at 90%, and the Third at 100 %.

  • The First notification is not required, while the Second and Third> are required.

  • All three notifications will be sent as SMSs.

  • All three notifications will be sent to IP address 10.10.10.700.



Scroll ignore
scroll-viewportfalse
scroll-pdftrue
scroll-officefalse
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse


Next chapter: