Versions Compared

Version Old Version 2 New Version 3
Changes made by

Jenni Wallin

Jenni Wallin

Saved on

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.

Below is a screenshot of the UDR Assistance displaying the Product UDR:

...

Field

Description

ID (int)

The unique id of the subscriber profile.

Name (string)

The name of the subscriber profile.

Products (list<Product>)

The products that should be associated with the profile.

Misc (map<string, any>)

See 2.1 Misc Field for more information.

Below is a screenshot of the UDR Assistance displaying the SubscriberProfile UDR:

...

Field

Description

ID (int)

The unique capacity ID.

Name (string)

The name of the capacity.

Capacity (long)

This parameter can be used for specifying the capacity of the counter type.

CapacityUnit (int)

This parameter can be used for specifying the unit of the capacity; 0 - bytes, 1 - kB, 2 - MB, 3 - GB, 4 - Event, 5 - Hour, 6 - Minute, or 7 - Other.

CounterType (byte)

This parameter can be used for specifying the type of counter this capacity applies to; 0 - input, 1 - output, or 2 - total.

CounterUnit (int)

This parameter can be used for specifying the unit of the counter; 0 - bytes, 1 - kB, 2 - MB, 3 - GB, 4 - Event, 5 - Hour, 6 - Minute, or 7 - Other.

QuotaDefault (long)

This parameter can be used in the APL code for setting a default quota that will be reserved for a request. If this quota is not available, you can configure the minimum amount of quota, specified by the QuotaMinimum field, to be tried instead.

QuotaMinimum (long)

This parameter can be used in the APL code for specifying the minimum amount of quota that needs to be available to grant a request. If this quota is not available, you can configure the request to be denied.

Misc (map<string, any>)

See 2.1 Misc Field for more information.

Below is a screenshot of the Create Capacity screen when creating the capacity in the GUI:

Capacity UDR

Info
titleExample - Capacity UDR

The following values:

Code Block
ID=101 
Capacity=400000 
CapacityUnit=0 
CounterType=2

ID=102 
Capacity=100000 
CapacityUnit=1 
CounterType=1

will give the following setup:

  • The two capacities have the IDs 101 and 102, which are used by the Product UDR.

  • The first capacity refers to the total amount of bytes, while the second capacity refers to the output bytes.

  • The first capacity has a limit of 400000 bytes (unit=0), while the second capacity has a limit of 100000 kB (unit=1).

...

Field

Description

ID (int)

The unique enforcement ID.

CounterType (byte)

The type of counter this enforcement refers to; input (0), output (1) or total (2).

Level (double)

The level at which this enforcement is triggered. Can be a percentage or absolute. Levels that are less than, or equal to 1, will be interpreted as a percentage value.

Name (string)

The name of this enforcement.

Misc (map<string, any>)

See 2.1 Misc Field for more information.

Below is a screenshot of the UDR Assistance displaying the Enforcement UDR:

...

Field

Description

ID (int)

The unique ID for this notification.

Name (string)

The name of this notification.

CounterType (byte)

The type of counter this notification refers to; input (0), output (1) or total (2).

Level (double)

The usage level at which this notification is triggered. Can be a percentage or absolute. Levels that are less than, or equal to 1, will be interpreted as a percentage value.

Required (boolean)

Indicates whether the notification should be required or not. If this field is set to false, the notification will not be sent unless it has been stated in the Subscriber UDR, see Subscriber UDR in 2.2 Buckets Data Model. If this field is set to true, the notification will always be sent regardless of what is stated in the Subscriber UDR.

Type (string)

The type of notification, for instance SMS or email.

Address (string)

The address the notification should be sent to.

Message (string)

The message to be sent as part of the notification.

Misc (map<string, any>)

This field can contain information about product ID or product name, for instance. See 2.1 Misc Field for more information.

Below is a screenshot of the UDR Assistance displaying the Notification UDR:

...