Reference12r2:PBX/Objects/Boolean

From innovaphone wiki
Jump to navigation Jump to search
There are also other versions of this article available: Reference | Reference9 | Reference12r2 (this version)

The Boolean PBX object is used to define time-dependent true or false states in the innovaphone PBX, and can be used for call forwarding or filters.

For example, the Boolean object Working hours (Mo-Fr 08:00-18:00 hrs) can be defined, which in the true state (that is, during office hours) is set to true and outside office hours is set to false. This would enable a filter to be defined that allows calls during office hours only.

In the same way, this Boolean object can be used for call forwarding. In the true state (true), it would allow call forwarding to a particular subscriber during office hours, in the false state (false) outside office hours. The current state can be switched using manual override.

See Reference12r2:PBX/Objects#General_Object_Properties for generic object properties.

The following specifications are made in the Boolean section.

Announcement (URL)
  • TRUE: The URL of the audio file to be played in the true state (true).
  • FALSE: The URL of the audio file to be played in the false state (false). This specification only makes sense if a call is received directly on this object.
Announcement (URL) if manual override is active (optional)
  • TRUE: The URL of the audio file to be played in the event of a manual override in the true state (true).
  • FALSE: The URL of the audio file to be played in the event of a manual override in the false state (false). This specification only makes sense if a call is received directly on this object.
External Name/No
The announcements HTTP stream will be created by the device defined by the boolean objects PBX attribute. To offload to another device, you can specify a Name or number here which will then be called to retrieve the audio stream. The respective URL parameters configured above will be sent along with this call, so that if the destination is an HTTP interface, the desired announcement will be played. If the destination is a 3rd party device it will likely play the same audio regardless of the boolean objects state.
Manual Override
The Manual Override list box allows you to change the current state. A manual override (MO) can also be set using DTMF. For this, the call number of the Boolean object, followed directly by the relevant DTMF code simply have to be dialled. The following DTMF codes are possible:
  • <Boolean object call number>01 - MO default state
  • <Boolean object call number>11 - MO true state
  • <Boolean object call number>10 - MO false state
For example, the Boolean object Working hours with the call number 50 in the true state would be transferred to the false state with the code 5010. It works exactly the same the other way round. If the Boolean object Working hours is in the false state, then it is transferred back to the true state with the code 5011. Note that the manual override should always be viewed in relation to the initial state.
Note: If a user wants to monitor the state of the boolean object on a phone function key,
      the monitoring user must share a group with the boolean object and must have group
      indications for this group enabled.

The remainder of the form allows you to define a list of conditions specifying when the boolean object is considered true. Please note that there is a maximum of 32 conditions allowed. All defined conditions are evaluated in sequence as defined until one is found that evaluates to true.

M T W T F S S
There is a check-mark for each weekday to which setting the state to true shall be restricted. If no check-mark is set, there is no restriction (same as all check-marks set)
Start Time/End Time
Sets start/end time of the active state. Following rules apply:
  • The state is set to true on any time to or after the Start Time and to or before the End Time.
  • If End Time = Start Time, the state is set to true all day.
  • If no Start Time or End Time is configured, there is no restriction on the time.
  • If Start Time is after End Time the state is set to true all the day except between End Time and Start Time
  • Smallest time unit processed is minutes. Seconds are not taken into account.
    • Only changes in the minutes and hours digit cause a change of state.
    • Within the same hour, the smallest switching time is 2 minutes, from hh:mm:00 to hh:mm+1:59.
    • If a switching time is placed over an hour change, the smallest switching time is 1 minute, from hh:59:00 to hh+1:00:00 .
  • An entry of 00:00 in the time field becomes 24:00.
  • Examples
    • Setting Start Time to 14:00 and End Time to 13:00 results in a condition which is true all day except from 13:01 to 13:59.
    • Setting Start Time to 09:00 and End Time to 09:01 results in a condition which is true from 09:00:00 to 09:01:59.
    • Setting Start Time to 23:59 and End Time to 24:00 results in a condition which is true from 23:59:00 to 23:59:59.
    • Setting Start Time to 00:00 and End Time to 00:00 results in a condition which is true all day from 00:00 to 24:00.
From (dd/mm/yyyy) / To (dd/mm/yyyy)
The state is set to true on any date to after the From date and to or before the To date. If no start or end date is configured, there is no restriction on the date. If any component is missing, there is no restriction by this component. Please note that dates are taken literally, no adjustment logic is applied. For example, a range from 24/12 to 01/01 is never true, as there is no day between both days in the same year. You need to either specify explicit years (24/12/2013 to 01/01/2014) or split the condition into two (24/12 to 31/12 and 01/01 to 01/01).
Example:
  • The state should be true on Christmas each year - Set From to 24/12 (year blank) and To to 24/12

Boolean App

Starting with V12r2, a boolean object can be controlled via built-in application icon in myPBX

Configuration
- in the Apps tab of the User or ConfigurationTemplate object the name of the boolean-object is shown as license. Tick to grant for user
- within myPBX, the app has to be made visible via app administration page