Skip to content

add scheduler information #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmitry-sinina merged 1 commit into from
Oct 13, 2025
Merged

add scheduler information #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en/general.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Routing
- Capacity control for gateways, destinations, companies, accounts
- Source and Destination number based Blacklisting and per number translation rules
- Possibility to rewrite/modify caller-id, DNIS at the any routing stage
- Time-based routing
- :ref:`Time-based routing <schedulers>`
- Statistic and quality control for the each destination
- Gateways grouping and load-balancing for cases when supplier provides several gateways for the termination
- Possibility to silently reject unauthorized SIP INVITEs
Expand Down
16 changes: 16 additions & 0 deletions en/web-interface/equipment/gateways.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,22 @@ Dump Level

Transport protocol
Transport protocol that is used


SIP Schema
Specifies the URI schema used in the **Request-URI**, **From**, and **To** headers.

**Possible values:**

- **sip** — URI is built as ``sip:number@domain``
- **sips** — URI is built as ``sips:number@domain``
- **sip with user=phone** — URI is built as ``sip:number@domain;user=phone``


.. seealso:: `RFC3966 <https://datatracker.ietf.org/doc/html/rfc3966>`_, `RFC4967 <https://datatracker.ietf.org/doc/html/rfc4967>`_

.. warning:: In Yeti, using the **sips** schema does **not** automatically enable any encryption mechanisms. It only affects the URI generation logic.


Host
IP address or DNS name of remote gateway to send SIP signaling (only for termination).
Expand Down
1 change: 1 addition & 0 deletions en/web-interface/system.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ YETI WEB interface - System menu description. This section describes general con
system/networks_prefixes
system/sensors
system/smtp_connections
system/schedulers


2 changes: 1 addition & 1 deletion en/web-interface/system/jobs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You could press "Run" link for execute some procedure or "Unlock" in case of som

- **PartitionRemoving** - procedure of removing partitions of tables :ref:`CDR History <cdr_history>`, :ref:`Auth logs <cdr_auth_logs>`, :ref:`RTP Statistics <rtp_statistics>` and :ref:`API Logs <api_logs>`. Storage period for each table defined at regulated by configurations parameter **partition_remove_delay** at /opt/yeti-web/config/yeti_web.yml

- **CallsMonitoring** - procedure that is used for periodical (once per minute) calculation of cost for all active calls for each :ref:`Account <accounts>` and comparison their cost with current :ref:`Account Balance <account_balance>`. If account balance is less than cost of all active calls for the :ref:`Account <accounts>` all calls will be dropped by Yeti. This procedure also is used for calculating statistics for :ref:`Dushboard <dashboard>` and :ref:`Active calls <active_calls>`;
- **CallsMonitoring** - procedure that is used for periodical (once per minute) calculation of cost for all active calls for each :ref:`Account <accounts>` and comparison their cost with current :ref:`Account Balance <account_balance>`. If account balance is less than cost of all active calls for the :ref:`Account <accounts>` all calls will be dropped by Yeti. This procedure also is used for calculating statistics for :ref:`Dashboard <dashboard>` and :ref:`Active calls <active_calls>`;

- **StatsClean** - procedure of removing statistics that are used for calculation of quality parameters (ACD, ASR and Short Calls) for :ref:`Gateways <gateways>` and :ref:`Dialpeers <dialpeers>`;

Expand Down
Binary file added en/web-interface/system/scheduler.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions en/web-interface/system/schedulers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. _schedulers:

==========
Schedulers
==========

Schedulers provide an automatic mechanism to enable, disable, and toggle the **Reject Calls** flag in **Customer Auth**, **Destination**, **Dialpeer**, and **Gateway** objects.


Scheduler Fields
================

Id
Unique scheduler identifier.

Name
User-friendly scheduler name.

Enabled
Only enabled schedulers are processed by the system.

Use Reject Calls
When enabled, the scheduler applies the **reject_calls** flag to **Customer Auth** and **Destination** objects to block traffic.

Current State
The current operational state of the scheduler. The system automatically recalculates this state every 2 minutes.

Timezone
The timezone that determines when the scheduler operates.


Ranges Configuration
====================

By default, a scheduler allows all traffic. To define when traffic should be blocked, create one or more **ranges**. Range Attributes:

Months
Months during which blocking will be applied. An empty value means *any month*.

Days
Days of the month when blocking will be applied. An empty value means *any day of the month*.

Weekdays
Days of the week when blocking will be applied. An empty value means *any day of the week*.

From Time
Start time of the blocking period. An empty value means *start of the day*.

Till Time
End time of the blocking period. An empty value means *end of the day*.


.. figure:: scheduler.png
:alt: Example of a scheduler configuration
:align: center

Example of Scheduler configuration.