innovaphone wiki - User contributions [en]

Reference16r1:Apps/PbxManager/App Fax

2026-04-16T11:35:03Z

Teh: SMTP server port added

This page describes the PBX Settings Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Settings Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== Change configuration ===
* '''Delete fax jobs automatically''': Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* '''Send with high resolution''': The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== Default settings for mail notifications ===
* '''Incoming notification''': generate email on incoming fax
* '''Forwarding as PDF''': forward received fax as PDF attachment
* '''Transmission confirmation''': generate email on fax transmission
* '''Transmission report as PDF''': generate email with send report as PDF attachment
* '''Error notification''': generate email on errorneous fax transmission
* '''Language''': set email language. Supported values are ba, ca, cs, da, de, en, es, et, eu, fi, fr, hr, hu, it, lv, mk, nl, no, pl, pt, ro, rs, si, sv, th, tr; non-supported values are replaced by en.
* '''Timezone''': set email timezone according to [https://www.iana.org/time-zones IANA definitions]. For a better overview you may refer to [https://www.iplocate.com/de/resources/timezones/list-of-timezones this page].
Pre-set default for language and timezone are the administrator values.

=== SMTP server configuration ===
The email receiving for the Mail2Fax feature can be enabled and the authentication configured here:
* '''E-mail reception''': To be turned on.
* '''Port''': The locally opened socket port. If zero is configured, the default port is used.
* '''Domain''': Used to filter the recipient address of the received mails' address list. If not set, the configured app domain of the app service is used.
* '''User name''': The login name for the SMTP authentication.
* '''Password''': The password for the SMTP authentication.

=== SMTP configuration ===
Required data for outgoing emails:
* '''Host name''': Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* '''Server[:port]''': Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* '''User name''': The login name of a valid user account at the SMTP server (recommended).
* '''Password''': The password of the SMTP user account (recommended).
* '''Sender address''': The email address of the sender in sent emails.
* '''Sender name''': The name of the sender in sent emails.
* '''OAuth2''': Alternatively OAuth2 mode and credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].
[https://sdk.innovaphone.com/16r1/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== HTTP API ===
* '''Key''': key for HTTP post command authentication. For details, refer to the [[{{NAMESPACE}}:Concept_App_Service_Fax#App_API|API concept]].

=== Customized texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

=== Mail background logo ===
* '''Include picture''': add myApps background logo in all HTML mail bodies
* '''Custom picture''': Base64-encoded data-image for customized background logo

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* '''Name''': Object long name
* '''SIP''': Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* '''Number''': Object number to be prepended for fax calls.
* '''International fax number''': Printed in the headline of fax document. The user (send) number is added, but not the node number.
* '''Company name''': Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
=== FAX interface ===
Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
* '''Device name''': Name of the device as defined in the Devices App
* '''Hardware ID''': Serial number (MAC) of a device
* '''Product''': innovaphone device model
* '''Available channels''': Amount of offered fax channels
* '''T.38 allowed''': T.38 codec for the fax transmission allowed
* '''Audio fax allowed''': Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
=== External resource ===
The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
* For fax objects: This is only used if no fax interface is registered.
* For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
=== Node and PBX ===
The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
=== Default Recipient ===
Faxes are received for this user or this fax group. If no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
=== Header of fax pages ===
A header line preset for a language can be selected or the header line can be individually modified. Usable variables are listed [[{{NAMESPACE}}:Gateway/Interfaces#Headline|here]].
=== Configuration Templates ===
Select configuration templates to be applied for the fax app object

Reference16r1:Concept App Service Documents

2026-03-23T14:51:43Z

Teh: /* Connect integration */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

* innovaphone PBX from version 16r1

== Overview ==
The Documents App is a file storage app that is organized into individual directories and checks user permissions. In this version, it only provides a plugin app for other apps.

== Features ==

* File storage plugin app
* Organized in directories
* User permission checks
* Convenient local editing of files with the myApp Client for Windows

== Requirements ==

* innovaphone myApps
* innovaphone AppPlatform
* An app that uses the Documents plugin app, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]
* An app for checking user permissions, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]

== Apps ==

* Plugin app only

== Licensing ==

* UCC license required for each user

== Configuration ==

==== Settings Plugin ====
An PBX app object is required that is permitted for users. The app object must have access to the Connect app.

==== Connect integration ====
The user must have access to the hidden Documents app.

== Troubleshooting ==

==== App Service Log ====
* App
* App WebSocket
* Files

== Related Articles ==
[[Reference16r1:Concept_App_Connect]]

Reference16r1:Concept App Service Conference Invitation Management

2026-03-10T14:09:03Z

Teh: Created page with "{{FIXME|reason=This product is in the beta phase and is not yet finished}} Apps  == Applies To == == Overview == == Features == == Requirements == == Apps == == Licensing == == Technical Overview == == Technical Concept == ==== Additional Information ==== == Configuration == ==== PBX Manager Plugin ==== == Troubleshooting == == Known Issues == == Related Articles =="

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

== Overview ==

== Features ==

== Requirements ==

== Apps ==

== Licensing ==

== Technical Overview ==

== Technical Concept ==

==== Additional Information ====

== Configuration ==

==== PBX Manager Plugin ====

== Troubleshooting ==

== Known Issues ==

== Related Articles ==

Reference16r1:Apps/PbxManager/App Documents

2026-03-04T11:21:47Z

Teh: Created page with "This page describes the PBX Settings Plugin of the Documents App. The app is only available as a plugin app and is not visible to users as a standalone app. This app must be allowed for both users and other app services. == Individual Documents App Configuration == Following items can be configured in a PBX App object: * '''Name''': Object long name * '''SIP''': Object name. Allowed characters according to the [{{NAMESPACE}}:PBX/Objects#General_Object_Properties gene..."

This page describes the PBX Settings Plugin of the Documents App.

The app is only available as a plugin app and is not visible to users as a standalone app.

This app must be allowed for both users and other app services.

== Individual Documents App Configuration ==
Following items can be configured in a PBX App object:

* '''Name''': Object long name
* '''SIP''': Object name. Allowed characters according to the [{{NAMESPACE}}:PBX/Objects#General_Object_Properties general object properties]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.

=== App permissions ===
Allowed apps for the Documents service which provides the com.innovaphone.tagging API for checking user permissions.

=== Configuration Templates ===
Select configuration templates to be applied for the Documents app object.

Reference16r1:Concept App Service Documents

2026-03-04T10:42:09Z

Teh: /* Features */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

* innovaphone PBX from version 16r1

== Overview ==
The Documents App is a file storage app that is organized into individual directories and checks user permissions. In this version, it only provides a plugin app for other apps.

== Features ==

* File storage plugin app
* Organized in directories
* User permission checks
* Convenient local editing of files with the myApp Client for Windows

== Requirements ==

* innovaphone myApps
* innovaphone AppPlatform
* An app that uses the Documents plugin app, e.g. innovaphone Connect App
* An app for checking user permissions, e.g. innovaphone Connect App

== Apps ==

* Plugin app only

== Licensing ==

* UCC license required for each user

== Configuration ==

==== Settings Plugin ====
An PBX app object is required that is permitted for users. The app object must have access to the Connect app.

==== Connect integration ====
The user Connect app must have access to the Documents app.

== Troubleshooting ==

==== App Service Log ====

* App

== Related Articles ==

Reference16r1:Concept App Service Documents

2026-03-04T10:38:23Z

Teh:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

* innovaphone PBX from version 16r1

== Overview ==
The Documents App is a file storage app that is organized into individual directories and checks user permissions. In this version, it only provides a plugin app for other apps.

== Features ==

* File storage plugin app
* Organized in directories
* User permission checks

== Requirements ==

* innovaphone myApps
* innovaphone AppPlatform
* An app that uses the Documents plugin app, e.g. innovaphone Connect App
* An app for checking user permissions, e.g. innovaphone Connect App

== Apps ==

* Plugin app only

== Licensing ==

* UCC license required for each user

== Configuration ==

==== Settings Plugin ====
An PBX app object is required that is permitted for users. The app object must have access to the Connect app.

==== Connect integration ====
The user Connect app must have access to the Documents app.

== Troubleshooting ==

==== App Service Log ====

* App

== Related Articles ==

Reference16r1:Concept App Service Documents

2026-03-04T10:06:50Z

Teh: /* Applies To */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

* innovaphone PBX from version 16r1

== Overview ==

== Features ==

== Requirements ==

== Apps ==

== Licensing ==

== Technical Overview ==

== Technical Concept ==

==== Additional Information ====

== Configuration ==

==== PBX Manager Plugin ====

== Troubleshooting ==

== Known Issues ==

== Related Articles ==

Reference15r1:Apps/PbxManager/App Fax

2025-03-24T14:15:43Z

Teh: /* App Service Configuration */

This page describes the PBX Settings Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Settings Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== Change configuration ===
* '''Delete fax jobs automatically''': Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* '''Send with high resolution''': The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== Default settings for mail notifications ===
* '''Incoming notification''': generate email on incoming fax
* '''Forwarding as PDF''': forward received fax as PDF attachment
* '''Transmission confirmation''': generate email on fax transmission
* '''Transmission report as PDF''': generate email with send report as PDF attachment
* '''Error notification''': generate email on errorneous fax transmission
* '''Language''': set email language. Supported values are ba, ca, cs, da, de, en, es, et, eu, fi, fr, hr, hu, it, lv, mk, nl, no, pl, pt, ro, rs, si, sv, th, tr; non-supported values are replaced by en.
* '''Timezone''': set email timezone according to [https://www.iana.org/time-zones IANA definitions]. For a better overview you may refer to [https://www.iplocate.com/de/resources/timezones/list-of-timezones this page].
Pre-set default for language and timezone are the administrator values.

=== SMTP server configuration ===
The email receiving for the Mail2Fax feature can be enabled and the authentication configured here:
* '''E-mail reception''': To be turned on.
* '''Domain''': Used to filter the recipient address of the received mails' address list. If not set, the configured app domain of the app service is used.
* '''User name''': The login name for the SMTP authentication.
* '''Password''': The password for the SMTP authentication.

=== SMTP configuration ===
Required data for outgoing emails:
* '''Host name''': Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* '''Server[:port]''': Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* '''User name''': The login name of a valid user account at the SMTP server (mandatory).
* '''Password''': The password of the SMTP user account (mandatory).
* '''Sender address''': The email address of the sender in sent emails.
* '''Sender name''': The name of the sender in sent emails.
[https://sdk.innovaphone.com/13r2/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== HTTP API ===
* '''Key''': key for HTTP post command authentication. For details, refer to the [[{{NAMESPACE}}:Concept_App_Service_Fax#App_API|API concept]].

=== Customized texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

=== Mail background logo ===
* '''Include picture''': add myApps background logo in all HTML mail bodies
* '''Custom picture''': Base64-encoded data-image for customized background logo

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* '''Name''': Object long name
* '''SIP''': Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* '''Number''': Object number to be prepended for fax calls.
* '''International fax number''': Printed in the headline of fax document. The user (send) number is added, but not the node number.
* '''Company name''': Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
=== FAX interface ===
Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
* '''Device name''': Name of the device as defined in the Devices App
* '''Hardware ID''': Serial number (MAC) of a device
* '''Product''': innovaphone device model
* '''Available channels''': Amount of offered fax channels
* '''T.38 allowed''': T.38 codec for the fax transmission allowed
* '''Audio fax allowed''': Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
=== External resource ===
The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
* For fax objects: This is only used if no fax interface is registered.
* For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
=== Node and PBX ===
The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
=== Default Recipient ===
Faxes are received for this user or this fax group. If no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
=== Header of fax pages ===
A header line preset for a language can be selected or the header line can be individually modified. Usable variables are listed [[{{NAMESPACE}}:Gateway/Interfaces#Headline|here]].
=== Configuration Templates ===
Select configuration templates to be applied for the fax app object

Reference15r1:Apps/PbxManager/Conference

2025-02-27T09:33:05Z

Teh: /* Add or edit a conference */

Configure your Conferences

== Add or edit a conference==
; Name
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

; Allow web access
: If it is set, the web access of a room can be enabled in the conference app by users.

; International number
: External phone number of the PBX. This number is used for the construction of dial-in numbers within meeting invitations.

; Announcements
: Select the announcements to be played.
: Use [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types|predefined announcement packages]] depending on language and place them in the local files app.
:
: For example: create a folder conference with a subfolder for the languages that you want to use, e.g. de for German, en for English, nl for Dutch etc. Be aware, that the (sub)folders should not contain capital characters!
: Upload the language audio files in the respective subfolder.
: Share the folder conference with the files key and the language audio files are enabled for selection.

; Conference interface
: Search for available conference devices and select appropriate one for use.
: Possibility to
:* set used amount for seats at dedicated conference device and
:* choose use of PBX-channels-license to operate interface with.

; Node and PBX
: The PBX and node configuration of the PBX object.

; Virtual background for web access
: All applications configured in the PBX that provide the virtual background support API are listed here. When an application is authorized for the conference object, the external user web access application loads the virtual background feature library.

; Rooms
: Add static room(s) to be used for conferences
:* Display name: Room name displayed as endpoint and as the conference app name.
:* Number: Room number. Appended to the conference number for a direct dial-in.
:* Reserved channels: Amount of conference room participants.
:* PIN: Access authentication to enter the room.
:* Meetings: Creating meetings by users can be allowed or not. It is also possible to use a room only with meetings.
:: Possible options are:
:# Not Allowed: The conference room is only a static room. Scheduled meetings are not possible and the menu of scheduled meeting is hidden in the Conference App.
:# Allowed: The conference room can be used as a static room and for scheduled meetings.
:# Only Meetings: The conference room can be used for scheduled meetings only.
:* Video coder: Supported video codec for video conference.

; Conference Operator
: In addition to static rooms, ad-hoc rooms can be created with a conference operator. This can be reached with its own number and can be secured with a PIN. Voice prompts guide the user through the menu.
:* Number: Number to reach the operator. If no number is configured, a call to the conference object is routed to the operator by default. The operator number must be different from any existing room number.
:* PIN: To restrict access to the operator a 4-digit PIN can be configured. If left empty no PIN is required.
:* Video coder: A video encoder must be selected. If unsure, use VP8.

; Configuration templates
: Each app which is provided by the conference object can be enabled for users with configuration templates.

= Related Articles =
* [[{{NAMESPACE}}:Concept_Conference]]
* [[Course14:IT_Connect_-_08.1_Conferencing]]

[[Category:Concept Conference]]

Reference15r1:Apps/PbxManager/Conference

2025-02-25T11:12:18Z

Teh: /* Add or edit a conference */

Configure your Conferences

== Add or edit a conference==
; Name
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

; Allow web access
: If it is set, the web access of a room can be enabled in the conference app by users.

; International number
: External phone number of the PBX. This number is used for the construction of dial-in numbers within meeting invitations.

; Announcements
: Select the announcements to be played.
: Use [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types|predefined announcement packages]] depending on language and place them in the local files app.
:
: For example: create a folder conference with a subfolder for the languages that you want to use, e.g. de for German, en for English, nl for Dutch etc. Be aware, that the (sub)folders should not contain capital characters!
: Upload the language audio files in the respective subfolder.
: Share the folder conference with the files key and the language audio files are enabled for selection.

; Conference interface
: Search for available conference devices and select appropriate one for use.
: Possibility to
:* set used amount for seats at dedicated conference device and
:* choose use of PBX-channels-license to operate interface with.

; Node and PBX
: The PBX and node configuration of the PBX object.

; Virtual background for web access
: All applications configured in the PBX that provide the virtual background support API are listed here. When an application is authorized for the conference object, the external user web access application loads the virtual background feature library.

; Rooms
: Add static room(s) to be used for conferences
:* Display name: Room name displayed as endpoint and as the conference app name.
:* Number: Room number. Appended to the conference number for a direct dial-in.
:* Reserved channels: Amount of conference room participants.
:* PIN: Access authentication to enter the room.
:* Meetings: Creating meetings by users can be allowed or not. It is also possible to use a room only with meetings.
:: Possible options are:
:# Not Allowed: The conference room is only a static room. Scheduled meetings are not possible and the menu of scheduled meeting is hidden in the Conference App.
:# Allowed: The conference room can be used as a static room and for scheduled meetings.
:# Only Meetings: The conference room can be used for scheduled meetings only.

:* Video coder: Supported video codec for video conference.
:* Delete room: Erase the room from the conference.

; Conference Operator
: In addition to static rooms, ad-hoc rooms can be created with a conference operator. This can be reached with its own number and can be secured with a PIN. Voice prompts guide the user through the menu.
:* Number: Number to reach the operator. If no number is configured, a call to the conference object is routed to the operator by default. The operator number must be different from any existing room number.
:* PIN: To restrict access to the operator a 4-digit PIN can be configured. If left empty no PIN is required.
:* Video coder: A video encoder must be selected. If unsure, use VP8.

; Configuration templates
: Each app which is provided by the conference object can be enabled for users with configuration templates.

= Related Articles =
* [[{{NAMESPACE}}:Concept_Conference]]
* [[Course14:IT_Connect_-_08.1_Conferencing]]

[[Category:Concept Conference]]

Reference15r1:Apps/PbxManager/Conference

2025-02-25T10:52:47Z

Teh:

Configure your Conferences

== Add or edit a conference==
; Name
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

; Allow web access
: If it is set, the web access of a room can be enabled in the conference app by users.

; International number
: External phone number of the PBX. This number is used for the construction of dial-in numbers within meeting invitations.

; Announcements
: Select the announcements to be played.
: Use [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types|predefined announcement packages]] depending on language and place them in the local files app.
:
: For example: create a folder conference with a subfolder for the languages that you want to use, e.g. de for German, en for English, nl for Dutch etc. Be aware, that the (sub)folders should not contain capital characters!
: Upload the language audio files in the respective subfolder.
: Share the folder conference with the files key and the language audio files are enabled for selection.

; Conference interface
: Search for available conference devices and select appropriate one for use.
: Possibility to
:* set used amount for seats at dedicated conference device and
:* choose use of PBX-channels-license to operate interface with.

; Node and PBX
: The PBX and node configuration of the PBX object.

; Virtual background for web access
: All applications configured in the PBX that provide the virtual background support API are listed here. When an application is authorized for the conference object, the external user web access application loads the virtual background feature library.

; Rooms
: Add static room(s) to be used for conferences
:* Display name: Room name displayed as endpoint and as the conference app name.
:* Number: Room number. Appended to the conference number for a direct dial-in.
:* Reserved channels: Amount of conference room participants.
:* PIN: Access authentication to enter the room.
:* Meetings: Creating meetings by users can be allowed or not. It is also possible to use a room only with meetings. {{ConferenceRoomPanelRights}}
:* Video coder: Supported video codec for video conference.
:* Delete room: Erase the room from the conference.

; Conference Operator
: In addition to static rooms, ad-hoc rooms can be created with a conference operator. This can be reached with its own number and can be secured with a PIN. Voice prompts guide the user through the menu.
:* Number: Number to reach the operator. If no number is configured, a call to the conference object is routed to the operator by default. The operator number must be different from any existing room number.
:* PIN: To restrict access to the operator a 4-digit PIN can be configured. If left empty no PIN is required.
:* Video coder: A video encoder must be selected. If unsure, use VP8.

; Configuration templates
: Each app which is provided by the conference object can be enabled for users with configuration templates.

= Related Articles =
* [[{{NAMESPACE}}:Concept_Conference]]
* [[Course14:IT_Connect_-_08.1_Conferencing]]

[[Category:Concept Conference]]

Reference15r1:Concept Conference

2025-02-04T09:42:44Z

Teh: /* Conference App (innovaphone-pbx-conferencing-access) */ app name added

[[Category:Concept Conference]]

= Applies To =

* innovaphone PBX from version 13r3
* innovaphone devices supporting a CONF or SCNF interface

= Overview =
The innovaphone conference is provided by the [[Reference13r1:PBX/Objects/Conference| PBX Conference Object]]. It is used to create conference rooms which allows audio, video, application sharing and chat between all participants. The conference rooms can be joined via phone, WebRTC using any browser or myApps.

= Requirements =
* innovaphone PBX
* A multi-point control unit (MCU) or an innovaphone device with CONF or SCNF interface with [[Howto:Conferences, Resources and Licenses| appropriate channel licensing]]
* Optional Conference App licenses (App(innovaphone-pbx-conferencing)13). This license is necessary to create HTTP links that invite external participants.

= Configuration =
The configuration of the conference object is described in [[Course13:IT Connect - 08.1 Conferencing| this wiki article]].

= Features =
* Audio Conferencing
* Multi Video as described in [[Reference13r3:Concept Multi-Video-Conference| this wiki article]]
* Application sharing
* Chat
* Apps
* Using an innovaphone conference interface according to [[Reference13r1:Gateway/Interfaces| this wiki article]]
* Various voice prompts listed in [[Reference13r3:PBX/Objects/Conference/Announcement types| this wiki article]]
* PBX Manager Plugin as described in [[Reference13r3:Apps/PbxManager/Conference| this wiki article]]
* Web Access as described in [[Reference13r3:Concept Conference Web Access| this wiki article]]
* Meeting scheduling as described in [[Reference13r3:Concept Conference Meeting Invitations| this wiki article]]

== Codec-Filtering ==
If an innovaphone device is used, the video codec must be filtered, because these devices do not support transcoding. Each room can be configured to either H.264 or VP8 is to be filtered out. The most devices support VP8, so this is the normally selected codec which is to be passed.

== Chat ==
Chat messages can be exchanged between all participants of a conference room. The participant device must support instant messaging with the call signaling.

Chat messages are not stored permanently even for users with premium chat license. As long as one participant remains in the conference room, new participants receive the last 100 instant messages. When all participants of a room have left, all chat messages temporarily saved in this room are deleted.

= Apps =
The PBX conference object's name (H.323) must be SIP-compatible and must not start with a digit, otherwise the apps are not accessible.

== Conference Search API (innovaphone-pbx-conferencing-search) ==
The conference object provides a search app. This is a hidden app which provides the Search API (com.innovaphone.search) used by other apps. The app responses to search requests with matching room contacts. The contact data includes the default innovaphone conference icon. All conference rooms are also found with the translated words ''conference'' and ''room'' of the user's language as the search string.

The app searches only for static rooms, not for dynamically created rooms like meeting rooms. Therefore the app caches the conference object data for one hour and disconnects the connection to the PBX again.

The innovaphone PBX conferencing license is not necessary for this app.

== Conference App (innovaphone-pbx-conferencing-one) ==
The conference object provides an app for each configured static room. One innovaphone PBX conferencing license is necessary for each PBX user which uses these apps.

The apps show all participants of the conference room. Participants can be muted or thrown out. The room PIN can be changed.

The web access of the room can be configured, this link shown or mailed, as described in [[Reference13r3:Concept Conference Web Access| this wiki article]].
In addition, meeting links can be created, as described in [[Reference13r3:Concept Conference Meeting Invitations| this wiki article]].

== Conference App (innovaphone-pbx-conferencing-access) ==
The conference object provides also an app for ad hoc rooms created with the conference operator. One innovaphone PBX conferencing license is necessary for each PBX user which uses this app.

The app shows all participants of an ad hoc conference room. Participants can be muted or thrown out. The room PIN can be changed. Access to an existing ad hoc conference room is granted upon knowing the room number.

The name of the app is <object-h323>.access and it must be added to the user with the 'temporary' mode to have access to ad hoc conferences. Other modes are reserved for future use.

= Troubleshooting =
'''Conference object'''

The conference object has a trace option (Options tab). This option allows to investigate problems with the announcements or resource allocation. If you activate this option, innovaphone debug messages are created which can be seen in a trace.

'''SCNF/CONF interface'''

The conference interfaces (CONF/SCNF) have a trace option. This trace flag provides more information about the various calls connected to the conference interface.

Main Page

2025-01-17T05:33:04Z

Teh: /* Latest News */

__NOTOC__

<div style="margin:0px; margin-right:10px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0em 1em;">
== Remote Support ==
innovaphone only carries out scheduled remote maintenance via our ticket system by prior consultation. 
Please do not accept AnyDesk requests without prior appointment via ticket.

Please ensure that you download the [https://anydesk.com/en/downloads/windows latest AnyDesk version].

Please note: We cannot accept any liability for the external content of AnyDesk. AnyDesk is responsible for the content of its own software.
We are not liable for any damages resulting from the use of a non-updated or non-conforming version of AnyDesk.

== Searching ==
Searching in wiki works, but is sometimes cumbersome. However, you can have Google do the job for you. Try [https://www.google.de/search?q=site%3Ainnovaphone.com+xml+documentation <code>site:innovaphone.com your search terms</code>] to search the innovaphone sites for matches!

If you still don't find what you are looking for, [mailto:presales@innovaphone.com drop us a message]
</div>


<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">



== Latest News ==
[[User:Msc|Msc]] ([[User talk:Msc|talk]]) 13:26, 13 December 2024 (CET)
[[Support:Firmware V15r1 product/15r1/firmware 1510251 (beta1) available | Version 15r1 Beta1]] is now available from the [https://store.innovaphone.com/beta/download.htm Beta Store].

[[User:Teh|Teh]] ([[User talk:Teh|talk]]) 06:33, 17 January 2025 (CET)
[[Support:Firmware V14r2 product/14r2/firmware 1420444 (sr6) available | Version 14r2 Service Release 6]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Teh|Teh]] ([[User talk:Teh|talk]]) 06:33, 17 January 2025 (CET)
[[Support:Firmware V14r1 product/14r1/firmware 1410586 (sr11) available | Version 14r1 Service Release 11]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Teh|Teh]] ([[User talk:Teh|talk]]) 06:33, 17 January 2025 (CET)
[[Support:Firmware V13r3 product/13r3/firmware 138011 (sr23) available | Version 13r3 Service Release 23]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Tac|Tac]] ([[User talk:Tac|talk]]) 14:35, 12 December 2024 (CET)
[[Support:Firmware V12r2 product/12r2/firmware 125886 (sr72) available | Version 12r2 Service Release 72]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Cam|Cam]] 16:22, 18 September 2023 (CEST)
[[App Calculator beta1 available]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Sga|Sga]] ([[User talk:Sga|talk]]) 17:43, 15 September 2023 (CEST)
[[Support:Wireless Handset Firmware IP73 1011 (5.0.1) released | Wireless Handset Firmware IP73 1011 (5.0.1)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Gal|Gal]] ([[User talk:Gal|talk]]) 13:39, 31 July 2023 (CEST)
[[Support:Wireless Handset Firmware IP64 10314 (3.0.13)/IP65 10119 (3.0.13) released | Wireless Handset Firmware IP64 10314 (3.0.13)/IP65 10119 (3.0.13)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Cam|Cam]] 12:03, 31 July 2023 (CEST)
[[App Working final available]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Afi|Afi]] 15:38, 6 February 2023 (CET)
[[Support:Wireless_Handset_Firmware_IP62_3040621_(6.2.7)_released | Wireless Handset Firmware IP62 3040621 (6.2.7)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 13:13, 6 February 2023 (CET)
[[Support:WinPDM_Software_3130113_%284.1.8%29_released | WinPDM Software 3130113 (4.1.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 15:05, 11 February 2022 (CET)
[[Support:Wireless_Handset_Firmware_IP64_10313_(2.12.10)/IP65_10118_(2.12.10)_released | Wireless Handset Firmware IP64 10313 (2.12.10)/IP65 10118 (2.12.10)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:kwa|kwa]] 14:00, 16 June 2021 (CEST)
[[Support:iQM_Build_8029100_available | IQM Build 8029100 Hotfix34]] is now available from the [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Afi|Afi]] 12:46, 16 June 2021 (CEST))
[[Support:TAPI Service Provider 8188 (hotfix21) available|TAPI Service Provider 8188 (hotfix21)]] is now available from [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Linux_Application_Platform_100271_(sr64)_available | Linux Application Platform V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Innovaphone_Reporting_100271_(sr64)_available | innovaphone Reporting V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Innovaphone_Fax_100271_(sr64)_available | innovaphone Fax V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Innovaphone_Exchange_Calendar_Connector_100271_(sr64)_available | innovaphone Exchange Calendar Connector V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 18:21, 12 October 2020 (CEST)
[[Support:Wireless_Handset_Firmware_IP61_3022811_(4.7.8)/IP63_3022912_(4.7.8)_released | Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 21:30, 27 March 2020 (CET)
[[Support:Wireless_Handset_Firmware_and_Management_Software_product/9.00/wireless_100037_%28hotfix19%29_available | Wireless Package hotfix 19]] is now available from the [http://download.innovaphone.com/ice/9.00#wireless V9 download area].

[[User:Dde|Dde]] 07:56, 9 March 2020 (CET)
[[Support:App_Platform_build_90007_available | App Platform build 90007]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:kwa|kwa]] 14:00, 02 March 2020 (CET)
[[Support:Recording_Build_121100_available | innovaphone Recording SR29 build 121100]] is now available from the [http://download.innovaphone.com/ice/10.00/#recording V10 download area].
</div>

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">

== New Articles ==

{{Special:Newestpages/all/20}}
</div>

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em; font-size:1">
== More innovaphone Ressources ==
* [http://www.innovaphone.com Home Page]
* [http://download.innovaphone.com Download Site ]
* [http://my.innovaphone.com my.innovaphone ]
* [http://mantis.innovaphone.com/ Ticketing System ]
</div>

Reference15r1:Concept Conference

2025-01-15T10:24:37Z

Teh: /* Conference App (innovaphone-pbx-conferencing-access) */ only typing

[[Category:Concept Conference]]

= Applies To =

* innovaphone PBX from version 13r3
* innovaphone devices supporting a CONF or SCNF interface

= Overview =
The innovaphone conference is provided by the [[Reference13r1:PBX/Objects/Conference| PBX Conference Object]]. It is used to create conference rooms which allows audio, video, application sharing and chat between all participants. The conference rooms can be joined via phone, WebRTC using any browser or myApps.

= Requirements =
* innovaphone PBX
* A multi-point control unit (MCU) or an innovaphone device with CONF or SCNF interface with [[Howto:Conferences, Resources and Licenses| appropriate channel licensing]]
* Optional Conference App licenses (App(innovaphone-pbx-conferencing)13). This license is necessary to create HTTP links that invite external participants.

= Configuration =
The configuration of the conference object is described in [[Course13:IT Connect - 08.1 Conferencing| this wiki article]].

= Features =
* Audio Conferencing
* Multi Video as described in [[Reference13r3:Concept Multi-Video-Conference| this wiki article]]
* Application sharing
* Chat
* Apps
* Using an innovaphone conference interface according to [[Reference13r1:Gateway/Interfaces| this wiki article]]
* Various voice prompts listed in [[Reference13r3:PBX/Objects/Conference/Announcement types| this wiki article]]
* PBX Manager Plugin as described in [[Reference13r3:Apps/PbxManager/Conference| this wiki article]]
* Web Access as described in [[Reference13r3:Concept Conference Web Access| this wiki article]]
* Meeting scheduling as described in [[Reference13r3:Concept Conference Meeting Invitations| this wiki article]]

== Codec-Filtering ==
If an innovaphone device is used, the video codec must be filtered, because these devices do not support transcoding. Each room can be configured to either H.264 or VP8 is to be filtered out. The most devices support VP8, so this is the normally selected codec which is to be passed.

== Chat ==
Chat messages can be exchanged between all participants of a conference room. The participant device must support instant messaging with the call signaling.

Chat messages are not stored permanently even for users with premium chat license. As long as one participant remains in the conference room, new participants receive the last 100 instant messages. When all participants of a room have left, all chat messages temporarily saved in this room are deleted.

= Apps =
The PBX conference object's name (H.323) must be SIP-compatible and must not start with a digit, otherwise the apps are not accessible.

== Conference Search API (innovaphone-pbx-conferencing-search) ==
The conference object provides a search app. This is a hidden app which provides the Search API (com.innovaphone.search) used by other apps. The app responses to search requests with matching room contacts. The contact data includes the default innovaphone conference icon. All conference rooms are also found with the translated words ''conference'' and ''room'' of the user's language as the search string.

The app searches only for static rooms, not for dynamically created rooms like meeting rooms. Therefore the app caches the conference object data for one hour and disconnects the connection to the PBX again.

The innovaphone PBX conferencing license is not necessary for this app.

== Conference App (innovaphone-pbx-conferencing-one) ==
The conference object provides an app for each configured static room. One innovaphone PBX conferencing license is necessary for each PBX user which uses these apps.

The apps show all participants of the conference room. Participants can be muted or thrown out. The room PIN can be changed.

The web access of the room can be configured, this link shown or mailed, as described in [[Reference13r3:Concept Conference Web Access| this wiki article]].
In addition, meeting links can be created, as described in [[Reference13r3:Concept Conference Meeting Invitations| this wiki article]].

== Conference App (innovaphone-pbx-conferencing-access) ==
The conference object provides also an app for ad hoc rooms created with the conference operator. One innovaphone PBX conferencing license is necessary for each PBX user which uses this app.

The app shows all participants of an ad hoc conference room. Participants can be muted or thrown out. The room PIN can be changed. Access to an existing ad hoc conference room is granted upon knowing the room number.

The app must be added to the user with the 'temporary' mode to have access to ad hoc conferences. Other modes are reserved for future use.

= Troubleshooting =
'''Conference object'''

The conference object has a trace option (Options tab). This option allows to investigate problems with the announcements or resource allocation. If you activate this option, innovaphone debug messages are created which can be seen in a trace.

'''SCNF/CONF interface'''

The conference interfaces (CONF/SCNF) have a trace option. This trace flag provides more information about the various calls connected to the conference interface.

Reference15r1:Concept Conference

2025-01-03T09:51:18Z

Teh: /* Conference App (innovaphone-pbx-conferencing-one) */

[[Category:Concept_Conference]]

= Applies To =

* innovaphone PBX from version 13r3
* innovaphone devices supporting a CONF or SCNF interface

= Overview =
The innovaphone conference is provided by the [[Reference13r1:PBX/Objects/Conference| PBX Conference Object]]. It is used to create conference rooms which allows audio, video, application sharing and chat between all participants. The conference rooms can be joined via phone, WebRTC using any browser or myApps.

= Requirements =
* innovaphone PBX
* A multi-point control unit (MCU) or an innovaphone device with CONF or SCNF interface with [[Howto:Conferences%2C_Resources_and_Licenses | appropriate channel licensing]]
* Optional Conference App licenses (App(innovaphone-pbx-conferencing)13). This license is necessary to create HTTP links that invite external participants.

= Configuration =
The configuration of the conference object is described in [[Course13:IT_Connect_-_08.1_Conferencing | this wiki article]].

= Features =
* Audio Conferencing
* Multi Video as described in [[Reference13r3:Concept_Multi-Video-Conference | this wiki article]]
* Application sharing
* Chat
* Apps
* Using an innovaphone conference interface according to [[Reference13r1:Gateway/Interfaces | this wiki article]]
* Various voice prompts listed in [[Reference13r3:PBX/Objects/Conference/Announcement_types | this wiki article]]
* PBX Manager Plugin as described in [[Reference13r3:Apps/PbxManager/Conference | this wiki article]]
* Web Access as described in [[Reference13r3:Concept_Conference_Web_Access | this wiki article]]
* Meeting scheduling as described in [[Reference13r3:Concept_Conference_Meeting_Invitations | this wiki article]]

== Codec-Filtering ==
If an innovaphone device is used, the video codec must be filtered, because these devices do not support transcoding. Each room can be configured to either H.264 or VP8 is to be filtered out. The most devices support VP8, so this is the normally selected codec which is to be passed.

== Chat ==
Chat messages can be exchanged between all participants of a conference room. The participant device must support instant messaging with the call signaling.

Chat messages are not stored permanently even for users with premium chat license. As long as one participant remains in the conference room, new participants receive the last 100 instant messages. When all participants of a room have left, all chat messages temporarily saved in this room are deleted.

= Apps =
The PBX conference object's name (H.323) must be SIP-compatible and must not start with a digit, otherwise the apps are not accessible.

== Conference Search API (innovaphone-pbx-conferencing-search) ==
The conference object provides a search app. This is a hidden app which provides the Search API (com.innovaphone.search) used by other apps. The app responses to search requests with matching room contacts. The contact data includes the default innovaphone conference icon. All conference rooms are also found with the translated words ''conference'' and ''room'' of the user's language as the search string.

The app searches only for static rooms, not for dynamically created rooms like meeting rooms. Therefore the app caches the conference object data for one hour and disconnects the connection to the PBX again.

The innovaphone PBX conferencing license is not necessary for this app.

== Conference App (innovaphone-pbx-conferencing-one) ==
The conference object provides an app for each configured static room. One innovaphone PBX conferencing license is necessary for each PBX user which uses these apps.

The apps show all participants of the conference room. Participants can be muted or thrown out. The room PIN can be changed.

The web access of the room can be configured, this link shown or mailed, as described in [[Reference13r3:Concept_Conference_Web_Access | this wiki article]].
In addition, meeting links can be created, as described in [[Reference13r3:Concept_Conference_Meeting_Invitations | this wiki article]].

== Conference App (innovaphone-pbx-conferencing-access) ==
The conference object provides also an app for ad-hoc rooms created with the conference operator. One innovaphone PBX conferencing license is necessary for each PBX user which uses this app.

The app shows all participants of an ad-hoc conference room. Participants can be muted or thrown out. The room PIN can be changed. Access to an existing ad-hoc conference room is granted upon knowing the room number.

The app must be added to the user with the 'temporary' mode to have access to ad-hoc conferences. Other modes are reserved for future use.

= Troubleshooting =
'''Conference object'''

The conference object has a trace option (Options tab). This option allows to investigate problems with the announcements or resource allocation. If you activate this option, innovaphone debug messages are created which can be seen in a trace.

'''SCNF/CONF interface'''

The conference interfaces (CONF/SCNF) have a trace option. This trace flag provides more information about the various calls connected to the conference interface.

Reference15r1:Concept Conference

2025-01-02T17:21:03Z

Teh: Created page with " Category:Concept_Conference = Applies To = * innovaphone PBX from version 13r3 * innovaphone devices supporting a CONF or SCNF interface = Overview = The innovaphone conference is provided by the PBX Conference Object. It is used to create conference rooms which allows audio, video, application sharing and chat between all participants. The confere..."

[[Category:Concept_Conference]]

= Applies To =

* innovaphone PBX from version 13r3
* innovaphone devices supporting a CONF or SCNF interface

= Overview =
The innovaphone conference is provided by the [[Reference13r1:PBX/Objects/Conference| PBX Conference Object]]. It is used to create conference rooms which allows audio, video, application sharing and chat between all participants. The conference rooms can be joined via phone, WebRTC using any browser or myApps.

= Requirements =
* innovaphone PBX
* A multi-point control unit (MCU) or an innovaphone device with CONF or SCNF interface with [[Howto:Conferences%2C_Resources_and_Licenses | appropriate channel licensing]]
* Optional Conference App licenses (App(innovaphone-pbx-conferencing)13). This license is necessary to create HTTP links that invite external participants.

= Configuration =
The configuration of the conference object is described in [[Course13:IT_Connect_-_08.1_Conferencing | this wiki article]].

= Features =
* Audio Conferencing
* Multi Video as described in [[Reference13r3:Concept_Multi-Video-Conference | this wiki article]]
* Application sharing
* Chat
* Apps
* Using an innovaphone conference interface according to [[Reference13r1:Gateway/Interfaces | this wiki article]]
* Various voice prompts listed in [[Reference13r3:PBX/Objects/Conference/Announcement_types | this wiki article]]
* PBX Manager Plugin as described in [[Reference13r3:Apps/PbxManager/Conference | this wiki article]]
* Web Access as described in [[Reference13r3:Concept_Conference_Web_Access | this wiki article]]
* Meeting scheduling as described in [[Reference13r3:Concept_Conference_Meeting_Invitations | this wiki article]]

== Codec-Filtering ==
If an innovaphone device is used, the video codec must be filtered, because these devices do not support transcoding. Each room can be configured to either H.264 or VP8 is to be filtered out. The most devices support VP8, so this is the normally selected codec which is to be passed.

== Chat ==
Chat messages can be exchanged between all participants of a conference room. The participant device must support instant messaging with the call signaling.

Chat messages are not stored permanently even for users with premium chat license. As long as one participant remains in the conference room, new participants receive the last 100 instant messages. When all participants of a room have left, all chat messages temporarily saved in this room are deleted.

= Apps =
The PBX conference object's name (H.323) must be SIP-compatible and must not start with a digit, otherwise the apps are not accessible.

== Conference Search API (innovaphone-pbx-conferencing-search) ==
The conference object provides a search app. This is a hidden app which provides the Search API (com.innovaphone.search) used by other apps. The app responses to search requests with matching room contacts. The contact data includes the default innovaphone conference icon. All conference rooms are also found with the translated words ''conference'' and ''room'' of the user's language as the search string.

The app searches only for static rooms, not for dynamically created rooms like meeting rooms. Therefore the app caches the conference object data for one hour and disconnects the connection to the PBX again.

The innovaphone PBX conferencing license is not necessary for this app.

== Conference App (innovaphone-pbx-conferencing-one) ==
The conference object provides an app for each configured static room. One innovaphone PBX conferencing license is necessary for each PBX user which uses these apps.

The apps show all participants of the conference room. Participants can be muted or thrown out. The room PIN can be changed.

The web access of the room can be configured, this link shown or mailed, as described in [[Reference13r3:Concept_Conference_Web_Access | this wiki article]].
In addition, meeting links can be created, as described in [[Reference13r3:Concept_Conference_Meeting_Invitations | this wiki article]].

= Troubleshooting =
'''Conference object'''

The conference object has a trace option (Options tab). This option allows to investigate problems with the announcements or resource allocation. If you activate this option, innovaphone debug messages are created which can be seen in a trace.

'''SCNF/CONF interface'''

The conference interfaces (CONF/SCNF) have a trace option. This trace flag provides more information about the various calls connected to the conference interface.

Reference13r1:PBX/Objects/Conference

2024-12-17T14:59:53Z

Teh: /* Operator - IVR Menu */

The PBX conference object manages conference rooms with announcements and PIN protection.

The conference calls themselves are connected by one or more ''conference servers (MCU)'' registered to this object as devices. If more than one conference server is used, the different media types of the calls can be split to the different servers. innovaphone conference interfaces (CONF/SCNF) can be registered to this object to provide audio conferences with application sharing.

== General Configuration ==

The information about general configuration options shared by all objects can be found at [[{{NAMESPACE}}:PBX/Objects]].

== Devices ==
; Hardware Id
: The hardware Id must match with a hardware Id of a device on the General page of the object (not the Gateway). The device is registered to this object and provides the conference service.
; innovaphone device
: This should be ticked if the MCU is an innovaphone device.
; Media Types
: If a media type is ticked, calls to the registration includes this media type.
; Channels Licenses
: use PBX-Channels-Licenses to enable conference functionality
; Number of channels
: The number of the available channels of the MCU device or maximum number of channels to be used. Leaving it empty means 0 (no channels)
; MCU Room Numbers
: If the device isn't an innovaphone device and has several rooms, the room numbers which are dialed can be configured here.
; Registration
: If a registration to this hardware Id exists, the IP address of the registrar is shown here.

== Options ==
; Announcement URL
: The URL where the announcements were saved. A '$type' within the URL is substituted for the announcement type string, e.g. ''<nowiki>http://127.0.0.1/webdav/conference/$type.$coder?coder=g722,g711u,g711a,g723,g729,opus-nb,opus-wb</nowiki>''. The announcement types are listed [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types | here]].
; Extern Announcement Name/No: The conference object uses the internal HTTP interface, but announcements can also be provided by an external destination which name or number is to be configured here.
; Room number length
: If the room number length is zero, there is only one room available. If it isn't zero, static rooms can be configured and temporary rooms can be created with the operator.
; PIN
: If the room number length is zero, the PIN of the single conference room can be configured here. It can be empty or consists of four digits.
; Operator enabled
: If ticked, the operator is active. It can be reached if no room number is dialed.
; Trace
: If ticked, the trace of this PBX object is enabled.

== Rooms ==
Up to ''30'' static rooms can be configured. If the room is called by the first member, the configured number of channels and all media types must be available otherwise the room isn't available. If the last member of a room leaves it, the reserved channels are released again.
A room is defined by:
; Room number
: The room number must be unique; it length depends on the room number length option.
; Number of channels
: The number of channels which must be available to open a room at dial-in. If this count of member is reached, the room is full and no further caller can take part.
; Media types
: If a media type is ticked, it is used for the call. If not all ticked media types are available at dial-in, the room can't be opened.
: If the video coder H.264 is not chosen, it is filtered out; if the video coder VP8 is not chosen, it is filtered out before the user call is forwarded to the MCU.
; PIN
: The room PIN can be empty or consists of four digits. The PIN can't be a part of the dialing number.

== Operator ==
If the operator is enabled, users can dial in and create ad-hoc rooms. The requested number of channels for new rooms must be available and are reserved till the last member leaves the room.
; Operator Number
: The number which must be dialed instead of a room number to start the operator. Room numbers mustn't match with this number; numbers of new ad-hoc rooms are checked against it.
: '''Calls to the conference will be routed by default to the operator if no operator number is defined.'''
; PIN
: The operator PIN can be empty or consists of four digits. The PIN can't be a part of the dialing number.
; Media Types for ad-hoc rooms
: The media types which are used for the ad-hoc rooms. The room is also created if not all media types are available, but at least the audio channels.
: If the video coder H.264 is not chosen, it is filtered out; if the video coder VP8 is not chosen, it is filtered out before the user call is forwarded to the MCU.
; IVR Menu
: - PIN for access to operator
: - Room number (the count of the digits depends on the configuration, the room number length)
: - Number of reserved channels followed by #
: - 4 digit PIN followed by # (or only # for room without pin)

Note: Overlap dialing to the Operator number it's not supported, it's necessary to dial the Conference Object Number plus the Operator Number "En-Block".

== Announcements ==
For the supported announcements, please refer to [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement types|Reference13r1:PBX/Objects/Conference/Announcement types]].

== Notifications ==
For notification of new participants entering the room, the routing can be adjusted to play a simple DTMF-tone.
Follow the config drawing below for setup:

[[image:conf_interface_notification.png|/Conf_interface_notification.png]]

Remark: This does not apply to software conference interfaces (SNCF) as they do not support generation of DTMF sequences.

== myPBX-built-in Conference App ==

Remark: This is a myPBX-only-feature and has nothing to do with myAPPs-based V13-ConferenceAPP!

Starting with V12r2, a conference room can be accessed via built-in application icon in myPBX
; Configuration
: - define at least one room with a dedicated number
: - in the Apps tab of the ''User'' or ''ConfigurationTemplate'' object the room is shown as license named <confobjectname>.<roomnumber>. Tick to grant for user
: - within myPBX, the app has to be made visible via app administration page
; Licensing
: - for conference-app use, a conferencing-app-license (order no. 02-00050-001) is required per user
: - as conference-app is a built-in myPBX app, a myPBX (order no. 02-00031-001) or UC (order no. 02-00044-001) -license is required per user as well

[[Category:Concept Conference]]

Reference:Opensource

2024-09-10T14:51:43Z

Teh: /* Libfdt */

This opensource software is used in innovaphone products:

== AES ==
Our AES implementation in software is derived from:
* Official name: AES implementation by Brian Gladman
* Version number: Issue 09/09/2006
* URL for source: http://brgladman.org/oldsite/cryptography_technology/rijndael/aessrc.zip
* URL for license: http://brgladman.org/oldsite/cryptography_technology/rijndael/
* License type: BSD style

License and Copyright available in documentation:

Copyright (c) 1998-2006, Brian Gladman, Worcester, UK. All rights reserved.
LICENSE TERMS
The free distribution and use of this software in both source and binary
form is allowed (with or without changes) provided that:
1. distributions of this source code include the above copyright
notice, this list of conditions and the following disclaimer;
2. distributions in binary form include the above copyright
notice, this list of conditions and the following disclaimer
in the documentation and/or other associated materials;
3. the copyright holder's name is not used to endorse products
built using this software without specific written permission.
ALTERNATIVELY, provided that this notice is retained in full, this product
may be distributed under the terms of the GNU General Public License (GPL),
in which case the provisions of the GPL apply INSTEAD OF those given above.
DISCLAIMER
This software is provided 'as is' with no explicit or implied warranties
in respect of its properties, including, but not limited to, correctness
and/or fitness for purpose.

== AES-GCM ==
Our AES-GCM implementation in software is derived from:
* Official name: SharedAES-GCM
* Version number: v1.0
* URL for source: https://github.com/mko-x/SharedAES-GCM
* URL for license: https://github.com/mko-x/SharedAES-GCM
* License type: Public domain

/******************************************************************************
* THIS SOURCE CODE IS HEREBY PLACED INTO THE PUBLIC DOMAIN FOR THE GOOD OF ALL
*
* This is a simple and straightforward implementation of AES-GCM authenticated
* encryption. The focus of this work was correctness & accuracy. It is written
* in straight 'C' without any particular focus upon optimization or speed. It
* should be endian (memory byte order) neutral since the few places that care
* are handled explicitly.
*
* This implementation of AES-GCM was created by Steven M. Gibson of GRC.com.
*
* It is intended for general purpose use, but was written in support of GRC's
* reference implementation of the SQRL (Secure Quick Reliable Login) client.
*
* See: http://csrc.nist.gov/publications/nistpubs/800-38D/SP-800-38D.pdf
* http://csrc.nist.gov/groups/ST/toolkit/BCM/documents/proposedmodes/
* gcm/gcm-revised-spec.pdf
*
* NO COPYRIGHT IS CLAIMED IN THIS WORK, HOWEVER, NEITHER IS ANY WARRANTY MADE
* REGARDING ITS FITNESS FOR ANY PARTICULAR PURPOSE. USE IT AT YOUR OWN RISK.
*******************************************************************************/

== Big Number Library ==
* Official name: tropicssl multi-precision integer library
* Version number: tropicssl 0.10.1 with commits up to Friday January 18 2013
* URL for source: https://gitorious.org/tropicssl/tropicssl
* URL for license: https://gitorious.org/tropicssl/tropicssl/source/92bb3462dfbdb4568c92be19e8904129a17b1eed:library/bignum.c
* License type: BSD style

/*
* Multi-precision integer library
*
* Based on XySSL: Copyright (C) 2006-2008 Christophe Devine
*
* Copyright (C) 2009 Paul Bakker <polarssl_maintainer at polarssl dot org>
* Copyright (C) 2010 StackFoundry LLC <yann@stackfoundry.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the names of Tropic SSL,
* PolarSSL or XySSL nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

== ECDHE ==
* Official name: micro-ecc
* Version number: v1.1.
* URL for source: https://github.com/kmackay/micro-ecc
* URL for license: https://github.com/kmackay/micro-ecc/blob/master/LICENSE.txt
* License type: BSD 2-clause license

Copyright (c) 2014, Kenneth MacKay
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Download link: https://github.com/kmackay/micro-ecc

== OpenSSL (SHA, SHA2, DES, RC2, RC4) ==
Some functions from the OpenSSL library are used for the encryption and hash functions SHA, SHA2, DES, RC2, RC4.

* Official name: OpenSSL
* Version: v3.3.2
* URL for source: http://www.openssl.org/source/
* URL for license: http://www.openssl.org/source/license.html
* License type: BSD style

LICENSE ISSUES
==============

The OpenSSL toolkit stays under a dual license, i.e. both the conditions of
the OpenSSL License and the original SSLeay license apply to the toolkit.
See below for the actual license texts. Actually both licenses are BSD-style
Open Source licenses. In case of any license issues related to OpenSSL
please contact openssl-core@openssl.org.

OpenSSL License
---------------

/* ====================================================================
* Copyright (c) 1998-2011 The OpenSSL Project. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. All advertising materials mentioning features or use of this
* software must display the following acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
*
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please contact
* openssl-core@openssl.org.
*
* 5. Products derived from this software may not be called "OpenSSL"
* nor may "OpenSSL" appear in their names without prior written
* permission of the OpenSSL Project.
*
* 6. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit (http://www.openssl.org/)"
*
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
* ====================================================================
*
* This product includes cryptographic software written by Eric Young
* (eay@cryptsoft.com). This product includes software written by Tim
* Hudson (tjh@cryptsoft.com).
*
*/

Original SSLeay License
-----------------------

/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
* All rights reserved.
*
* This package is an SSL implementation written
* by Eric Young (eay@cryptsoft.com).
* The implementation was written so as to conform with Netscapes SSL.
*
* This library is free for commercial and non-commercial use as long as
* the following conditions are aheared to. The following conditions
* apply to all code found in this distribution, be it the RC4, RSA,
* lhash, DES, etc., code; not just the SSL code. The SSL documentation
* included with this distribution is covered by the same copyright terms
* except that the holder is Tim Hudson (tjh@cryptsoft.com).
*
* Copyright remains Eric Young's, and as such any Copyright notices in
* the code are not to be removed.
* If this package is used in a product, Eric Young should be given attribution
* as the author of the parts of the library used.
* This can be in the form of a textual message at program startup or
* in documentation (online or textual) provided with the package.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* "This product includes cryptographic software written by
* Eric Young (eay@cryptsoft.com)"
* The word 'cryptographic' can be left out if the rouines from the library
* being used are not cryptographic related :-).
* 4. If you include any Windows specific code (or a derivative thereof) from
* the apps directory (application code) you must include an acknowledgement:
* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
*
* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* The licence and distribution terms for any publically available version or
* derivative of this code cannot be changed. i.e. this code cannot simply be
* copied and put under another distribution licence
* [including the GNU Public Licence.]
*/

== MD4 ==
* Official name: RSA Data Security, Inc. MD4 Message-Digest Algorithm
* Version: 1.5 2012/03/20
* URL for source: http://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/sys/sys/
* URL for license: http://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/sys/sys/md4.h

/*
* This file is derived from the RSA Data Security, Inc. MD4 Message-Digest
* Algorithm and has been modified by Jason R. Thorpe <thorpej@NetBSD.ORG>
* for portability and formatting.
*/

/*
* Copyright (C) 1990-2, RSA Data Security, Inc. All rights reserved.
*
* License to copy and use this software is granted provided that it
* is identified as the "RSA Data Security, Inc. MD4 Message-Digest
* Algorithm" in all material mentioning or referencing this software
* or this function.
*
* License is also granted to make and use derivative works provided
* that such works are identified as "derived from the RSA Data
* Security, Inc. MD4 Message-Digest Algorithm" in all material
* mentioning or referencing the derived work.
*
* RSA Data Security, Inc. makes no representations concerning either
* the merchantability of this software or the suitability of this
* software for any particular purpose. It is provided "as is"
* without express or implied warranty of any kind.
*
* These notices must be retained in any copies of any part of this
* documentation and/or software.
*/

== MD5 ==
* Official name: RSA Data Security, Inc. MD5 Message-Digest Algorithm
* Version: 1.5 2012/03/20
* URL for source: http://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/sys/sys/
* URL for license: http://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/sys/sys/md5.h

/*
* This file is derived from the RSA Data Security, Inc. MD5 Message-Digest
* Algorithm and has been modifed by Jason R. Thorpe <thorpej@NetBSD.ORG>
* for portability and formatting.
*/

/*
* Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
* rights reserved.
*
* License to copy and use this software is granted provided that it
* is identified as the "RSA Data Security, Inc. MD5 Message-Digest
* Algorithm" in all material mentioning or referencing this software
* or this function.
*
* License is also granted to make and use derivative works provided
* that such works are identified as "derived from the RSA Data
* Security, Inc. MD5 Message-Digest Algorithm" in all material
* mentioning or referencing the derived work.
*
* RSA Data Security, Inc. makes no representations concerning either
* the merchantability of this software or the suitability of this
* software for any particular purpose. It is provided "as is"
* without express or implied warranty of any kind.
*
* These notices must be retained in any copies of any part of this
* documentation and/or software.
*/

== CHAP-MS ==
* Official name: Microsoft MS-CHAP compatible implementation
* URL for source: http://ftp.netbsd.org/pub/NetBSD/NetBSD-release-6/src/dist/pppd/pppd/
* URL for license: http://ftp.netbsd.org/pub/NetBSD/NetBSD-release-6/src/dist/pppd/pppd/chap_ms.h
* License type: BSD style

/*
* chap_ms.c - Microsoft MS-CHAP compatible implementation.
*
* Copyright (c) 1995 Eric Rosenquist. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The name(s) of the authors of this software must not be used to
* endorse or promote products derived from this software without
* prior written permission.
*
* THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
* SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

/*
* Modifications by Lauri Pesonen / lpesonen@clinet.fi, april 1997
*
* Implemented LANManager type password response to MS-CHAP challenges.
* Now pppd provides both NT style and LANMan style blocks, and the
* prefered is set by option "ms-lanman". Default is to use NT.
* The hash text (StdText) was taken from Win95 RASAPI32.DLL.
*
* You should also use DOMAIN\\USERNAME as described in README.MSCHAP80
*/

/*
* Modifications by Frank Cusack, frank@google.com, March 2002.
*
* Implemented MS-CHAPv2 functionality, heavily based on sample
* implementation in RFC 2759. Implemented MPPE functionality,
* heavily based on sample implementation in RFC 3079.
*
* Copyright (c) 2002 Google, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The name(s) of the authors of this software must not be used to
* endorse or promote products derived from this software without
* prior written permission.
*
* THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
* SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
*/

== slcompress ==
* Official name: SL compression
* Version: v1.6
* URL for source: http://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/sys/net/
* URL for license: http://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/sys/net/slcompress.h
* License type: BSD style

/*
* Copyright (c) 1989, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)slcompress.h 8.1 (Berkeley) 6/10/93
*/

/*
* Definitions for tcp compression routines.
*
* Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989:
* - Initial distribution.
*/

== ZLIB ==
* Official name: zlib
* Version number: 1.3.1
* URL for source: http://www.zlib.net/
* URL for license: http://www.zlib.net/manual.html
* License and Copyright available in documentation:

Copyright (C) 1995-2002 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
The origin of this software must not be misrepresented ; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
This notice may not be removed or altered from any source distribution.

== CRC32 ==
* Official name: CRC32
* URL for source: http://www.opensource.apple.com/source/xnu/xnu-1456.1.26/bsd/libkern/crc32.c
* URL for license: http://www.opensource.apple.com/source/xnu/xnu-1456.1.26/bsd/libkern/crc32.c
* License and Copyright available in documentation:

COPYRIGHT (C) 1986 Gary S. Brown. You may use this program, or
code or tables extracted from it, as desired without restriction.

CRC32 code derived from work by Gary S. Brown.

== Regex ==
* Official name: regular-expression library
* Version: 1.5
* URL for source: ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/lib/libc/regex
* URL for license: ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/lib/libc/regex/COPYRIGHT
* License type: BSD Style

$NetBSD: COPYRIGHT,v 1.5 2003/08/07 16:43:19 agc Exp $

Copyright 1992, 1993, 1994 Henry Spencer. All rights reserved.
This software is not subject to any license of the American Telephone
and Telegraph Company or of the Regents of the University of California.

Permission is granted to anyone to use this software for any purpose on
any computer system, and to alter it and redistribute it, subject
to the following restrictions:

1. The author is not responsible for the consequences of use of this
software, no matter how awful, even if they arise from flaws in it.

2. The origin of this software must not be misrepresented, either by
explicit claim or by omission. Since few users ever read sources,
credits must appear in the documentation.

3. Altered versions must be plainly marked as such, and must not be
misrepresented as being the original software. Since few users
ever read sources, credits must appear in the documentation.

4. This notice may not be removed or altered.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
/*-
* Copyright (c) 1994
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)COPYRIGHT 8.1 (Berkeley) 3/16/94
*/

== Opus audio codec ==
* Official name: Opus audio codec
* Version number: 1.1.1-beta 15 October, 2014
* URL for source: http://downloads.xiph.org/releases/opus/opus-1.1.1-beta.tar.gz
* URL for license: https://www.opus-codec.org/license/
* License type: BSD style

License and Copyright available in documentation:

* Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic,
* Jean-Marc Valin, Timothy B. Terriberry,
* CSIRO, Gregory Maxwell, Mark Borgerding,
* Erik de Castro Lopo
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of Internet Society, IETF or IETF Trust, nor the
* names of specific contributors, may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* Opus is subject to the royalty-free patent licenses which are
* specified at:
*
* Xiph.Org Foundation:
* https://datatracker.ietf.org/ipr/1524/
*
* Microsoft Corporation:
* https://datatracker.ietf.org/ipr/1914/
*
* Broadcom Corporation:
* https://datatracker.ietf.org/ipr/1526/

== Libfdt ==
* Official name: Flat Device Tree manipulation
* Version number: 1.4.1
* URL for source: https://git.kernel.org/cgit/utils/dtc/dtc.git
* URL for license: https://git.kernel.org/cgit/utils/dtc/dtc.git/tree/libfdt/libfdt.h
* License type: BSD style

/*
* libfdt - Flat Device Tree manipulation
* Copyright (C) 2006 David Gibson, IBM Corporation.
*
* libfdt is dual licensed: you can use it either under the terms of
* the GPL, or the BSD license, at your option.
*
* a) This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
* MA 02110-1301 USA
*
* Alternatively,
*
* b) Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* 1. Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer.
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

== PLCrashReporter ==
* Official name: In-process CrashReporter framework for iOS and Mac OS X
* Version number: v1.11.0
* URL for source: https://www.plcrashreporter.org/static/downloads/PLCrashReporter-1.11.0.zip
* URL for license: https://www.plcrashreporter.org/, https://opensource.org/licenses/mit-license.php, http://www.apache.org/licenses/LICENSE-2.0.html
* License type: MIT style, components have Apache license

License and Copyright available in documentation:

Except as noted below, PLCrashReporter is provided under the
following license:

Copyright (c) Microsoft Corporation.
Copyright (c) 2008 - 2014 Plausible Labs Cooperative, Inc.
All rights reserved.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Additional contributions have been made under the same license terms
as above, with copyright held by their respective authors:

Damian Morris <damian@moso.com.au>
Copyright (c) 2010 MOSO Corporation, Pty Ltd.
All rights reserved.

HockeyApp/Bitstadium
Copyright (c) 2012 HockeyApp, Bit Stadium GmbH.
All rights reserved.

The protobuf-c library, as well as the PLCrashLogWriterEncoding.c
file are licensed as follows:

Copyright 2008, Dave Benson.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with
the License. You may obtain a copy of the License
at http://www.apache.org/licenses/LICENSE-2.0 Unless
required by applicable law or agreed to in writing,
software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

== Unicode Consortium (Timezone mapping Microsoft → tz database) ==
* Official name: Mapping Zone → Tzid (also windowsZones.xml)
* Version number: 2017a, 7e00600
* URL for source: http://www.unicode.org/cldr/charts/29/supplemental/zone_tzid.html
* URL for license: http://www.unicode.org/copyright.html
* License and Copyright available in documentation:

UNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWARE

Unicode Data Files include all data files under the directories
http://www.unicode.org/Public/, http://www.unicode.org/reports/,
http://www.unicode.org/cldr/data/, http://source.icu-project.org/repos/icu/, and
http://www.unicode.org/utility/trac/browser/.

Unicode Data Files do not include PDF online code charts under the
directory http://www.unicode.org/Public/.

Software includes any source code published in the Unicode Standard
or under the directories
http://www.unicode.org/Public/, http://www.unicode.org/reports/,
http://www.unicode.org/cldr/data/, http://source.icu-project.org/repos/icu/, and
http://www.unicode.org/utility/trac/browser/.

NOTICE TO USER: Carefully read the following legal agreement.
BY DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING UNICODE INC.'S
DATA FILES ("DATA FILES"), AND/OR SOFTWARE ("SOFTWARE"),
YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE
TERMS AND CONDITIONS OF THIS AGREEMENT.
IF YOU DO NOT AGREE, DO NOT DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE
THE DATA FILES OR SOFTWARE.

COPYRIGHT AND PERMISSION NOTICE

Copyright © 1991-2017 Unicode, Inc. All rights reserved.
Distributed under the Terms of Use in http://www.unicode.org/copyright.html.

Permission is hereby granted, free of charge, to any person obtaining
a copy of the Unicode data files and any associated documentation
(the "Data Files") or Unicode software and any associated documentation
(the "Software") to deal in the Data Files or Software
without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, and/or sell copies of
the Data Files or Software, and to permit persons to whom the Data Files
or Software are furnished to do so, provided that either
(a) this copyright and permission notice appear with all copies of the Data Files or Software, or
(b) this copyright and permission notice appear in associated Documentation.

THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT OF THIRD PARTY RIGHTS.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THE DATA FILES OR SOFTWARE.

Except as contained in this notice, the name of a copyright holder
shall not be used in advertising or otherwise to promote the sale,
use or other dealings in these Data Files or Software without prior
written authorization of the copyright holder.

== The WebRTC project (Acoustic echo cancellation) ==
* Official name: The Android Open Source Project: The WebRTC project
* Version number: 5.0_r6
* URL for source: https://webrtc.googlesource.com/src/+/cd277b84dad534145445d3586145ff25aa5637ee
* URL for license: https://webrtc.googlesource.com/src/+/cd277b84dad534145445d3586145ff25aa5637ee
* License type: BSD Style
* License and Copyright available in documentation:

Copyright (c) 2011, The WebRTC project authors. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.

* Neither the name of Google nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

* Included patents text:

Additional IP Rights Grant (Patents)

"This implementation" means the copyrightable works distributed by
Google as part of the WebRTC code package.

Google hereby grants to you a perpetual, worldwide, non-exclusive,
no-charge, irrevocable (except as stated in this section) patent
license to make, have made, use, offer to sell, sell, import,
transfer, and otherwise run, modify and propagate the contents of this
implementation of the WebRTC code package, where such license applies
only to those patent claims, both currently owned by Google and
acquired in the future, licensable by Google that are necessarily
infringed by this implementation of the WebRTC code package. This
grant does not include claims that would be infringed only as a
consequence of further modification of this implementation. If you or
your agent or exclusive licensee institute or order or agree to the
institution of patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that this
implementation of the WebRTC code package or any code incorporated
within this implementation of the WebRTC code package constitutes
direct or contributory patent infringement, or inducement of patent
infringement, then any patent rights granted to you under this License
for this implementation of the WebRTC code package shall terminate as
of the date such litigation is filed.

== dTree ==
* Official name: dTree
* Version number: 2.05
* URL for source: https://destroydrop.com/javascripts/tree/dtree.zip
* URL for license: https://destroydrop.com/javascripts/tree/
* License type: non-standard (see below)
* License and Copyright available in documentation:

/*--------------------------------------------------|
| dTree 2.05 | www.destroydrop.com/javascript/tree/ |
|-------------------------------------------------- |
| Copyright (c) 2002-2003 Geir Landrö |
| |
| This script can be used freely as long as all |
| copyright messages are intact. |
| |
| Updated: 17.04.2003 |
|--------------------------------------------------*/

== STLport ==
* Official name: STLport
* Version number: 5.2.1
* URL for source: https://sourceforge.net/projects/stlport/files/STLport/STLport-5.2.1/STLport-5.2.1.tar.bz2
* URL for license: https://sourceforge.net/projects/stlport/files/STLport/STLport-5.2.1/STLport-5.2.1.tar.bz2
* License type: non-standard (see below)
* License and Copyright available in documentation:

This software is being distributed under the following terms:
*
*
* Copyright (c) 1994
* Hewlett-Packard Company
*
* Copyright (c) 1996-1999
* Silicon Graphics Computer Systems, Inc.
*
* Copyright (c) 1997
* Moscow Center for SPARC Technology
*
* Copyright (c) 1999-2003
* Boris Fomitchev
*
* This material is provided "as is", with absolutely no warranty expressed
* or implied. Any use is at your own risk.
*
* Permission to use or copy this software for any purpose is hereby granted
* without fee, provided the above notices are retained on all copies.
* Permission to modify the code and to distribute modified code is granted,
* provided the above notices are retained, and a notice that the code was
* modified is included with the above copyright notice.
*
**********************************************************************

Reference14r2:Gateway/Interfaces

2024-07-16T15:13:51Z

Teh: Created page with "{{Special:Prefixindex/Reference14r2:Gateway/Interfaces}} The display of the gateway’s configurable '''interfaces''' is organized in columns: * '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "Administration/Gateway/Interfaces/Interface (ISDN & virtual interfaces)". * '''CGPN In, CDPN In, CGPN Out, CDPN Out:..."

{{Special:Prefixindex/Reference14r2:Gateway/Interfaces}}

The display of the gateway’s configurable '''interfaces''' is organized in columns:

* '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "[[#CGPN.2FCDPN_Mappings|Administration/Gateway/Interfaces/Interface (ISDN & virtual interfaces)]]".
* '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are contained in the chapter entitled "[[#CGPN.2FCDPN_Mappings|Administration/Gateway/Interfaces/CGPN-CDPN Mappings]]" further down in the text.
* '''State:''' The current state of the interface at physical and at protocol level. Possible states are: ''Up'', ''Down''.
* '''Registration:''' If a terminal has successfully registered with an ISDN, SIP or virtual interface, then this is indicated in this column through specification of the IP address <Name of the VoIP interface:Call number:IP address>.

== Interface (ISDN, SIP & virtual interfaces) ==

Clicking the name of an interface in the Interface column opens a popup page, on which the interfaces can be individually configured. Like the PBX objects, this popup page also contains standard entry fields that occur, more or less, in all interfaces. These standard fields are:

* '''Name:''' The descriptive name of the interface.
* '''Disable:''' A checked check box disables the relevant interface.
* '''Tones:''' The standard calling tone for the relevant interface is set with the Tones list box.
* '''Interface Maps:''' The interface can be configured as a point-to-point connection (Point-to-Point), as a point-to-multipoint connection (Point-to-Multipoint) or manually (Manual) using CGPN/CDPN maps.
See description further down in the text.
* '''Registration:''' With the Registration list box, an H.323 registration or a SIP registration can be initiated for ISDN interfaces. The routes to be handled as incoming and outgoing calls on the relevant interface are automatically created here (see "[[Reference:Administration/Gateway/Routes|Administration/Gateway/Routes]]").

=== ISDN interfaces (PPP, TEL1-4, BRI1-4, PRI1-4) ===

After selection of an '''interface map''', the relevant section is displayed. If Point-to-Point is selected, the Interface Maps Point-to-Point section is displayed:

* '''Area Code:''' The number of the local area (for example, 7031). http://en.wikipedia.org/wiki/List_of_dialling_codes_in_Germany
* '''Subscriber Number:''' The local network number (for example, 73009).
* '''National Prefix:''' The national prefix (for example, 0).
* '''International Prefix:''' The international prefix (for example, 00).

If Trunk Point-to-Multipoint is selected, the Interface Maps Point-to-Multipoint section is displayed:
* '''MSN1-3 / Ext.:''' For every ISDN basic access, several call numbers can be configured. The innovaphone gateways support up to three multiple subscriber numbers (MSN1-3), followed by the extension (Ext.), which represents the extension to which the MSN is to be mapped.
* '''National Prefix:''' The national prefix (for example, 0).
* '''International Prefix:''' The international prefix (for example, 00).

==== Coder Preferences section: ====

After selection of a registration method, the '''Coder Preferences''' section is displayed together with the relevant Registration section.

The standard entry fields in the Coder Preferences section are:

* '''Model:''' The Model list box allows you to select the coder to be used. The coders available for selection are: ''G711A, G711u, G723-53, G729A, G726-32 and XPARENT''. If the remote VoIP device does not support the set coder, a commonly supported coder is used, unless the Exclusive check box was enabled.

Note: The codec ''Clearmode'' is chosen when the bearer capability is not Audio or Speech, that means if the B-channel has 'Unrestricted Digital Information’
means data will be sent via the B-channel - then the codec ''Clearmode'' will be in use (NB: ''Clearmode'' used to be called ''XPARENT'' in previous versions).

* '''Frame:''' Determines the packet size used in transmitting voice data (in ms). Larger packets cause a greater delay in voice data transmission, but cause less load on the network, since the overhead involved in transporting the packets in the network is lower. The higher the packet size used, the lower the bandwidth effectively used.

'''Encoding method | Packet size | Bandwidth'''
---------------------------------------------
G.711 | 30ms | 77kb
G.711 | 90ms | 68kb
---------------------------------------------
G.729 | 30ms | 21kb
G.729 | 90ms | 12kb

* '''Exclusive:''' A checked check box enforces the set encoding (Model), regardless of whether it is supported by the remote VoIP device.
* '''Silence Compression:''' A checked check box enables SC (Silence Compression). With SC, no data is transmitted during pauses in the conversation. This also allows bandwidth to be saved without quality loss.
* '''Enable T.38:''' A checked check box enables the T.38 Fax-over-IP protocol. If a fax machine was connected to the relevant interface, then this check box must be enabled; otherwise, fax transmissions are not handled.
* '''Enable PCM:''' A checked check box enables the PCM switch (Pulse Code Manipulation). Calls from one interface to another interface are then handled directly over the ISDN PCM bus, which in turn saves DSP channels. This entry field is optional and is displayed only in particular devices.
* '''No ICE''' disables ''Interactive Connection Establishment'' (see [[{{NAMESPACE}}:Concept ICE]])

'''Registration section:'''

All non-virtual interfaces additionally have the '''Registration''' section after selection of the registration method.

==== H.323 Registration section ====

The entry fields for an '''H.323 registration''' are:
* '''Gatekeeper Address (primary):''' The primary gatekeeper IP address at which the interface is to register. If the primary gatekeeper is located on the same device, the local IP address 127.0.0.1 can also be entered here.
* '''Gatekeeper Address (secondary):''' The secondary gatekeeper IP address at which the interface is to register, if registration with the primary gatekeeper fails. If the secondary gatekeeper is located on the same device, the local IP address 127.0.0.1 can likewise be entered here.
* '''Gatekeeper ID:''' It is also sufficient to specify only the Gatekeeper ID (see also the chapter entitled "[[Reference:Administration/Gateway/General|Administration/Gateway/General]]").
* '''Name:''' The unique, descriptive H.323 name of the interface or registration.
* '''Number:''' The unique E.164 call number of the interface or registration.
* '''Password / Retype:''' The security of the registration can be raised by specifying a password (Password). The password must be confirmed (Retype).
* '''Supplementary Services (with Feature Codes):''' A checked check box enables the use of additional features (Feature Codes). See description in the chapter entitled "[[Reference:Administration/Gateway/General|Administration/Gateway/General]]".
* '''Dynamic Group:''' A dynamic group can be added to the H.323 registration. Groups can be configured as static, dynamic-in or dynamic-out. For members of static groups, calls are always signaled. It works differently for members of dynamic groups, which register with or unregister from a group dynamically using a function key (Join Group). The difference between dynamic-in and dynamic-out lies in whether the object is to be contained in the relevant group as standard (in) or not (out).
See also description in the chapter entitled "[[Reference:Administration/PBX/Objects|Administration/PBX/Objects]]".
* '''Direct Dial:''' Using Direct Dial, a call setup to the specified call number is initiated as soon as the handset is picked up. A conceivable scenario would be a lift emergency telephone that is connected with the security control room, for example.
* '''Locked White List:''' Here, you can specify a comma-separated list of call numbers that may also be dialed in the case of a locked telephone (for example, emergency services numbers, like 110, 911).

==== SIP Registration section ====

The entry fields for a '''SIP registration''' are:
* '''Server Address (primary):''' The optional IP address of the SIP provider to where the SIP messages (REGISTER,INVITE,etc.) are to be sent. Only necessary if either the IP address cannot be obtained from the SIP URI's domain or a proxy server is to be used.
* '''Server Address (secondary):''' Backup IP address used if the SIP server on the primary IP address does not answer anymore.
* '''ID:''' Here you enter the registration ID followed by the SIP provider domain name (for example 8111111e0@sipgate.de).
* '''STUN Server:''' Only necessary if the SIP server is outside the private network.
* '''Username:''' Username for authorization (only if different from the registration ID).
* '''Password / Retype:''' The password for authorization must be specified here (Password) and confirmed (Retype).

=== FXO interfaces ===

Basically the same configuration is used as for ISDN interfaces.

To receive calling line identification a block-dial route must be used for incoming calls to delay the forwarding of the received call until after the calling line id was received. Please note that you must not use an '!' (exclamation mark) as part of the ''Number Out'' field of the route (see [[{{NAMESPACE}}:Gateway/Routes/Map|Number In/Out]]), as this disables the ''en-bloc'' feature.

=== SIP interfaces (SIP1-4) ===

In addition to the ISDN interfaces (PPP, TEL1-4, BRI1-4, PRI1-4) and virtual interfaces (TEST, TONE, HTTP), there are also four SIP interfaces (SIP1-4), which can be used to obtain a trunk line from a SIP provider, for example. For a description of the entry fields, please refer to the description of the SIP registration above. There are, however, three further entry fields:

* '''Name:''' A descriptive name for the interface.
* '''Disable:''' A switch to temporarily disable this interface without deleting the configuration.
* '''From Header:''' Interoperability option for outgoing calls. Controls the way the CGPN is transmitted to the SIP provider.
** '''AOR:''' The From header contains the fixed registration URI (AOR). The actual calling party number and name will be transmitted inside the ''P-Preferred-Identity'' header (RFC 3325).
** '''AOR with CGPN as display:''' The From header contains the fixed registration URI (AOR) with the calling party number as display string in front of the AOR.
** '''CGPN in user part of URI:''' The From header contains an URI with the calling party number as user part (left from @).
* '''Registration:''' Corresponds to the Registration entry field of the ISDN interfaces. After selection of H.323, the Registration for H.323 section is displayed, enabling registration of this SIP trunk interface with a local innovaphone PBX. After selection of SIP, the Registration for SIP section is displayed, enabling in turn registration with a local non-innovaphone SIP PBX.

To obtain a trunk line from a SIP provider, you must proceed as follows:

# Open one of the four SIP interfaces.
# Enter SIP Account data (ID, STUN server, Account, password).
# Under Registrations, link the SIP registration via H.323 to a PBX object of the Trunk type created beforehand (specification of the GK ID or GK address and the H.323 name or E.164 call number is sufficient).
# Confirm with OK.

A successful registration is displayed in the overview page Administration/Gateway/Interfaces as follows:
{| border=1
! style="background:#DCDCDC;"| State (IP of the SIP provider) !! style="background:#DCDCDC;"| Alias (PBX user object) !! style="background:#DCDCDC;"| Registration (IP of the PBX)
|- valign="top" align="center"
| For example, 217.10.79.9 (sipgate.de)
| H.323 name:E.164 no. SIPTrunk:8
| --> 127.0.0.1
|}

In the example above, the trunk line of the SIP carrier sipgate.de is picked up using the Trunk PBX object with the name SIPTrunk and the call number 8. The dialing of the call number 807031730090 therefore initiates a call at innovaphone AG via the configured SIP carrier.

=== Virtual interfaces (TEST, TONE, HTTP, SIG0/1) ===

The non-configurable, internal interface TEST is only usable as the destination for a call. If a call is received on this interface, the music on hold contained in the non-volatile memory is played. Incoming calls must be in G.729A or G.723 format; other formats are not supported. Suffix dialing digits are ignored.
The internal interface TONE is only usable as the destination for a call. If a call is received on this interface, it is connected and the configured dial tone (Tones) is played. This happens particularly with least-cost-routing scenarios, where the call can only be switched once some of the dialed digits have been analyzed. In the meantime, the dial tone is played via the TONE interface. Suffix dialing digits are ignored. The TONE interface can process several calls.
The non-configurable, internal interface HTTP is only usable as the destination for a call. If a call is received on this interface, music on hold, an announcement or some other spoken information is played from a Web server. The configuration only makes sense in combination with the innovaphone PBX.

The SIG0/SIG1 are virtual interfaces that often are hidden, only are displayed in newer versions and/or devices on test/license mode. This Interfaces are used mainly for SOAP applications be able to perform calls via the Gateway (ex: For automated call tests).

=== Conferencing interface (CONF and SCNF) ===
NB: this is a low-level interface. To implement application level conference rooms, please refer to [[{{NAMESPACE}}:PBX/Objects/Conference]] (v11r1 and up) and [[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference]].

The CONF interface is currently available on IP6010, IP3010, IP1060, IP0010, IP6000, IP800, IP305, IP3011, IP811 and IP1130. One or more CONF interfaces can be used to create a conferencing unit. Up to 60 (IPxx10), up to 10 (IP800) or up to 4 (IP305) subscribers can be in a single conference. Each call that ends up in a CONF interface takes one conference channel resource plus a DSP resource (there is an exception were DSP it's not used, when using PCM option for an ISDN connection however the incall commands will not work in this mode). A single CONF interface can host multiple conferences, which are identified by a unique number. Conference room ids must not overlap (that is, a room's id must not match the prefix of another id). A single conference cannot span across more than one interface. However, multiple interfaces can be stacked to provide more conferences than one interface's capacity would allow.

'''Note:'''
One DSP channel + One Conference channel is in use for each user in a conference call. We can see this values in the General Info screen of the Gateways

[[Image:Confchannels.png]]

'''Note:'''
Enable the interworking flag of the route to the CONF interface to enable the hold-/retrieve-notify support.

'''Note:'''
Some early IP6000 do not support this feature. Refer to the [[Howto:Multi-Party Conferencing with early IP6000|upgrade details]] if you consider upgrading your hardware.

The behavior of the interface is controlled by various call-setup and in-call commands and remote controls as follows.

==== Call-Setup Commands ====

The called party number in each call setup is interpreted as call-setup command. Also, additional digits received as info-elements are interpreted too. This is why calls must either be sent with ''sending complete'' property or the called party number must be terminated with a '#'. The ''sending complete'' property is activating by setting ''Force Enblock'' in the route toward the CONF interface.

===== Create a new room with a unique room number: *1 =====

This command creates a new conference room with a new, unique id. The syntax is

<code>*1</code>''<options>''<code>#</code> 
or 
<code>*1</code>''<nowiki><prefix></nowiki><nowiki><options></nowiki><code>#</code>''

Valid Options are

*<code>*1</code>''<nowiki><channel-max></nowiki>''
*<code>*2</code>''<nowiki><channel-reserve></nowiki>''
*<code>*3</code>''<nowiki><prefix></nowiki>''
*<code>*4</code>''<nowiki><match></nowiki>''
*<code>*5</code>''<nowiki><id-length></nowiki>''
*<code>*81</code>
*<code>*82</code>
*<code>*83</code>

''<nowiki><channel-max></nowiki>'' is used to set the maximum number of conference channels which shall be allowed in this interface at a time. The limit can be used for example to make sure the CONF interface does not consume all of the DSP channels on a gateway which is used as a trunk line interface too. NB: as of V9 release, you must specify the <code>*1</code>''<nowiki><channel-max></nowiki>'' option correctly. If you omit it, the CONF interface will accept more <code>*2</code>''<nowiki><channel-reserve></nowiki>'' reservations than it is capable to satisfy.

''<nowiki><channel-reserve></nowiki>'' is used to indicate the minimum number of conference channels which shall be available in the new conference room. Only 2 digits may follow <code>*2</code> so that a maximum of 99 channels is possible. If the <code>*2</code> option is used and 2 digits follow, the whole command is considered finished and the trailing <code>#</code> may thus be left out. Please note that due to this, the <code>*2</code> option should be the last option used.

''<nowiki><prefix></nowiki>'' is used as prefix for the conference id created. If more than one CONF interface is used, this prefix can be used to enforce unique conference ids across all interfaces. The prefix may be empty. It may be specified as value for the <code>*3</code> option, or - as a shorthand notation - directly following the initial <code>*1</code> command introducer.

''<nowiki><match></nowiki>'' is a digit string which is used to verify the room number (specified as ''prefix'') requested. If the requested room number does not begin with the specified ''match'', the CONF interface will reject the call with cause code ''no channel available''. This can be used to route calls for fixed room number to the appropriate CONF interface.

''<nowiki><id-length></nowiki>'' specifies the length of the random part of the created room number. It defaults to 6 if not specified.

<code>*81</code> is the ''disconnect control'' option. If the disconnect control option is enabled and the caller of the conference disconnects the conference call, all other calls in this conference room are automatically disconnected.

<code>*82</code> is the ''remote control connect'' option. If an user with the remote control connect option creates a conference room, the conference sends an alerting signal to incoming calls to this conference room instead of a connect signal first and waits for a remote control connect facility for each call before a call is connected.

<code>*83</code> is the ''multi-video off'' option. If a room is created with this option, no multi-video is offered to all calls to this room.

The new room is only created if the required channels can be provided and the maximum number of channels used by the interface is not exceeded. If the room can be created, it is joined, too. The room number (conference id) is returned as the connected number, including both the prefix and the random part. If the conference cannot be created, the call is disconnected with a ''No channel available'' cause code.

Example: <code>*110*124*26#</code> (or <code>*1*310*124*26#</code>) requests the creation of a new conference room with <code>10</code> as conference id prefix (room number). 6 channels are reserved for the conference (so there can be at least 6 participants) and the maximum amount of channels used by the CONF interface is set to 24.

Please note that the CONF interface does not store the <code>*1</code> channel limitation. So you need to make sure it is provided consistently on all calls to the CONF interface that create new conference rooms. Also, both limits (<code>*1</code> and <code>*2</code>) control the resources used by the interface itself. They do not ensure that the resources are not consumed by others when they are actually needed (for example, a physical interface such as ISDN may have used all available DSP channels for VoIP calls).

===== Create a new room with a given room number: *2 =====

This command is the same as above, except that no random number is appended to the ''<nowiki><prefix></nowiki>''. It is not possible to create the conference room if its id conflicts with a room that currently exists in this interface.

Example: <code>*210*124*26#</code> (or <code>*2*310*124*26#</code>) requests the creation of a new conference room with <code>10</code> as conference id (room number). 6 channels are reserved for the conference (so there can be at least 6 participants) and the maximum amount of channels used by the CONF interface is set to 24.

===== Create a new or join an existing room with a given room number: *3 =====

This command is the same as above, except that if there is no room with the given room number a new room is created. Otherwise the existing room is joined. No random number is appended, too.

Example: <code>*310*124*26#</code> (or <code>*3*310*124*26#</code>) requests the join to a conference room with <code>10</code> as conference id (room number) or - if the room does not exist yet - creation of a new one. 6 channels are reserved for the conference (so there can be at least 6 participants) and the maximum amount of channels used by the CONF interface is set to 24.

===== Join an existing room: 0-9 =====

If the called party number does not start with an asterisk <code>*</code>, the remaining digits are interpreted as conference room id and the call will join this conference if it exists.

The dialed digits are used to find an existing room. The first room number which matches is joined (for example, if the called party number is <code>10</code> and there is a conference room with id <code>1</code>). No sending complete or end marker is necessary if the room is found or if there is no such room. However, if the called party number matches only the head of an existing conference room id, the interface will wait for additional digits to decide unless a <code>#</code> is seen or ''sending complete'' is on. You may want to enable ''Force enblock'' in routes towards the CONF interface thus.

For commands which join a room, the call is rejected with a ''No channel available'' cause code if the room does not exist.

The old V8 behavior to create a new conference room instead of joining is only supported with the '*3' command. Now load balancing with multiple conference devices is possible.

==== In-Call commands ====

These commands can be used during calls and must be sent with DTMF tones.

===== Exclusive listen mode: *21# =====

All members except for the caller are muted.

===== Normal listen mode: *6# =====

All members are connected.

==== Innovaphone remote controls ====

An [[Reference:Remote Control Facility | innovaphone remote control facility ]] can be sent e.g. by a SOAP application. These remote controls are available:
* 0: ''Connect''
* 24: ''Receive on''
* 25: ''Receive off''
* 26: ''Exclusive listen mode''
* 27: ''Normal listen mode''

===== Connect (0) =====

Connects a conference call in alerting state made with the call-setup command option ''remote control connect'' (*82).

===== Receive on (24) =====

Switches on receiving incoming voice data of this conference member. This means all other conference members can listen to this conference member. It overwrites a before received ''exclusive listen mode''.

===== Receive off (25) =====

Switches off receiving incoming voice data of this conference member. The conference member is muted for all other conference members.

===== Exclusive listen mode (26) =====

All members except for this conference member are muted. It overwrites a before received ''receive on'' from other conference member calls.

===== Normal listen mode (27) =====

All members are connected. It overwrites a before received ''receive off'' from other conference member calls.

==== Call events ====

These events are recognized if the interworking option for the conference route is activated:

===== Hold event =====

If the call is hold by the member, the conference call is muted.

===== Retrieve event =====

If the call is retrieved again by the member, the conference call is activated.

=== Conferencing interface (SCNF) ===

Same functionality as CONF, except only G.711 coders are supported.

=== FAX interface ===

The FAX interface can be used to send or receive fax documents. Each call to this interface must be controlled with user-user-information messages by the [http://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:Concept_Faxserver innovaphone Faxserver application] or V13 App ''Fax''.

==== Headline ====
There are some substitutions in the header line of outgoing faxes. The header line has a length of 108 signs.

* $d: day of month, two digits
* $j: day of month without leading zero
* $m: month, two digits
* $n: month without leading zero
* $Y: year, four digits
* $y: year, two digits
* $G: hour, 24 hours format, without leading zero
* $H: hour, 24 hours format, two digits
* $i: minutes, two digits
* $s: seconds, two digits
* $p: number of page
* $P: page count, if available, with leading '/'
* $I: subscriber id
* $R: remote subscriber id
* $$: the sign '$'
* $t: tabulator to the next 15 character grid
* $c: text is centered
Flags for the place holders:
* 0-9: field length, with tabulator jump forward to this position
* -: left aligned

The default header line for English is defined as:

$d/$m/$Y $G:$i <subscriber-name> $I$63t To:$-20R$tPage: $p$P$c

== CGPN/CDPN Mappings ==
{{CGPN-CDPN_Mappings}}

Reference14r2:PBX/Objects/Conference/Announcement types

2024-07-12T15:38:58Z

Teh: /* Dial-in announcements */

The PBX conference object uses a HTTP interface for announcements. This document lists the different announcement types.
== Conference announcements ==
If the announcement URL is set, the conference object tries to access to the announcement files. A ''$type'' within the URL is substituted for the announcement type string. e.g. ''<nowiki>http://127.0.0.1/webdav/conference/$type.$coder?coder=g722,g711u,g711a,g723,g729,OPUS-WB,OPUS-NB</nowiki>''.

These following announcement types are known by the conference module.
=== Dial-in announcements ===
:* ''welcome_common'': The first announcement of a welcome message.
:* ''welcome'': Announcement of a welcome message if the dialed number does not include a room number.
:* ''welcome_room'': Announcement of a welcome message if a room is chosen. A room specific message can also be used. ($type="welcome_room_10" for room 10)
:* ''input_room_number_X'': Announcement to input a room number with a specific room number length (X). If the file doesn't exist, the ''input_room_number'' file is played instead.
:* ''input_room_number'': Announcement to input a room number.
:* ''input_pin'': Announcement to input a PIN.
:* ''pin_wrong'': Announcement about a wrong PIN input.
:* ''no_input'': Announcement if no input is done by the caller within a certain time.
:* ''pin_correct'': Announcement after entering a correct PIN. A room specific message can also be used.
:* ''enter_room'': Announcement after welcome and PIN announcements. A room specific message can also be used.
:* ''first_participant'': Announcement only if the participant is the first one in the room. A room specific message can also be used.
:* ''room_does_not_exist'': Announcement if a room with the dialed number does not exist.

=== Operator announcements ===
:* ''operator_welcome'': The operator welcome message.
:* ''operator_input_pin'': Announcement to input the configured operator PIN.
:* ''operator_input_room_number_X'': Announcement to input a room number for the new room with a specific room number length (X). If the file doesn't exist, the ''operator_input_room_number'' file is played instead.
:* ''operator_input_room_number'': Announcement to input a room number for the new room.
:* ''operator_input_room_number_of_channels'': Announcement to input the number of the channels to be to reserve.
:* ''operator_input_room_pin'': Announcement to input a PIN for the new room.
:* ''operator_input_room_pin_repeat'': Announcement to repeat the PIN for the new room.
:* ''operator_no_input'': Announcement if no input is done.
:* ''operator_pin_wrong'': Announcement if a wrong operator PIN is dialed.
:* ''operator_room_number_used'': Announcement that the room number is used.
:* ''operator_room_pin_repeat_wrong'': Announcement that the repeated PIN doesn't match.
:* ''operator_room_created'': Announcement that the new room is created.
:* ''operator_room_created_failed'': Announcement that the new room can't be created.
:* ''operator_room_transfer'': Announcement that the call is transferred into the new room and the conference is started.
:* ''operator_resources_unavailable'': Announcement that no resources are available.

=== Room specific announcements ===
:* ''welcome_room_XX'': It is possible to set a room specific welcome message (e.g. ''welcome_room_001''). If it isn't available, the default announcement is played (''welcome_room'').

=== Web Access announcements ===
:* ''webaccess_welcome_room_XX'': Announcement of a welcome message for a specific room. If it isn't available, the default welcome announcement is played.
:* ''webaccess_welcome'': Announcement of a welcome message.
:* ''webaccess_room_busy'': Announcement, if an existing room can't accept further participants caused of no channel available.
:* ''webaccess_resources_unavailable'': Announcement, if the room can't be created caused by insufficient available channels.

=== Meeting announcements ===
:* ''input_meeting_id'': Announcement to input a meeting id.
:* ''meeting_not_found'': Announcement, if no meeting with the given meeting id wasn't found.
:* ''meeting_welcome_XX_YYY'': Announcement of a welcome message for a specific meeting. XX is the room number, YYY is the meeting id. If it isn't available, the welcome announcement for the room is tried.
:* ''meeting_welcome_XX'': Announcement of a meeting welcome message for a specific room. XX is the room number. If it isn't available, the default meeting welcome announcement is played.
:* ''meeting_welcome'': The default meeting welcome announcement.
:* ''meeting_start'': Announcement, if the meeting starts.
:* ''meeting_wait_start'': Announcement for the waiting time between the two announcements meeting_welcome and meeting_start.
:* ''meeting_wait_short'': Announcement 5 minutes till 30 seconds before a meeting. It will be repeated.
:* ''meeting_wait_long'': Announcement 1 hour till 5 minutes before a meeting. It will be repeated.
:* ''meeting_outside'': Announcement till 1 hour before or after a meeting.
:* ''meeting_busy'': Announcement, if no resources for further participants for an existing meeting are available.
:* ''meeting_resources_unavailable'': Announcement, if no resources for a new meeting are available.
:* ''meeting_temporary_failure'': currently not used

=== Other announcements ===
:* ''participant_removed'': Announcement, if a participant has been removed from the conference.

== Sample Announcement Files ==
For these announcements we provide sample files for following languages:
* English: [[Media:Conference_announcements_en.zip]]
* French: [[Media:Conference_announcements_fr.zip]]
* German: [[Media:Conference_announcements_de.zip]]
* Italian: [[Media:Conference_announcements_it.zip]]
* Spanish : [[Media:Conference_announcements_es.zip]]
* Dutch: [[Media:Conference_announcements_nl.zip]]
* Portuguese: [[Media:Conference_announcements_pt.zip]]
* Polish: [[Media:Conference_announcements_pl.zip]] (no web access announcements yet)

Reference14r2:Concept App Service Fax

2024-06-23T16:59:03Z

Teh: /* App API */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration (SMTP Server) ====
The SMTP server configuration is to be set to receive mails which are sent as fax by this service. The mails can contain a subject and body for the cover page and one PDF document can be appended as attachment. The destination number must be included in the recipient mail address in this format: <destination number>@<fax server domain>. The fax server domain is the app service domain or the configured domain if different. Recipient addresses do not match are discarded.

The supported charsets are UTF-8 and ISO 8859-1 (Latin 1).

For the Fax service to receive the mails in the first place, the mailserver needs to forward mails for the fax-domain to the APs IP address.

An example for an Exchange configuration can be found [[Howto:Faxserver_with_Exchange|here]]

==== Mail Configuration (SMTP Client) ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document has to be sent can be uploaded with the HTTP post command. The arguments within the HTTP URL sets the data of the new fax job. The job is created in the context of an user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the URL:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact.
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created.
* cover-page-content: The content of an optional cover page if should be created.
* cover-page-content-html: Is set to true if the cover page content is in HTML.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*Smtp
*TLS
*TCP
*DB files
-> Since these options creates huge logs, please just enable for tracing a current problem and deactivate afterward

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:PBX/Objects/Conference/Announcement types

2024-06-17T17:39:33Z

Teh: /* Conference announcements */

The PBX conference object uses a HTTP interface for announcements. This document lists the different announcement types.
== Conference announcements ==
If the announcement URL is set, the conference object tries to access to the announcement files. A ''$type'' within the URL is substituted for the announcement type string. e.g. ''<nowiki>http://127.0.0.1/webdav/conference/$type.$coder?coder=g722,g711u,g711a,g723,g729,OPUS-WB,OPUS-NB</nowiki>''.

These following announcement types are known by the conference module.
=== Dial-in announcements ===
:* ''welcome'': Announcement of a welcome message if the operator isn't active.
:* ''welcome_room'': Announcement of a welcome message if a room number is dialed. A room specific message can also be used. ($type="welcome_room_10" for room 10)
:* ''input_room_number_X'': Announcement to input a room number with a specific room number length (X). If the file doesn't exist, the ''input_room_number'' file is played instead.
:* ''input_room_number'': Announcement to input a room number.
:* ''input_pin'': Announcement to input a PIN.
:* ''pin_wrong'': Announcement about a wrong PIN input.
:* ''no_input'': Announcement if no input is done by the caller within a certain time.
:* ''pin_correct'': Announcement after entering a correct PIN. A room specific message can also be used.
:* ''enter_room'': Announcement after welcome and PIN announcements. A room specific message can also be used.
:* ''first_participant'': Announcement only if the participant is the first one in the room. A room specific message can also be used.
:* ''room_does_not_exist'': Announcement if a room with the dialed number does not exist.

=== Operator announcements ===
:* ''operator_welcome'': The operator welcome message.
:* ''operator_input_pin'': Announcement to input the configured operator PIN.
:* ''operator_input_room_number_X'': Announcement to input a room number for the new room with a specific room number length (X). If the file doesn't exist, the ''operator_input_room_number'' file is played instead.
:* ''operator_input_room_number'': Announcement to input a room number for the new room.
:* ''operator_input_room_number_of_channels'': Announcement to input the number of the channels to be to reserve.
:* ''operator_input_room_pin'': Announcement to input a PIN for the new room.
:* ''operator_input_room_pin_repeat'': Announcement to repeat the PIN for the new room.
:* ''operator_no_input'': Announcement if no input is done.
:* ''operator_pin_wrong'': Announcement if a wrong operator PIN is dialed.
:* ''operator_room_number_used'': Announcement that the room number is used.
:* ''operator_room_pin_repeat_wrong'': Announcement that the repeated PIN doesn't match.
:* ''operator_room_created'': Announcement that the new room is created.
:* ''operator_room_created_failed'': Announcement that the new room can't be created.
:* ''operator_room_transfer'': Announcement that the call is transferred into the new room and the conference is started.
:* ''operator_resources_unavailable'': Announcement that no resources are available.

=== Room specific announcements ===
:* ''welcome_room_XX'': It is possible to set a room specific welcome message (e.g. ''welcome_room_001''). If it isn't available, the default announcement is played (''welcome_room'').

=== Web Access announcements ===
:* ''webaccess_welcome_room_XX'': Announcement of a welcome message for a specific room. If it isn't available, the default welcome announcement is played.
:* ''webaccess_welcome'': Announcement of a welcome message.
:* ''webaccess_room_busy'': Announcement, if an existing room can't accept further participants caused of no channel available.
:* ''webaccess_resources_unavailable'': Announcement, if the room can't be created caused by insufficient available channels.

=== Meeting announcements ===
:* ''input_meeting_id'': Announcement to input a meeting id.
:* ''meeting_not_found'': Announcement, if no meeting with the given meeting id wasn't found.
:* ''meeting_welcome_XX_YYY'': Announcement of a welcome message for a specific meeting. XX is the room number, YYY is the meeting id. If it isn't available, the welcome announcement for the room is tried.
:* ''meeting_welcome_XX'': Announcement of a meeting welcome message for a specific room. XX is the room number. If it isn't available, the default meeting welcome announcement is played.
:* ''meeting_welcome'': The default meeting welcome announcement.
:* ''meeting_start'': Announcement, if the meeting starts.
:* ''meeting_wait_start'': Announcement for the waiting time between the two announcements meeting_welcome and meeting_start.
:* ''meeting_wait_short'': Announcement 5 minutes till 30 seconds before a meeting. It will be repeated.
:* ''meeting_wait_long'': Announcement 1 hour till 5 minutes before a meeting. It will be repeated.
:* ''meeting_outside'': Announcement till 1 hour before or after a meeting.
:* ''meeting_busy'': Announcement, if no resources for further participants for an existing meeting are available.
:* ''meeting_resources_unavailable'': Announcement, if no resources for a new meeting are available.
:* ''meeting_temporary_failure'': currently not used

=== Other announcements ===
:* ''participant_removed'': Announcement, if a participant has been removed from the conference.

== Sample Announcement Files ==
For these announcements we provide sample files for following languages:
* English: [[Media:Conference_announcements_en.zip]]
* French: [[Media:Conference_announcements_fr.zip]]
* German: [[Media:Conference_announcements_de.zip]]
* Italian: [[Media:Conference_announcements_it.zip]]
* Spanish : [[Media:Conference_announcements_es.zip]]
* Dutch: [[Media:Conference_announcements_nl.zip]]
* Portuguese: [[Media:Conference_announcements_pt.zip]]
* Polish: [[Media:Conference_announcements_pl.zip]] (no web access announcements yet)

Reference14r2:PBX/Objects/Conference/Announcement types

2024-06-07T17:43:44Z

Teh: Created page with " The PBX conference object uses a HTTP interface for announcements. This document lists the different announcement types. == Conference announcements == If the announcement URL is set, the conference object tries to access to the announcement files. A ''$type'' within the URL is substituted for the announcement type string. e.g. ''<nowiki>http://127.0.0.1/webdav/conference/$type.$coder..."

The PBX conference object uses a HTTP interface for announcements. This document lists the different announcement types.
== Conference announcements ==
If the announcement URL is set, the conference object tries to access to the announcement files. A ''$type'' within the URL is substituted for the announcement type string. e.g. ''<nowiki>http://127.0.0.1/webdav/conference/$type.$coder?coder=g722,g711u,g711a,g723,g729,OPUS-WB,OPUS-NB</nowiki>''.

These following announcement types are known by the conference module.
=== Dial-in announcements ===
:* ''welcome'': Announcement of a welcome message if the operator isn't active.
:* ''welcome_room'': Announcement of a welcome message if a room number is dialed. A room specific message can also be used. ($type="welcome_room_10" for room 10)
:* ''input_room_number_X'': Announcement to input a room number with a specific room number length (X). If the file doesn't exist, the ''input_room_number'' file is played instead.
:* ''input_room_number'': Announcement to input a room number.
:* ''input_pin'': Announcement to input a PIN.
:* ''pin_wrong'': Announcement about a wrong PIN input.
:* ''no_input'': Announcement if no input is done by the caller within a certain time.
:* ''pin_correct'': Announcement after entering a correct PIN. A room specific message can also be used.
:* ''enter_room'': Announcement after welcome and PIN announcements. A room specific message can also be used.
:* ''first_participant'': Announcement only if the participant is the first one in the room. A room specific message can also be used.
:* ''room_does_not_exist'': Announcement if a room with the dialed number does not exist.

=== Operator announcements ===
:* ''operator_welcome'': The operator welcome message.
:* ''operator_input_pin'': Announcement to input the configured operator PIN.
:* ''operator_input_room_number_X'': Announcement to input a room number for the new room with a specific room number length (X). If the file doesn't exist, the ''operator_input_room_number'' file is played instead.
:* ''operator_input_room_number'': Announcement to input a room number for the new room.
:* ''operator_input_room_number_of_channels'': Announcement to input the number of the channels to be to reserve.
:* ''operator_input_room_pin'': Announcement to input a PIN for the new room.
:* ''operator_input_room_pin_repeat'': Announcement to repeat the PIN for the new room.
:* ''operator_no_input'': Announcement if no input is done.
:* ''operator_pin_wrong'': Announcement if a wrong operator PIN is dialed.
:* ''operator_room_number_used'': Announcement that the room number is used.
:* ''operator_room_pin_repeat_wrong'': Announcement that the repeated PIN doesn't match.
:* ''operator_room_created'': Announcement that the new room is created.
:* ''operator_room_created_failed'': Announcement that the new room can't be created.
:* ''operator_room_transfer'': Announcement that the call is transferred into the new room and the conference is started.
:* ''operator_resources_unavailable'': Announcement that no resources are available.

=== Room specific announcements ===
:* ''welcome_room_XX'': It is possible to set a room specific welcome message (e.g. ''welcome_room_001''). If it isn't available, the default announcement is played (''welcome_room'').

=== Web Access announcements ===
:* ''webaccess_welcome_room_XX'': Announcement of a welcome message for a specific room. If it isn't available, the default welcome announcement is played.
:* ''webaccess_welcome'': Announcement of a welcome message.
:* ''webaccess_room_busy'': Announcement, if an existing room can't accept further participants caused of no channel available.
:* ''webaccess_resources_unavailable'': Announcement, if the room can't be created caused by insufficient available channels.

=== Meeting announcements ===
:* ''input_meeting_id'': Announcement to input a meeting id.
:* ''meeting_not_found'': Announcement, if no meeting with the given meeting id wasn't found.
:* ''meeting_welcome_XX_YYY'': Announcement of a welcome message for a specific meeting. XX is the room number, YYY is the meeting id. If it isn't available, the welcome announcement for the room is tried.
:* ''meeting_welcome_XX'': Announcement of a meeting welcome message for a specific room. XX is the room number. If it isn't available, the default meeting welcome announcement is played.
:* ''meeting_welcome'': The default meeting welcome announcement.
:* ''meeting_start'': Announcement, if the meeting starts.
:* ''meeting_wait_start'': Announcement for the waiting time between the two announcements meeting_welcome and meeting_start.
:* ''meeting_wait_short'': Announcement 5 minutes till 30 seconds before a meeting. It will be repeated.
:* ''meeting_wait_long'': Announcement 1 hour till 5 minutes before a meeting. It will be repeated.
:* ''meeting_outside'': Announcement till 1 hour before or after a meeting.
:* ''meeting_busy'': Announcement, if no resources for further participants for an existing meeting are available.
:* ''meeting_resources_unavailable'': Announcement, if no resources for a new meeting are available.
:* ''meeting_temporary_failure'': currently not used

== Sample Announcement Files ==
For these announcements we provide sample files for following languages:
* English: [[Media:Conference_announcements_en.zip]]
* French: [[Media:Conference_announcements_fr.zip]]
* German: [[Media:Conference_announcements_de.zip]]
* Italian: [[Media:Conference_announcements_it.zip]]
* Spanish : [[Media:Conference_announcements_es.zip]]
* Dutch: [[Media:Conference_announcements_nl.zip]]
* Portuguese: [[Media:Conference_announcements_pt.zip]]
* Polish: [[Media:Conference_announcements_pl.zip]] (no web access announcements yet)

Reference14r1:Apps/PbxManager/Conference

2024-03-12T13:50:54Z

Teh: Reverted edits by Teh (talk) to last revision by Vsc

Configure your Conferences

== Add a conference==
; Name
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

; Allow Web Access
: If it is set, the web access of a room can be enabled in the conference app by users.

; Announcements
: Select the announcements to be played.
: Use [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types|predefined annoucement packages]] depending on language and place them in local files app.
: Share access rights to enable selection.

; Conference interface
: Search for available conference devices and select appropriate one for use.
: Possibility to
:* set used amount for seats at dedicated conference device and
:* choose use of PBX-channels-license to operate interface with.

; Channels app
: To be implemented.

; Rooms
: Add room(s) to be used for conferences
: Display name: Room name displayed as endpoint and as the conference app name.
: Number: Room number. Appended to the conference number for a direct dial-in.
: Reserved channels: Amount of conference room participants.
: PIN: Access authentication to enter the room.
: Meetings: Creating meetings by users can be allowed or not. It is also possible to use a room only with meetings. {{ConferenceRoomPanelRights}}
: Video coder: Supported video codec for video conference.
: Delete room: Erase the room from the conference.

; Configuration templates
: Each app which is provided by the conference object can be enabled for users with configuration templates.

= Related Articles =
* [[Course13:IT_Connect_-_08.1_Conferencing]]

[[Category:Concept_Conference]]

Reference14r1:Apps/PbxManager/Conference

2024-03-12T13:01:24Z

Teh:

Configure your Conferences

== Add a conference==
; Name
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

; Allow Web Access
: If it is set, the web access of a room can be enabled in the conference app by users.

; Announcements
: Select the announcements to be played.
: Use [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types|predefined annoucement packages]] depending on language and place them in local files app.
: Share access rights to enable selection.

; Conference interface
: Search for available conference devices and select appropriate one for use.
: Possibility to
:* set used amount for seats at dedicated conference device and
:* choose use of PBX-channels-license to operate interface with.

; Channels app
: To be implemented.

; Rooms
: Add room(s) to be used for conferences
: Display name: Room name displayed as endpoint and as the conference app name.
: Number: Room number. Appended to the conference number for a direct dial-in.
: Reserved channels: Amount of conference room participants.
: PIN: Access authentication to enter the room.
: Meetings: Creating meetings by users can be allowed or not. It is also possible to use a room only with meetings. There are three options: ''Not allowed'', ''allowed'' and ''only meetings''.
: Video coder: Supported video codec for video conference.
: Delete room: Erase the room from the conference.

; Configuration templates
: Each app which is provided by the conference object can be enabled for users with configuration templates.

= Related Articles =
* [[Course13:IT_Connect_-_08.1_Conferencing]]

[[Category:Concept_Conference]]

Reference14r1:Apps/PbxManager/Conference

2024-02-14T10:20:49Z

Teh:

Configure your Conferences

== Add a conference==
; Name
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

; Allow Web Access
: If it is set, the web access of a room can be enabled in the conference app by users.

; Announcements
: Select the announcements to be played.
: Use [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types|predefined annoucement packages]] depending on language and place them in local files app.
: Share access rights to enable selection.

; Conference interface
: Search for available conference devices and select appropriate one for use.
: Possibility to
:* set used amount for seats at dedicated conference device and
:* choose use of PBX-channels-license to operate interface with.

; Channels app
: To be implemented.

; Rooms
: Add room(s) to be used for conferences
: Display name: Room name displayed as endpoint and as the conference app name.
: Number: Room number. Appended to the conference number for a direct dial-in.
: Reserved channels: Amount of conference room participants.
: PIN: Access authentication to enter the room.
: Meetings: Creating meetings by users can be allowed or not. It is also possible to use a room only with meetings.
: Video coder: Supported video codec for video conference.
: Delete room: Erase the room from the conference.

; Configuration templates
: Each app which is provided by the conference object can be enabled for users with configuration templates.

= Related Articles =
* [[Course13:IT_Connect_-_08.1_Conferencing]]

[[Category:Concept_Conference]]

Reference14r1:Apps/PbxManager/Conference

2024-02-14T10:17:57Z

Teh: Created page with "Configure your Conferences == Add a conference== ; Name : Long Name of the PBX object ; SIP : Name of the PBX object ; Number : Number of the PBX object ; Allow Web Access : If it is set, the web access of a room can be enabled in the conference app by users. ; Announcements : Select the announcements to be played. : Use predefined annoucement packages depending on language and place them in local files ap..."

Configure your Conferences

== Add a conference==
; Name
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

; Allow Web Access
: If it is set, the web access of a room can be enabled in the conference app by users.

; Announcements
: Select the announcements to be played.
: Use [[{{NAMESPACE}}:PBX/Objects/Conference/Announcement_types|predefined annoucement packages]] depending on language and place them in local files app.
: Share access rights to enable selection.

; Conference interface
: Search for available conference devices and select appropriate one for use.
: Possibility to
:* set used amount for seats at dedicated conference device and
:* choose use of PBX-channels-license to operate interface with.

; Channels app
: To be implemented.

; Rooms
: Add room(s) to be used for conferences
: Display name: Room name displayed as endpoint and as the conference app name.
: Number: Room number. Appended to the conference number for a direct dial-in.
: Reserved channels: Amount of conference room participants.
: PIN: Access authentication to enter the room.
: Video coder: Supported video codec for video conference.
: Delete room: Erase the room from the conference.

; Configuration templates
: Each app which is provided by the conference object can be enabled for users with configuration templates.

= Related Articles =
* [[Course13:IT_Connect_-_08.1_Conferencing]]

[[Category:Concept_Conference]]

Reference14r2:Concept App Service Fax

2024-02-12T10:21:45Z

Teh: /* Mail Configuration */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration (SMTP Server) ====
The SMTP server configuration is to be set to receive mails which are sent as fax by this service. The mails can contain a subject and body for the cover page and one PDF document can be appended as attachment. The destination number must be included in the recipient mail address in this format: <destination number>@<fax server domain>. The fax server domain is the app service domain or the configured domain if different. Recipient addresses do not match are discarded.

The supported charset is UTF-8.

==== Mail Configuration (SMTP Client) ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document has to be sent can be uploaded with the HTTP post command. The arguments within the HTTP url sets the data of the new fax job. The job is created in the context of an user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the url:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact.
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created.
* cover-page-content: The content of an optional cover page if should be created.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:Apps/PbxManager/App Fax

2024-01-16T17:29:56Z

Teh:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}

This page describes the PBX Manager Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Manager Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== General Configuration ===
* Delete fax jobs automatically: Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* Send with high resolution: The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== SMTP Server Configuration ===
The email receiving for the Mail2Fax feature can be enabled and the authentication configured here:
* Mail receiving: To be turn on.
* Domain: Used to filter the recipient address of the received mails' address list. If not set, the configured app domain of the app service is used.
* User name: The login name for the SMTP authentication.
* Password: The password for the SMTP authentication.

=== SMTP Configuration ===
Required data for outgoing emails:
* Hostname: Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* Server[:port]: Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* User name: The login name of a valid user account at the SMTP server (mandatory).
* Password: The password of the SMTP user account (mandatory).
* Sender address: The email address of the sender in sent emails.
* Sender name: The name of the sender in sent emails.
[https://sdk.innovaphone.com/13r2/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== HTTP API ===
The key for the HTTP post command authentication can be configured here. The API is documented in the [[{{NAMESPACE}}:Concept_App_Service_Fax#App_API|concept article]].

=== Customized Texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* Name: Object long name
* SIP: Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* Number: Object number to be prepended for fax calls.
* International fax number: Printed in the headline of fax document. The user (send) number is added, but not the node number.
* Company name: Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
* FAX interface: Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
** Device name: Name of the device as defined in the Devices App
** Hardware ID: Serial number (MAC) of a device
** Product: innovaphone device model
** Available channels: Amount of offered fax channels
** T.38 allowed: T.38 codec for the fax transmission allowed
** Audio fax allowed: Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
* External Resource: The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
** For fax objects: This is only used if no fax interface is registered.
** For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
* Node and PBX: The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
* Default Recipient: Faxes are received for this user or this fax group, if no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
* Header line of fax pages: A header line preset for a language can be selected or the header line can be individually modified. Usable variables are listed [[{{NAMESPACE}}:Gateway/Interfaces#Headline|here]].
* Configuration Templates: select configuration templates to be applied for the fax app object

Reference14r2:Apps/PbxManager/App Fax

2024-01-16T17:19:53Z

Teh:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}

This page describes the PBX Manager Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Manager Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== General Configuration ===
* Delete fax jobs automatically: Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* Send with high resolution: The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== SMTP Server Configuration ===
The email receiving for the Mail2Fax feature can be enabled and the authentication configured here:
* Mail receiving: To be turn on.
* Domain: Used to filter the recipient address of the received mails' address list. If not set, the configured app domain of the app service is used.
* User name: The login name for the SMTP authentication.
* Password: The password for the SMTP authentication.

=== SMTP Configuration ===
Required data for outgoing emails:
* Hostname: Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* Server[:port]: Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* User name: The login name of a valid user account at the SMTP server (mandatory).
* Password: The password of the SMTP user account (mandatory).
* Sender address: The email address of the sender in sent emails.
* Sender name: The name of the sender in sent emails.
[https://sdk.innovaphone.com/13r2/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== Customized Texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* Name: Object long name
* SIP: Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* Number: Object number to be prepended for fax calls.
* International fax number: Printed in the headline of fax document. The user (send) number is added, but not the node number.
* Company name: Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
* FAX interface: Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
** Device name: Name of the device as defined in the Devices App
** Hardware ID: Serial number (MAC) of a device
** Product: innovaphone device model
** Available channels: Amount of offered fax channels
** T.38 allowed: T.38 codec for the fax transmission allowed
** Audio fax allowed: Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
* External Resource: The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
** For fax objects: This is only used if no fax interface is registered.
** For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
* Node and PBX: The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
* Default Recipient: Faxes are received for this user or this fax group, if no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
* Header line of fax pages: A header line preset for a language can be selected or the header line can be individually modified. Usable variables are listed [[{{NAMESPACE}}:Gateway/Interfaces#Headline|here]].
* Configuration Templates: select configuration templates to be applied for the fax app object

Reference14r2:Apps/PbxManager/App Fax

2024-01-16T17:06:34Z

Teh: Created page with "{{FIXME|reason=This product is in the beta phase and is not yet finished}}  This page describes the PBX Manager Plugin of the Fax App. The fax app service can be configured and user apps can be added, configured or deleted with this PBX Manager Plugin of the fax app. The app service provides user fax apps: * with a personal account. * with a group account. The fax service applies the fax configuration like subscriber name..."

{{FIXME|reason=This product is in the beta phase and is not yet finished}}

This page describes the PBX Manager Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Manager Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== General Configuration ===
* Delete fax jobs automatically: Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* Send with high resolution: The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== SMTP Configuration ===
Required data for outgoing emails:
* Hostname: Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* Server[:port]: Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* User name: The login name of a valid user account at the SMTP server (mandatory).
* Password: The password of the SMTP user account (mandatory).
* Sender address: The email address of the sender in sent emails.
* Sender name: The name of the sender in sent emails.
[https://sdk.innovaphone.com/13r2/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== Customized Texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* Name: Object long name
* SIP: Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* Number: Object number to be prepended for fax calls.
* International fax number: Printed in the headline of fax document. The user (send) number is added, but not the node number.
* Company name: Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
* FAX interface: Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
** Device name: Name of the device as defined in the Devices App
** Hardware ID: Serial number (MAC) of a device
** Product: innovaphone device model
** Available channels: Amount of offered fax channels
** T.38 allowed: T.38 codec for the fax transmission allowed
** Audio fax allowed: Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
* External Resource: The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
** For fax objects: This is only used if no fax interface is registered.
** For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
* Node and PBX: The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
* Default Recipient: Faxes are received for this user or this fax group, if no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
* Header line of fax pages: A header line preset for a language can be selected or the header line can be individually modified. Usable variables are listed [[{{NAMESPACE}}:Gateway/Interfaces#Headline|here]].
* Configuration Templates: select configuration templates to be applied for the fax app object

Reference14r2:Concept App Service Fax

2024-01-16T16:52:08Z

Teh:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document has to be sent can be uploaded with the HTTP post command. The arguments within the HTTP url sets the data of the new fax job. The job is created in the context of an user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the url:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact.
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created.
* cover-page-content: The content of an optional cover page if should be created.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:Concept App Service Fax

2024-01-16T16:22:57Z

Teh: /* Features */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:Concept App Service Fax

2024-01-16T16:20:56Z

Teh: /* Features */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* HTTP (Post) API

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:Concept App Service Fax

2024-01-16T16:17:15Z

Teh: /* Features */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:Concept App Service Fax

2024-01-16T16:16:44Z

Teh: Created page with "{{FIXME|reason=This product is in the beta phase and is not yet finished}} Apps  == Applies To == * innovaphone PBX from version 14r1 == Overview == The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents. == Features == * The App Service Fax sends PDF..."

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax (This feature will be added with a later service release, and is not available with 14r1 final. This information will be updated, if the service release is known.)

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r1:PBX/Objects/Fax

2023-11-23T10:00:35Z

Teh:

The innovaphone App Fax is configured with the PBX Fax object.

== Configuration Options available for Fax-Objects ==

;URL: Any valid URL to point to the innovaphone App Fax. With the App Fax URL argument 'mailbox' it is possible to configure a fax group app. The specified sip is used as the fax account instead of the login user.
;Header line: A header line for outgoing faxes can be [[{{NAMESPACE}}:Gateway/Interfaces#Headline|configured]].
;Subscriber ID: The subscriber id of the T.30 protocol.
;Subscriber Name: The subscriber name used in the header line.
;Default User: If no valid user with a fax license is found for the dialed extension number or no extension number is dialed, this user receives the incoming fax instead.
;External Resource Destination: If the H.323 name of another PBX fax object of this PBX is configured here, the FAX interface registrations of that object is used for the FAX interface call.
; : An external resource for fax group objects is [[Howto13r3:Firmware_Upgrade_V13r2_V13r3#Group_Fax|mandatory]].
;Modem capability: The modem capability can be restricted if necessary. All modem speeds are allowed by default.
;Append user number: If this is ticked, the user extension number is appended to the object number and to the subscriber id. The default is enabled.
;ECM: If this is ticked, T.30 error correction mode is used. The default is enabled.
;Receiving with 400dpi allowed: If this is ticked, the FAX interface is allowed to receive documents with 400dpi. The default is enabled.
;Fax License: A fax license can be assigned to the fax object itself, if it acts as an user to receive and send a fax and as an app object together. Also, it is possible to configure the object as a group fax user.
;UC License: An UC license can be used instead of a fax license, but without an additional value.

== Apps configuration ==

Configures access to other apps which provide an additional service; currently, the fax app does not need any other service.

== General Configuration Options ==

The information about general configuration options shared by all objects can be found at [[{{NAMESPACE}}:PBX/Objects]].

Reference14r1:PBX/Objects/Fax

2023-11-21T21:20:30Z

Teh: Created page with "The innovaphone App Fax is configured with the PBX Fax object. == Configuration Options available for Fax-Objects == ;URL: Any valid URL to point to the innovaphone App Fax. With the App Fax URL argument 'mailbox' it is possible to configure a fax group app. The specified sip is used as the fax account instead of the login user. ;Header line: A header line for outgoing faxes can be configured. ;Subscriber ID: The subscriber..."

The innovaphone App Fax is configured with the PBX Fax object.

== Configuration Options available for Fax-Objects ==

;URL: Any valid URL to point to the innovaphone App Fax. With the App Fax URL argument 'mailbox' it is possible to configure a fax group app. The specified sip is used as the fax account instead of the login user.
;Header line: A header line for outgoing faxes can be [[{{NAMESPACE}}:Gateway/Interfaces#Headline|configured]].
;Subscriber ID: The subscriber id of the T.30 protocol.
;Subscriber Name: The subscriber name used in the header line.
;Default User: If no valid user with a fax license is found for the dialed extension number or no extension number is dialed, this user receives the incoming fax instead.
;External Resource Destination: If the H.323 name of another PBX fax object of this PBX is configured here, the FAX interface registrations of that object is used for the FAX interface call.
;Modem capability: The modem capability can be restricted if necessary. All modem speeds are allowed by default.
;Append user number: If this is ticked, the user extension number is appended to the object number and to the subscriber id. The default is enabled.
;ECM: If this is ticked, T.30 error correction mode is used. The default is enabled.
;Receiving with 400dpi allowed: If this is ticked, the FAX interface is allowed to receive documents with 400dpi. The default is enabled.
;Fax License: A fax license can be assigned to the fax object itself, if it acts as an user to receive and send a fax and as an app object together. Also, it is possible to configure the object as a group fax user.
;UC License: An UC license can be used instead of a fax license, but without an additional value.

== Apps configuration ==

Configures access to other apps which provide an additional service; currently, the fax app does not need any other service.

== General Configuration Options ==

The information about general configuration options shared by all objects can be found at [[{{NAMESPACE}}:PBX/Objects]].

Reference14r1:Concept App Service Fax

2023-11-21T20:53:46Z

Teh:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* If you enter a number in the input field and click on it, this number will be stored inside the fax database as a contact. Currently, these contacts can't be deleted, so be aware to not click and thus save wrong numbers.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r1:Concept App Service Fax

2023-11-20T14:31:29Z

Teh: Created page with "Apps  == Applies To == * innovaphone PBX from version 14r1 == Overview == The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents. == Features == * The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF. * C..."

[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[Reference14r1:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[Reference14r1:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* If you enter a number in the input field and click on it, this number will be stored inside the fax database as a contact. Currently, these contacts can't be deleted, so be aware to not click and thus save wrong numbers.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Course13:IT_Connect_-_09.1_Fax | IT Connect Training]].
* [[Reference14r1:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r1:Apps/PbxManager/App Fax

2023-11-14T11:31:07Z

Teh: /* Individual Fax App Configuration */

This page describes the PBX Manager Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Manager Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== General Configuration ===
* Delete fax jobs automatically: Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* Send with high resolution: The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== SMTP Configuration ===
Required data for outgoing emails:
* Hostname: Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* Server[:port]: Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* User name: The login name of a valid user account at the SMTP server (mandatory).
* Password: The password of the SMTP user account (mandatory).
* Sender address: The email address of the sender in sent emails.
* Sender name: The name of the sender in sent emails.
[https://sdk.innovaphone.com/13r2/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== Customized Texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* Name: Object long name
* SIP: Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* Number: Object number to be prepended for fax calls.
* International fax number: Printed in the headline of fax document. The user (send) number is added, but not the node number.
* Company name: Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
* FAX interface: Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
** Device name: Name of the device as defined in the Devices App
** Hardware ID: Serial number (MAC) of a device
** Product: innovaphone device model
** Available channels: Amount of offered fax channels
** T.38 allowed: T.38 codec for the fax transmission allowed
** Audio fax allowed: Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
* External Resource: The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
** For fax objects: This is only used if no fax interface is registered.
** For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
* Node and PBX: The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
* Default Recipient: Faxes are received for this user or this fax group, if no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
* Header line of fax pages: A header line preset for a language can be selected or the header line can be individually modified. Usable variables are listed [[{{NAMESPACE}}:Gateway/Interfaces#Headline|here]].
* Configuration Templates: select configuration templates to be applied for the fax app object

Reference14r1:Apps/PbxManager/App Fax

2023-11-14T09:01:35Z

Teh: Created page with " This page describes the PBX Manager Plugin of the Fax App. The fax app service can be configured and user apps can be added, configured or deleted with this PBX Manager Plugin of the fax app. The app service provides user fax apps: * with a personal account. * with a group account. The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each f..."

This page describes the PBX Manager Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Manager Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== General Configuration ===
* Delete fax jobs automatically: Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* Send with high resolution: The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== SMTP Configuration ===
Required data for outgoing emails:
* Hostname: Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* Server[:port]: Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* User name: The login name of a valid user account at the SMTP server (mandatory).
* Password: The password of the SMTP user account (mandatory).
* Sender address: The email address of the sender in sent emails.
* Sender name: The name of the sender in sent emails.
[https://sdk.innovaphone.com/13r2/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== Customized Texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* Name: Object long name
* SIP: Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* Number: Object number to be prepended for fax calls.
* International fax number: Printed in the headline of fax document. The user (send) number is added, but not the node number.
* Company name: Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
* FAX interface: Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
** Device name: Name of the device as defined in the Devices App
** Hardware ID: Serial number (MAC) of a device
** Product: innovaphone device model
** Available channels: Amount of offered fax channels
** T.38 allowed: T.38 codec for the fax transmission allowed
** Audio fax allowed: Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
* External Resource: The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
** For fax objects: This is only used if no fax interface is registered.
** For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
* Node and PBX: The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
* Default Recipient: Faxes are received for this user or this fax group, if no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
* Configuration Templates: select configuration templates to be applied for the fax app object

Reference14r1:PBX/Objects/Conference/Announcement types

2023-08-16T10:13:23Z

Teh: Created page with " The PBX conference object uses a HTTP interface for announcements. This document lists the different announcement types. == Conference announcements == If the announcement URL is set, the conference object tries to access to the announcement files. A ''$type'' within the URL is substituted for the announcement type string. e.g. ''<nowiki>http://127.0.0.1/webdav/conference/$type.$coder?coder=g722,g711u,g71..."

The PBX conference object uses a HTTP interface for announcements. This document lists the different announcement types.
== Conference announcements ==
If the announcement URL is set, the conference object tries to access to the announcement files. A ''$type'' within the URL is substituted for the announcement type string. e.g. ''<nowiki>http://127.0.0.1/webdav/conference/$type.$coder?coder=g722,g711u,g711a,g723,g729,OPUS-WB,OPUS-NB</nowiki>''.

These following announcement types are known by the conference module.
=== Dial-in announcements ===
:* ''welcome'': Announcement of a welcome message if the operator isn't active.
:* ''welcome_room'': Announcement of a welcome message if a room number is dialed. A room specific message can also be used. ($type="welcome_room_10" for room 10)
:* ''input_room_number_X'': Announcement to input a room number with a specific room number length (X). If the file doesn't exist, the ''input_room_number'' file is played instead.
:* ''input_room_number'': Announcement to input a room number.
:* ''input_pin'': Announcement to input a PIN.
:* ''pin_wrong'': Announcement about a wrong PIN input.
:* ''no_input'': Announcement if no input is done by the caller within a certain time.
:* ''pin_correct'': Announcement after entering a correct PIN. A room specific message can also be used.
:* ''enter_room'': Announcement after welcome and PIN announcements. A room specific message can also be used.
:* ''first_participant'': Announcement only if the participant is the first one in the room. A room specific message can also be used.

=== Operator announcements ===
:* ''operator_welcome'': The operator welcome message.
:* ''operator_input_pin'': Announcement to input the configured operator PIN.
:* ''operator_input_room_number_X'': Announcement to input a room number for the new room with a specific room number length (X). If the file doesn't exist, the ''operator_input_room_number'' file is played instead.
:* ''operator_input_room_number'': Announcement to input a room number for the new room.
:* ''operator_input_room_number_of_channels'': Announcement to input the number of the channels to be to reserve.
:* ''operator_input_room_pin'': Announcement to input a PIN for the new room.
:* ''operator_input_room_pin_repeat'': Announcement to repeat the PIN for the new room.
:* ''operator_no_input'': Announcement if no input is done.
:* ''operator_pin_wrong'': Announcement if a wrong operator PIN is dialed.
:* ''operator_room_number_used'': Announcement that the room number is used.
:* ''operator_room_pin_repeat_wrong'': Announcement that the repeated PIN doesn't match.
:* ''operator_room_created'': Announcement that the new room is created.
:* ''operator_room_created_failed'': Announcement that the new room can't be created.
:* ''operator_room_transfer'': Announcement that the call is transferred into the new room and the conference is started.
:* ''operator_resources_unavailable'': Announcement that no resources are available.

=== Room specific announcements ===
:* ''welcome_room_XX'': It is possible to set a room specific welcome message (e.g. ''welcome_room_001''). If it isn't available, the default announcement is played (''welcome_room'').

=== Web Access announcements ===
:* ''webaccess_welcome_room_XX'': Announcement of a welcome message for a specific room. If it isn't available, the default welcome announcement is played.
:* ''webaccess_welcome'': Announcement of a welcome message.
:* ''webaccess_room_busy'': Announcement, if an existing room can't accept further participants caused of no channel available.
:* ''webaccess_resources_unavailable'': Announcement, if the room can't be created caused by insufficient available channels.

=== Meeting announcements ===
:* ''input_meeting_id'': Announcement to input a meeting id.
:* ''meeting_not_found'': Announcement, if no meeting with the given meeting id wasn't found.
:* ''meeting_welcome_XX_YYY'': Announcement of a welcome message for a specific meeting. XX is the room number, YYY is the meeting id. If it isn't available, the welcome announcement for the room is tried.
:* ''meeting_welcome_XX'': Announcement of a meeting welcome message for a specific room. XX is the room number. If it isn't available, the default meeting welcome announcement is played.
:* ''meeting_welcome'': The default meeting welcome announcement.
:* ''meeting_start'': Announcement, if the meeting starts.
:* ''meeting_wait_start'': Announcement for the waiting time between the two announcements meeting_welcome and meeting_start.
:* ''meeting_wait_short'': Announcement 5 minutes till 30 seconds before a meeting. It will be repeated.
:* ''meeting_wait_long'': Announcement 1 hour till 5 minutes before a meeting. It will be repeated.
:* ''meeting_outside'': Announcement till 1 hour before or after a meeting.
:* ''meeting_busy'': Announcement, if no resources for further participants for an existing meeting are available.
:* ''meeting_resources_unavailable'': Announcement, if no resources for a new meeting are available.
:* ''meeting_temporary_failure'': currently not used

== Sample Announcement Files ==
For these announcements we provide sample files for following languages:
* English: [[Media:Conference_announcements_en.zip]]
* French: [[Media:Conference_announcements_fr.zip]]
* German: [[Media:Conference_announcements_de.zip]]
* Italian: [[Media:Conference_announcements_it.zip]]
* Spanish : [[Media:Conference_announcements_es.zip]]
* Dutch: [[Media:Conference_announcements_nl.zip]]
* Portuguese: [[Media:Conference_announcements_pt.zip]]
* Polish: [[Media:Conference_announcements_pl.zip]] (no web access announcements yet)

Main Page

2023-06-12T10:42:43Z

Teh: /* Latest News */

__NOTOC__

<div style="margin:0px; margin-right:10px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0em 1em;">

== Remote Support ==

[https://get.anydesk.com/PK8coqHH/AnyDesk.exe Download Anydesk]

== Searching ==
Searching in wiki works, but is sometimes cumbersome. However, you can have Google do the job for you. Try [https://www.google.de/search?q=site%3Ainnovaphone.com+xml+documentation <code>site:innovaphone.com your search terms</code>] to search the innovaphone sites for matches!

If you still don't find what you are looking for, [mailto:presales@innovaphone.com drop us a message]
</div>


<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">



== Latest News ==

[[User:Teh|Teh]] ([[User talk:Teh|talk]]) 12:42, 12 June 2023 (CEST)
[[Howto:Firmware_Upgrade_V13r3 | Version 13r3 SR6]] is now available from the new [http://store.innovaphone.com/release/download.htm download page].
[[User:Teh|Teh]] ([[User talk:Teh|talk]]) 12:42, 12 June 2023 (CEST)
[[Howto:Firmware_Upgrade_V13r2 | Version 13r2 SR24]] is now available from the new [http://store.innovaphone.com/release/download.htm download page].

[[User:Afi|Afi]] ([[User talk:Afi|talk]]) 11:11, 2 May 2023 (CEST)
[[Support:Wireless_Handset_Firmware_IP73_1008_(4.0.2)_released | Wireless Handset Firmware IP73 1008 (4.0.2)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Smayoral|sma]] 10:29, 27 April 2023 (CEST)
[[Support:Firmware V12r2 product/12r2/firmware 125871 (sr 62) available | Version 12r2 Service Release 62]] is now available from the [http://store.innovaphone.com/release/download.htm download page].
[[User:Smayoral|sma]] 10:29, 27 April 2023 (CEST)
[[Support:Firmware V11r2 product/11r2/firmware 113809 (sr 66) available | Version 11r2 Service Release 66]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Cam|Cam]] 16:43, 25 April 2023 (CEST)
[[App Working Beta beta1 available]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Afi|Afi]] 15:38, 6 February 2023 (CET)
[[Support:Wireless_Handset_Firmware_IP62_3040621_(6.2.7)_released | Wireless Handset Firmware IP62 3040621 (6.2.7)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 13:13, 6 February 2023 (CET)
[[Support:WinPDM_Software_3130113_%284.1.8%29_released | WinPDM Software 3130113 (4.1.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Inno-mst|Inno-mst]] 11:22, 14 April 2022 (CEST)
[[Support:Operator9 90246 (hotfix24) available | Operator9 hotfix24]] is now available from [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Afi|Afi]] 15:05, 11 February 2022 (CET)
[[Support:Wireless_Handset_Firmware_IP64_10313_(2.12.10)/IP65_10118_(2.12.10)_released | Wireless Handset Firmware IP64 10313 (2.12.10)/IP65 10118 (2.12.10)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:kwa|kwa]] 14:00, 16 June 2021 (CEST)
[[Support:iQM_Build_8029100_available | IQM Build 8029100 Hotfix34]] is now available from the [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Afi|Afi]] 12:46, 16 June 2021 (CEST))
[[Support:TAPI Service Provider 8188 (hotfix21) available|TAPI Service Provider 8188 (hotfix21)]] is now available from [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Linux_Application_Platform_100271_(sr64)_available | Linux Application Platform V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Innovaphone_Reporting_100271_(sr64)_available | innovaphone Reporting V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Innovaphone_Fax_100271_(sr64)_available | innovaphone Fax V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Dde|Dde]] 13:17, 2 November 2020 (CET)
[[Support:Innovaphone_Exchange_Calendar_Connector_100271_(sr64)_available | innovaphone Exchange Calendar Connector V10 100271 sr64]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 18:21, 12 October 2020 (CEST)
[[Support:Wireless_Handset_Firmware_IP61_3022811_(4.7.8)/IP63_3022912_(4.7.8)_released | Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 21:30, 27 March 2020 (CET)
[[Support:Wireless_Handset_Firmware_and_Management_Software_product/9.00/wireless_100037_%28hotfix19%29_available | Wireless Package hotfix 19]] is now available from the [http://download.innovaphone.com/ice/9.00#wireless V9 download area].

[[User:Dde|Dde]] 07:56, 9 March 2020 (CET)
[[Support:App_Platform_build_90007_available | App Platform build 90007]] is now available from the [http://store.innovaphone.com/release/download.htm App store].

[[User:kwa|kwa]] 14:00, 02 March 2020 (CET)
[[Support:Recording_Build_121100_available | innovaphone Recording SR29 build 121100]] is now available from the [http://download.innovaphone.com/ice/10.00/#recording V10 download area].

== New Articles ==

{{Special:Newestpages/all/20}}
</div>

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em; font-size:1">
== More innovaphone Ressources ==
* [http://www.innovaphone.com Home Page]
* [http://download.innovaphone.com Download Site ]
* [http://my.innovaphone.com my.innovaphone ]
* [http://mantis.innovaphone.com/ Ticketing System ]
* [[Support:What are the Roadmap Documents? | Roadmaps ]]
</div>