Model: view/IniCoolingMgmtVIEW

Cooling

Pre-requisites

The Number Cooling feature must be enabled and configured in Global Settings before it will work.

Overview

The Number Cooling feature allows for the automatic aging of numbers after service delete to prevent immediate reuse of a number. For example, if a user leaves the company, the phone number that was in use can be placed into a cooling period for a pre-configured number of days to prevent a new user from receiving unwanted calls on that number. This feature can be enabled per Customer.

During the cooling period, the number cannot be reused until either the cooling period has elapsed, or until a provider administrator has manually removed the number from the cooling period. Once a number has been removed from the cooling period, it will be reintroduced into the pool of available numbers for allocation to a subscriber, phone, device etc.

The Number Cooling form allows a provider administrator to manually add directory numbers to a cooling period (thereby removing them from the list of available numbers), or to manually remove directory numbers from a cooling period (thereby adding them back to the list of available numbers).

System Message: ERROR/3 (<string>, line 40)

Unknown directive type "uml".

.. uml::

   @startuml
   !include style.iuml

   start
   while (Number Cooling enabled?) is (No)
     :[[../src/user/concepts-global-settings.html Enable cooling]];
   endwhile (Yes)
   :Apply cooling;
   note right
     Get pre-requisites:

     * cooling period
     * hierarchy search downwards
     * filter numbers to search
   end note
   stop
   @enduml

System Message: ERROR/3 (<string>, line 60)

Unknown directive type "uml".

.. uml::

   @startuml
   !include style.iuml

   start
   :Action - remove from cooling;
   :Filter numbers to show;
   note right
     * days to cooling expiry date
     * hierarchy search downwards
   end note
   stop
   @enduml


  `Enable Number Cooling <https://www.youtube.com/embed/SPmfmanz-Yk>`_

Apply cooling

Navigate to the required hierarchy level (Provider or Customer) from which you want to add numbers to a cooling period.
On the Number Cooling form, choose Apply cooling from the Select Action drop-down.
Enter an optional cooling duration in days (max = 999) to apply to the selected numbers. This setting overrides the value set in their global settings. If this field is left blank, then the cooling duration set in the global settings for each number will apply.
Set Filters to determine which numbers will be included in the Available box in the Select Numbers area, these include:
- Include available numbers
- Include cooling numbers
- Contains. Used to further refine the numbers displayed in the Available box.
- Show numbers at/below hierarchy. Allows you to select a lower hierarchy level than the one selected on the hierarchy breadcrumb.
Select one or more numbers in the Available box and click Select to move them to the Selected box. Note that the Available box will not display numbers that are used, i.e. it will only display numbers that are unused and available.
Click Save. The selected number/s are placed into a cooling period and will no longer be available for use until the cooling period has elapsed or until they have been manually removed from cooling.

Remove from cooling

Navigate to the required hierarchy level (Provider or Customer) from which you want to remove numbers from a cooling period, i.e. add them back into the list of available numbers.
On the Number Cooling form, choose Remove from cooling from the Select Action drop-down.
Set Filters to determine which numbers will be included in the Available box in the Select Numbers area, these include:
- Include cooling numbers
- Expires from cooling within (days).
- Contains. Used to further refine the numbers displayed in the Available box.
- Show numbers at/below hierarchy. Allows you to select a lower hierarchy level than the one selected on the hierarchy breadcrumb.
Select one or more numbers in the Available box and click Select to move them to the Selected box.
Click Save. The selected number/s are removed from the cooling period and are available for allocation to a subscriber or phone, etc.

Model Details

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

For the above internal number, do: *

Default: move_to_cooling

Field Name: view_action
Type: String
Default: move_to_cooling
Choices: ["Apply cooling", "Remove from cooling", "Reserve", "Unreserve"]

Reservation/Cooling duration (days)

Field Name: add_days
Type: String
Pattern: ^([1-9][0-9]{0,2})$
Format: regex

Reservation Notes

Field Name: reservation_notes
Type: String

Show available numbers

Default: True

Field Name: numbers_filter_show_available
Type: Boolean
Default: True

Show numbers in cooling

Default: True

Field Name: numbers_filter_show_incooling
Type: Boolean
Default: True

Show reserved numbers

Field Name: numbers_filter_show_reserved
Type: Boolean

Show numbers at/below hierarchy

Field Name: numbers_filter_hierarchy
Type: String

Show numbers that contain

Field Name: numbers_filter_contains
Type: String

Show numbers expiring from cooling within the next (days)

Field Name: numbers_filter_expires_within
Type: String
Pattern: ^([1-9][0-9]{0,2})$
Format: regex

Select Number

Field Name: numbers.[n]
Type: Array
Cardinality: [1..n]

Control field for GUIR async behaviour

Field Name: guir_control
Type: String

API reference for view/IniCoolingMgmtVIEW