SwyxWare Documentation for administrators
New Functions
Introduction
About this Documentation
Conventions for the Descriptions
Online Help
Other online manuals
1 The Basics
Concept of SwyxWare
Software components
SwyxWare Administration
Number Mapping and locations
Profiles
Trunk and Trunk Groups
SwyxIt!
Call Routing Manager
Software services
Hardware components
SwyxPhone Family
GDPR
2 Online Licensing
Subscribe or Purchase
Feature Profiles
Additional functions
Evaluation Installation
Billing
3 Licensing via license key
Licensing Procedure
Evaluation Installation
Update Licenses (kb2876)
SwyxWare for DataCenterLicensing Procedure
User license
Licenses for Clients
Licensing of data channels
Options and Option Packs
Scope of functions in SwyxWare for DataCenter and SwyxON
SwyxWare Option packs at a glance
Licensing of the SwyxWare variants at a glance
4 System Requirements
Hardware Requirements
Hard Drive Memory and File System
Network Card(s)
Software requirements
Mailserver for voice messages
Network requirements
Creating an Appropriate Network Environment for SwyxServer
Operating system
Example scenarios
Stand-alone Installation
Stand-alone installation with SIP extension
Migration Scenarios
Example 1:SwyxWare as sub-telecommunication system
Example 2:SwyxWare in addition to a telecommunications system
Example 3: SwyxWare with a sub-telecommunication system
5 SwyxWare Installation
Summary of the SwyxServer Installation
Extensions
General information
Which services belong to SwyxServer
Preparation for Installation
User account for the SwyxWare components
Installation of the ISDN Cards
Installation for Calendar-Based Call Management
Microsoft Exchange Server 2003
Install Microsoft SQL Database
Microsoft SQL Server Express installation
Installation of SwyxServer
SwyxWare - Run Setup
Configuring SwyxWare
Swyx Control Center
SwyxServer installation via command line
Installing Swyx Control Center via command line
Unattended Configuration
Installation of the SwyxWare Administration
Installation of the Active Directory extension
SwyxWare Update
Changes Between the Versions
Preparation
Updating the ISDN Card Drivers
Executing the SwyxWare update
Separated Services
Installation of a SwyxWare component on an additional computer
6 Swyx Connectivity Setup Tool
Application scenarios of SCST:
Use TLS certificate from Let's Encrypt
Use own TLS certificate
RemoteConnector Configuring
Reset SCST configuration
Install TLS root certificate on DECT 800 base station
Install TLS root certificate on Certified SIP phones
Configure Split DNS
7 Configuration of SwyxServer
Registration on SwyxWare Administration
Complex passwords
Limited number of log-in attempts
Connection to SwyxServer
User interface of SwyxWare Administration
Context menu in the SwyxWare Administration
Pre-Configured Users and Groups
Configuring SwyxServer settings
The "General" Tab
The "Client Preferences" Tab
The "Music on Hold" Tab
The "Internal Numbers" Tab
The "Licenses" Tab
The "Standby SwyxServer" Tab
The "Trunk Recording" Tab
The "Voice Box" Tab
The "Mail Server" Tab
The "Files" Tab
Add files
The „Connected SwyxWare Sites" Tab
The "Usage Reports" Tab
The "Charges" Tab
The "Search SwyxPhones" Tab
The "Login Device" Tab
The "Call Detail Records" Tab (CDR)
The "SwyxPhone Firmware Update" Tab
The "Security" tab
The "RemoteConnector" Tab
The "Default Codec Filter" Tab
Global Phonebook
The Import and Export of Phonebooks
Change log
Who can view the change log?
Search in change log
Export change log
Delete change log
Active Calls
Relationships
Backing up the SwyxWare Database
Backing up the database during an update
Uninstalling
8 Locations
Default Location
Private and business calls
Edit location
The "General" Tab
The "Codes and Prefixes" Tab
The "Time Zone" Tab
9 Profiles
Call Permissions
Call permission of a user
Call permission of a trunk group
Example 1
Example 2
Example 3
Call permissions in the standard installation.
Create Call Permission
Change Call permission
Properties Call Permission General Tab
Calling Right - The "Rights" Tab
Function profile
Feature profiles for online licensing
Feature Profiles in the Standard Installation
Feature profiles in SwyxWare for DataCenter and SwyxON
Modify a Feature Profile
Feature profile - Tab "General"
Feature Profile - The "Features" Tab
Administration profiles
Administrators in SwyxWare for DataCenter and SwyxON
Providers and Resellers/Partners
Customers
Granting of rights
10 Numbers and Number Mappings
Number Types
Internal numbers
External numbers
SIP-URIs
Number concept
Example of a number concept
Mapping of numbers
Examples of number mappings
SwyxWare With Three Locations
User A
User B
User C
Placeholder
General Placeholders
Examples of general placeholders
Special placeholders
Placeholders in the Call Permission
Placeholders for number replacement
Further examples of number replacement
Supplied Configuration Data
NumberFormatProfiles.config
ProviderProfile.config
11 User Configuration
Configuring a new User
User configuration
The "Administrator properties for UserDialog
The "Administration" Tab
The "Authentication" Tab
The "RemoteConnector" Tab
"Use automatically generated certificate"
"Use manually generated certificate"
The "SIP Registration" Tab
The "Files" Tab
The Tab "SwyxPhone Lxxx"
The "Call Intrusion" Tab
The "Advanced" Tab
The "Encryption" Tab
The "Codec Filter" Tab
Dialogue "Phone numbers..."
The "Numbers" Tab
The "Alternative Numbers" Tab
The "SwyxFax Numbers" Tab
The "CTI+" Tab
The "Buttons…" Dialog
The "Call Routing Manager…" Dialog
The "Call Forwarding..." Dialog
The "Call Forwarding Unconditional" Tab
The "Call Forwarding Busy" Tab
The "Call Forwarding No Reply" Tab
Standard Voice Box Tab
Tab „Standard Remote Inquiry"
The "Mobile Extensions" Tab
The "Client…" Dialog
The "General" Tab
The "Lists" Tab
The "Conversation Recording" Tab
The "Speed Dials" Tab
The "Shortcuts" Tab
Export and import of speed dials and shortcuts.
The"Line keys" Tab
The "Skin" Tab
The "Ringing" Tab
The "Keyboard" Tab
Tab „SwyxPhone"
The "Login Device" Tab
Dialog "Fax Client Configuration:"
The "General" Tab
The "Sender" Tab
The "Send Options" Tab
The "Transmit Reporting" Tab
Fax Handling
Succeeded Fax Transmit Confirmation
Failed Fax Notification
The "Text Converter" Tab
The "Miscellaneous" Tab
The "Properties…" Dialog: The "Relationships" Tab
The "Properties…" Dialog: The "Secretariat" Tab
The "Properties…" Dialog: The "Rights" Tab
The "Properties…" Dialog: The "Login Device" Tab
Personal Phonebook for a User
Activate/deactivate or delete users
To assign properties of a user to a number of other users
Configure users in the Windows user administration
SwyxWare user assignment when creating a Windows user
Assign SwyxWare user to existing Windows users
SwyxWare user data amendment in Windows administration
Delete an associated SwyxWare user or the link
Export User List
Voice Box
Remote Inquiry
Conference
Conference Rooms
Silent conference participation
12 Configuration of Groups
Create a group
Configure group
The "Properties…" Dialog The "General" tab
The "Properties…" Dialog The "Numbers" Tab
The "Properties…" Dialog The "Members" Tab
The "Properties…" Dialog The "Relationships" Tab
The "Properties…" Dialog The "Alternative Numbers" Tab
The "Properties…" Dialog: The "Voice Box" Tab
The "Properties…" Dialog: The "Advanced" Tab
Secretariate
13 Trunks and Trunk Groups
Setting up trunks and trunk groups
Editing trunks and trunk groups
Deleting a trunk or a trunk group
Configure trunk groups
The "General" Tab
The "Profile" Tab
The "SIP" Tab of the SIP Trunk Group
The "Encryption" tab of the SIP Trunk Group
Tab "SIP" of the ENUM Trunk Group
The "Routing Records"Tab
The "Rights" Tab
The "Location" Tab
Activating and deactivating a trunk
14 Routing
Routing configuration
The "General" Tab
The "Routing" Tab
The "Source" Tab
The "Timely Conditions" Tab
Repeated connection attempts with least cost routing
Extended Least Cost Routing
15 ISDN connections
Basics for the ISDN connection
Connection Types for the ISDN Lines
PSTN Access
Installation of the ISDN Cards
Preparation of the SX2 QuadBRI before insertion
Configuration of the Operating Mode
Configuration of the supply voltage in NT mode
Configuration of the SO bus termination
Configuration of the PCI bus power supply (not for SX2-express QuadBRI)
Configuration of the card number
PCM bus connection
LED Status Display
Preparation of SX2-express SinglePRI / SX2-express DualPRI
Connection Configuration
Configuration of the card number
PCM bus connection
LED Status Display
Configuration of the ISDN Card
Configuration of the Line Termination
Preparation of the SX2 SinglePRI
Connection Configuration
Configuration of the Line Termination
Configuration of the PCI bus power supply
Configuration of the card number
PCM bus connection
LED Status Display
Preparation of the SX2 DualPRI
Connection Configuration
Configuration of the Line Termination
Configuration of the PCI bus power supply
SwyxStandby support
Configuration of the Interrupt assignment
Configuration of the card number
PCM bus connection
LED Status Display
Insertion of the ISDN Card
Installation of the software for the ISDN card
Configuration of the ISDN Card
Creation of an ISDN trunk group
Profile of an ISDN trunk group
Creation of an ISDN trunk
Configuring an ISDN Trunk
The "General" Tab
The "Numbers" Tab
"Number signaling" tab
The "Codecs/Channels" Tab
The "ISDN Ports" Tab
Installation of separated Gateways (SwyxGate)
Install SwyxGate
Configuring SwyxGate
Uninstalling
Uninstalling SwyxGate:
Uninstalling SwyxGate, Whereby Other Existing Components Remain
Uninstalling the SX2 Card Drivers
16 SIP Links
What are SIP Trunks?
Scenario
Overview of Compatible SIP Providers
STUN
Creating a SIP Trunk Group
Profile of a SIP Trunk Group
Creating a SIP Trunk
Configuring a SIP Trunk
The "General" Tab
The "SIP Registration" Tab
The "Numbers" Tab
The "SIP-URIs" Tab
"Number signaling" tab
The "Codecs/Channels" Tab
Sending Faxes via SIP Connection
Configuring the Firewall for a SIP Trunk
17 SwyxLink (Server-Server Connection)
The Basics
Creating a SwyxLink Trunk Group
Creating a SwyxLink Trunk
Configuring a SwyxLink Trunk
The "General" Tab
The "Link Settings" Tab
Intersite Settings
The "SIP Registration" Tab
The "Numbers" Tab
"SIP-URIs"
"Number Signaling"
The "Codecs/Channels" Tab
The "Encryption" tab
Properties of the SwyxLink Connection
18 ENUM Links
What is an ENUM Trunk?
How an ENUM Trunk Works
Creation of an ENUM Trunk Group
Creating an ENUM Trunk
Configuring an ENUM Trunk
The "General" Tab
The "Numbers" Tab
"Number Signaling"
The "SIP-URIs" Tab
The "Codecs/Channels" Tab
The "Encryption" tab
Configuring the Firewall/NAT Router for an ENUM Trunk
19 SIP Gateway Links
What is a SIP Gateway Trunk?
Application scenarios
Branch office with central SwyxWare
Creating a SIP Gateway Trunk Group
Creating a SIP Gateway Trunk
Configuring a SIP Gateway Trunk
The "General" Tab
The "SIP Registration" Tab
The "Numbers" Tab
"Number signaling" tab
The "Codecs/Channels" Tab
The "Encryption" tab
Connecting the gateway to SwyxWare
20 Connection of SwyxPhone and SwyxIt!
Licenses for System Phones
Install and update Whitelist
Licenses for SwyxIt!
General Network Configuration (DHCP/DNS/WINS Services)
DHCP-Server (Dynamic Host Configuration Protocol)
WINS (Windows Internet Name Service)
DNS (Domain Name Service)
Use of SwyxPhone Lxxx
Distribution of the PhoneManager IP address to the SwyxPhone Lxxx
Correct time to connect to SwyxServer
Initial operation of theSwyxPhone Lxxx
Automatic Firmware Update for a SwyxPhone Lxxx
Use of SwyxIt!
Distribution of the SwyxServer IP address to SwyxIt!
DHCP Configuration of SwyxIt!
Configuration of DNS Server for SwyxIt!
Automatic distribution of SwyxIt! in a network
Using SwyxIt! from home office
Connection to Swyx Messenger
SwyxIt! Installation from the Command Line
Customer-specific context menu for Speed Dials
SwyxIt! Web Extension
Use of System Variables
21 Encryption
Encryption within SwyxWare
Configure Encryption Mode Globally for SwyxServer
22 Scripts
Call Routing Manager and Grafischer Skript Editor
Signing Scripts
Default call handling
Voice Box
Remote Inquiry
Call Forwarding Configuration for Remote Inquiry
Overview of the Remote Inquiry Menus
Name Announcement
Operator (AutoAttendant)
Installation of the AutoAttendant
Operator and SwyxWare Update
Change Operator Script
Dial by Name
The Group "Everyone"
Standard Scripts in the Database
System standard files
User files
PIN query for conference room (GSE) (kb2377)
Function codes
23 Standby SwyxServer
Convert Master or Standby System to a Stand-alone System
24 SwyxFax Server
System requirements
The Basics
Licenses
Install SwyxFax Server
Configuring SwyxFax Server
The "General" Tab
Tab "Cover Page"
The "Journal" Tab
The "Parameters" Tab
The "Headline" Tab
The "Transmit Reporting" Tab
Tab "Protocol"
Fax Documents on the Server
Stored Fax Documents
Editing Fax Documents
Delete fax documents
Pause
Resume
Reactivate
Properties of a fax job"
Fax Document "Properties": "General" tab
Fax Document "Properties": "Send Options" tab
Fax Document "Properties": "Status" tab
Fax Channels
Fax channel properties
The "General" Tab
The "Numbers" Tab
Clear
Fax forwarding as Faxmail or printed document
Form Storage
Traces
SwyxFax Printer Gateway
Printing serial letters with SwyxFax Client
25 SwyxCTI and SwyxCTI+
Authorize SwyxCTI+ with a thid party phone
Authorize SwyxCTI+ with external phone via its number.
Configure a CTI pairing to the number of an external phone
26 Cross-network connections
Internet connection via SwyxRemoteConnector
Authentication Service
Configuration
Port forwarding via router
Configuration of SwyxIt!
Configure connection via SwyxRemoteConnector
Configuring voice compression
WAN connections
Small Office - Connection
Configuration of SwyxIt!
Configuration of SwyxPhone
Linking of two locations (head office and branch)
Configuration at the London (A) Location
Configuration at the Liverpool (B) Location
Intersite Presence
Connection of three SwyxServers within an organization
Configuration at the London location (SwyxServer A)
Configuration at the Vienna location (SwyxServer C)
Connection between two SwyxServers of different organizations
Configuration at the London location (SwyxServer A)
Configuration at the Liverpool location (SwyxServer B)
Different connection types between multiple SwyxServers
Configuration on SwyxServer A
Configuration on SwyxServer B
Configuration on SwyxServer C
Configuration on SwyxServer D
Connections between locations in SwyxON
App. A: Call Detail Records (CDR)
File Format
Examples for CDR
CDR for a Simple Internal Call
CDR for an External Call
CDR for a Call with Call Routing
CDR for a Transferred Call
The Charging Information
Charging Information via ISDN
Accuracy of the Charges
Charging Information in Sub-PBX or ISDN Device on an Internal BRI/PRI bus
Charging Information via SwyxLink Trunk
App. B: AudioCodes Terminal Adapter
AudioCodes Terminal Adapter MP-11x or MP-124 with SwyxWare
Update AudioCodes Terminal Adapter for SwyxWare
App. C: SwyxConnect 5000/8000
System requirements
Overview
Variants
Key concepts
Proxy Set
IP group
Trunk Group
Account Table
Call directions: IP-to-Tel, Tel-to-IP and IP-to-IP
Functional units of SwyxConnect 5000/8000
Manipulations
Routing
Combination of manipulation and routing
Digit Mapping
Application scenarios
SwyxConnect 5000/8000 as SIP Gateway
SwyxConnect 5000/8000 as SIP Gateway with SAS
Configuring SwyxConnect 5000/8000 for use with SwyxWare
Preparation of SwyxWare
Startup of SwyxConnect 5000/8000
Configuration and Installation of the INI Files
Configuration of the INI file
Installation of the INI file
App. D: Internal connections (BRI/PRI)
SwyxWare as the main telecommunication system
Operating the SX2 cards in NT Mode
Supported devices on the Basic Rate Interface (BRI)
Supported devices on the Primary Rate Interface (PRI)
SX2 in NT Mode
Configuring the SX2 cards for NT mode
Operation of several SX2 cards in one computer
Synchronizing the SX2 cards
Connecting a Sub-telecommunication System (Sub-PBX) to SwyxWare
Configuration of the ISDN trunk group and ISDN trunks (SwyxGate lines)
Connection of SwyxWare as Sub-telecommunication System on a Main Telecommunication System
Configuration of the ISDN Trunk Group and Trunks
SwyxWare alongside another system with additional access to the public network
Installation of a gateway with SX2 DualPRI V2
Preparation of the SX2 DualPRI V2 before insertion
Clocking in the Standby Configuration
App. E: Tools & Traces
PowerShell support
Installation
Starting
Help on module and list of Cmdlets
Active Directory extension
User Import Assistant
Test Programs for the ISDN Cards
Test Programs for the SX2 Card Family
Connection tester contest
D Channel Monitor
Traces of the SwyxWare Services
Swyx Trace Tool
Installation of the Swyx Trace Tool
Memory requirement
Automatic File Deletion (Cleanup)
Trace Profile - Scope of Traces
Swyx Trace Tool from the command line
Tracing during installation
Tracing from SwyxIt!
App. F: ESTOS, DATEV, C4B integration
System requirements for ESTOS MetaDirectory 4 Professional and C4B XPhone Connect Directory V6.0.81 SR 1
ESTOS MetaDirectory or C4B XPhone Connect Directory uses port 712 by default.
Specify LDAP server parameters
SwyxPLUS VisualGroups
App. G: Swyx Push Notification Service
Installation of the Swyx Push Notification Service
App. H: IBM Notes integration
Overview
Requirements
Voice messages
Calendar Query
Name Resolution for SwyxIt!
Displaying an IBM Notes contact for an incoming call
Sending an email from SwyxIt!
IBM Notes features on the Speed Dial
Installation and distribution
Configuration of the database display and selection
Configuration requirements
Database settings
Saving and distributing the database configuration
App. I: Application Examples
SwyxServer as a Conference Server
Requirements
Installation
Configuration
SwyxIt! and SwyxPhone in a Terminal Server Environment
Terminal server basics
Configuration
Configure audio devices for remote desktop environment
CTI SwyxIt! on terminal server
App. J: Provision of Statistics and Traps via SNMP
Windows SNMP Service
Performance Statistics via the WMI Interface
App. K: Devices
Overview of available devices
USB audio devices
Desktop phones
Conference Phones
Wireless DECT phones
SwyxDECT 500
SwyxDECT 800
Enreach DECT 600
Configuration of the Terminal Devices in SwyxIt!
Configuration of the Output
Configuration of SwyxPhone Lxxx
Configuration of Call Signaling
Use of a Headset with a SwyxPhone Lxxx
Terminal Devices from Third Party Manufacturers
SIP Devices
IP a/b adapter
App. L: High Availability Solution for SwyxWare
Concept
Options
Migration from the Standby Scenario to a Virtual Machine
Converting a Master SwyxWare to a Single System
Create a Back-up of SwyxWare data base
Reinstall SwyxWareon a virtual machine and back-up it
Installation and operation of a SwyxWare with VMware vSphere
Installing SwyxWare in a Virtual Machine
Installation and operation of a SwyxWare with Microsoft Hyper-V Failover Cluster
Installing SwyxWare in a virtual machine
Configuring the SwyxWare HealthMonitor
Configuration of the SwyxWare services
Start HealthMonitor
Check installation
In operation
Monitoring with Grafana and Prometheus
Concept
Installation
Install Docker
Customize configuration files
Configure SwyxWareCore HealthMonitor
Start Grafana and Prometheus
Optional: sonar-perfmon Exporteur installieren
Install SwyxWare HealthMonitor Grafana Dashboard (as example)
Installation überprüfen
App. M: Configuration of the ISDN Driver
SX2 ISDN card properties
The "Advanced" Tab
ISDN Parameters
The "General" Tab
„Identification" Tab
"Connection" tab
"Primary" tab (only PRI cards)
WAN parameter
App. N: Approvals, Codes, Data Sheets
ISDN Card SX2 QuadBRI
ISDN boards SX2-express SinglePRI / SX2-express DualPRI
ISDN Card SX2 SinglePRI
ISDN Card SX2 DualPRI
App. O: Technical Terms
32892
online_licensing_$
feature_profiles_$
Monitor_$
offline_licensing_$
licensing_procedure_$
Options_Optionpacks_$
Standby_$
202
200
run_setup_$
configure_swyxware_$
400
201
additional_computer_$
Default
SCST
WelcomePage
ServerName
658
AutoCertificate
ServerDns
RcAccessAuto
RcCertificateAuto
SummaryAuto
OwnFqdn
ManualCertificate
RcAccessManual
RcCertificateManual
SummaryManual
RcAccessSelfSigned
RcCertificateSelfSigned
SummarySelfSigned
swyxware_registration_$
8105
preconfigured_users_$
8108
9836
SIP_$
8223
tab_client_settings_$
9985
9837
8249
9045
tab_licenses_$
9688
9924
9925
tab_files_$
addFiles_$
10032
9962
usage_reports_$
9105
9504
9513
8994
9039
10013
tab_security_$
10319
10050
9171
9153
9497
changelog_$
1267
1275
10022
8373
8152
1398
781
893
9689
conference_limitation_$
9690
9691
profiles_$
904
785
9661
9662
function_profile_$
1045
988
9955
9954
9977
9976
1046
991
number_mapping_$
783
configure_users_$
8132
9429
9464
9483
9956
remote_connector_$
10066
SIP_registry_$
9511
9951
9490
9693
tab_advanced_$
9493
encryption_$
10014
10052
assign_numbers_$
9838
9993
10005
118
117
123
120
111
564
108
119
110
544
534
554
655
653
594
618
596
617
654
674
593
614
656
657
724
597
595
124
10021
8250
10045
10025
10026
10027
status_signaling_$
8414
335
tab_rights_$
338
9503
deactive_users_$
10320
9183
silent_conference_$
8143
8139
10043
8397
8400
8228
332
330
329
331
333
336
337
Trunks_TrunkGroups_$
894
782
772
9721
9722
9723
9727
9724
9726
9728
9729
784
9702
9967
9927
9989
9928
isdn_trunkgroup_$
9660
9664
9710
9711
9942
9938
10037
9713
9719
9715
sip_connections_$
sip_trunkgroup_$
9717
9718
9716
gateway_connection_$
create_sip_gateway_$
9720
10018
whitelist_$
auto_attendant_$
SwyxFax_Server_$
1199
10006
10007
10008
10009
10010
10011
10012
10034
1201
1202
10029
10030
10031
1200
10033
9995
9996
1203
CTI_connection_number_$
10056
cross_network_connection_$
internet_connection_remotecontroler_$
642
643
mobile_clients_$
small_office_$
intersite_presence_$
CDR_$
Swyx_Connect_$
Digit_Mapping_$
active_directory_$
203
204
terminalConfig_$
Swyx_CTI_$
HighAvailability
SW_VM_vSphere