Welcome
  Welcome
  Welcome
Linux Installation, Configuration and Management
  Overview
  Version History
  Tasks
    Using Blueworx Voice Response as a VoiceXML Browser
    Using Blueworx Voice Response as a CCXML Browser
  Requirements
    VM Requirements
    Network Requirements
  Installation
    Installing the Blueworx Yum repository
    Installing Blueworx (new installation)
      Files and Folders created during Installation
    Installing Blueworx Utilities
    Installing PostgreSQL 9.6 Database for Blueworx CPD
    Installing PostgreSQL 10 Database for Blueworx CPD
    Migrating from PostgreSQL 9.6 to PostgreSQL 10 Database for Blueworx CPD
    Updating Blueworx (existing installation)
    Removing Blueworx
    Manual installation of Blueworx packages
    Installing additional Blueworx software
      Installing the Web UI
    Installing Apache Kafka (optional)
    Installation Validation
    Best Practices
  Configuration
    Linux Configuration
    License Configuration
      Setting up the License Key for a Standalone System
      Updating the License Key for a Standalone System
      Setting up the License Key for a redundant BRM System
      Updating the License Key for a redundant BRM System
    Platform Configuration
      TOML Configuration File Format
      BVR Configuration
      BVR Configuration Options
        General Configuration Options
        Security Configuration Options
        SIP Configuration Options
        SIP Listening Point Configuration Options
        SIP Proxy Configuration Options
        SIP Proxy Realm Configuration Options
        SIP Security Configuration Options
        Trace Configuration Options
        Log Configuration Options
        VXML Configuration Options
        Streaming Configuration Options
        BVR Codec Configuration
        SDP Configuration Options
        Network Configuration Options
        Port Range Configuration Options
        CCXML Configuration Options
        BRM Configuration Options
        CTI Configuration Options
        CDR Configuration Options
        MRCPv2 Configuration Options
        Inbound Call Configuration Options
        Outbound Call Configuration Options
        IBM Voice Gateway Configuration Options
        Remote Recording Configuration Options
      BRM Configuration
      BRM Configuration Options
        General Configuration Options
        BRM Configuration Options
        Trace Configuration Options
        Security Configuration Options
        Main Database Configuration Options
        CCXML Configuration Options
      BAM Configuration
      BAM Configuration Options
        General Configuration Options
        Security Configuration Options
        BRM Configuration Options
        Trace Configuration Options
        Main Database Configuration Options
        WebAPI Configuration Options
        Email Configuration Options
      BAM Command Line Utility
        BAM Command Line Utility Initial Panel
        BAM Command Line Utility Inbound Applications
        BAM Command Line Utility Outbound Application
        BAM Command Line Utility Application Mappings
        BAM Command Line Utility Call Features
          Parameters for ASR_MRCPv2 Call Feature
          Parameters for TTS_MRCPv2 Call Feature
          Parameters for TTS_POLLY Call Feature
      CPD Configuration
      Web UI Configuration
      Apache Kafka Configuration
        Configuring Apache Kafka producer properties
        Configuring Apache Kafka topics output from BVR
      Multiple Network Interfaces
  Operation
    BRM Operation
      The brm command
      Starting and Stopping BRM
      Monitoring BRM
      Checking connected BRMs, BVRs and License Usage
    BAM Operation
      The bam command
      Starting and Stopping BAM
      Monitoring BAM
      Application Profile Configuration on BAM
    BVR Operation
      The bvr command
      Starting and Stopping BVR
      Monitoring BVR
      Reporting
      SIP Message Monitoring
      Call and Conference Detail Records (CDR)
        Outputting CDRs to PostgreSQL
      Application logging
      Using an Apache Kafka Producer for Logging and Tracing
      Example Kafka Consumer for Logging and Tracing
    CPD Operation
  Browser Support
    VoiceXML
      VoiceXML language
        VoiceXML elements and attributes
        VoiceXML declaring variables
        Single DTMF Hotword Barge-in
      VoiceXML and SIP
        VoiceXML and SIP Incoming Header Access
        VoiceXML and SIP Outgoing Header Access
      VoiceXML Call Transfer and Bridging
      VoiceXML with CCXML for Call Transfer and Bridging
      VoiceXML with Speech Service Locales
      Genesys CTI with VoiceXML
    CCXML
      CCXML language
        What is CCXML?
        Using ECMAScript
        CCXML Elements
        CCXML Events
        BVR Specific Messages and Events for Call Transfer
        Basic HTTP Event I/O Processor
        Session Creation Event I/O Processor
      CCXML and SIP
        CCXML and SIP Incoming Header Access
        CCXML and SIP Outgoing Header Access
        Recording calls using SIPREC
      CCXML Call Transfer and Bridging
      CCXML Outbound Calling
      Call Progress Detection
        Using Call Progress Detection
        Hints
        Event Notification
        Example AMD Scenarios
      Integration with IBM Watson through IBM Voice Gateway
      Integration with Amazon Lex
      CCXML DTMF Support
      Recording calls in CCXML
  Security
    Secure SIP
    Secure RTP
    Resource Fetching
    Centralised Outbound Calling API
    Web UI
    Cipher Suites
    Logging and Tracing
    Keystores, Truststores and Certificates
      Setting up a Keystore
      Getting a certificate signed by a Certificate Authority
      Adding a Certificate Authority to a Truststore (or Keystore)
      Useful Keystore/Truststore related commands
      Debugging a TLS Connection
  Redundancy
    Redundancy Overview
    BRM Redundancy Configuration
    Starting a Redundant Cluster
    Redundant Platform Example
  Sample Applications
  Problem Determination
    Error logging and Trace
      Error and Trace files
      BVR Error and Trace Outputs
      Trace File Locations
      File and Kafka Message Format
      Controlling Tracing and Logging
    Problem Data Collection
    Web UI
    Apache Kafka
    CCXML Tracing
    VoiceXML Tracing
    SIP Message Tracing
    MRCP Message Tracing
    Errors
  Trademarks
  Overview
  Version History
  Tasks
    Using Blueworx Voice Response as a VoiceXML Browser
    Using Blueworx Voice Response as a CCXML Browser
  Requirements
    VM Requirements
    Network Requirements
  Installation
    Installing the Blueworx Yum repository
    Installing Blueworx (new installation)
      Files and Folders created during Installation
    Installing Blueworx Utilities
    Installing PostgreSQL 9.6 Database for Blueworx CPD
    Installing PostgreSQL 10 Database for Blueworx CPD
    Migrating from PostgreSQL 9.6 to PostgreSQL 10 Database for Blueworx CPD
    Updating Blueworx (existing installation)
    Removing Blueworx
    Manual installation of Blueworx packages
    Installing additional Blueworx software
      Installing the Web UI
    Installing Apache Kafka (optional)
    Installation Validation
    Best Practices
  Configuration
    Linux Configuration
    License Configuration
      Setting up the License Key for a Standalone System
      Updating the License Key for a Standalone System
      Setting up the License Key for a redundant BRM System
      Updating the License Key for a redundant BRM System
    Platform Configuration
      TOML Configuration File Format
      BVR Configuration
      BVR Configuration Options
        General Configuration Options
        Security Configuration Options
        SIP Configuration Options
        SIP Listening Point Configuration Options
        SIP Proxy Configuration Options
        SIP Proxy Realm Configuration Options
        SIP Security Configuration Options
        Trace Configuration Options
        Log Configuration Options
        VXML Configuration Options
        Streaming Configuration Options
        BVR Codec Configuration
        SDP Configuration Options
        Network Configuration Options
        Port Range Configuration Options
        CCXML Configuration Options
        BRM Configuration Options
        CTI Configuration Options
        CDR Configuration Options
        MRCPv2 Configuration Options
        Inbound Call Configuration Options
        Outbound Call Configuration Options
        IBM Voice Gateway Configuration Options
        Remote Recording Configuration Options
      BRM Configuration
      BRM Configuration Options
        General Configuration Options
        BRM Configuration Options
        Trace Configuration Options
        Security Configuration Options
        Main Database Configuration Options
        CCXML Configuration Options
      BAM Configuration
      BAM Configuration Options
        General Configuration Options
        Security Configuration Options
        BRM Configuration Options
        Trace Configuration Options
        Main Database Configuration Options
        WebAPI Configuration Options
        Email Configuration Options
      BAM Command Line Utility
        BAM Command Line Utility Initial Panel
        BAM Command Line Utility Inbound Applications
        BAM Command Line Utility Outbound Application
        BAM Command Line Utility Application Mappings
        BAM Command Line Utility Call Features
          Parameters for ASR_MRCPv2 Call Feature
          Parameters for TTS_MRCPv2 Call Feature
          Parameters for TTS_POLLY Call Feature
      CPD Configuration
      Web UI Configuration
      Apache Kafka Configuration
        Configuring Apache Kafka producer properties
        Configuring Apache Kafka topics output from BVR
      Multiple Network Interfaces
  Operation
    BRM Operation
      The brm command
      Starting and Stopping BRM
      Monitoring BRM
      Checking connected BRMs, BVRs and License Usage
    BAM Operation
      The bam command
      Starting and Stopping BAM
      Monitoring BAM
      Application Profile Configuration on BAM
    BVR Operation
      The bvr command
      Starting and Stopping BVR
      Monitoring BVR
      Reporting
      SIP Message Monitoring
      Call and Conference Detail Records (CDR)
        Outputting CDRs to PostgreSQL
      Application logging
      Using an Apache Kafka Producer for Logging and Tracing
      Example Kafka Consumer for Logging and Tracing
    CPD Operation
  Browser Support
    VoiceXML
      VoiceXML language
        VoiceXML elements and attributes
        VoiceXML declaring variables
        Single DTMF Hotword Barge-in
      VoiceXML and SIP
        VoiceXML and SIP Incoming Header Access
        VoiceXML and SIP Outgoing Header Access
      VoiceXML Call Transfer and Bridging
      VoiceXML with CCXML for Call Transfer and Bridging
      VoiceXML with Speech Service Locales
      Genesys CTI with VoiceXML
    CCXML
      CCXML language
        What is CCXML?
        Using ECMAScript
        CCXML Elements
        CCXML Events
        BVR Specific Messages and Events for Call Transfer
        Basic HTTP Event I/O Processor
        Session Creation Event I/O Processor
      CCXML and SIP
        CCXML and SIP Incoming Header Access
        CCXML and SIP Outgoing Header Access
        Recording calls using SIPREC
      CCXML Call Transfer and Bridging
      CCXML Outbound Calling
      Call Progress Detection
        Using Call Progress Detection
        Hints
        Event Notification
        Example AMD Scenarios
      Integration with IBM Watson through IBM Voice Gateway
      Integration with Amazon Lex
      CCXML DTMF Support
      Recording calls in CCXML
  Security
    Secure SIP
    Secure RTP
    Resource Fetching
    Centralised Outbound Calling API
    Web UI
    Cipher Suites
    Logging and Tracing
    Keystores, Truststores and Certificates
      Setting up a Keystore
      Getting a certificate signed by a Certificate Authority
      Adding a Certificate Authority to a Truststore (or Keystore)
      Useful Keystore/Truststore related commands
      Debugging a TLS Connection
  Redundancy
    Redundancy Overview
    BRM Redundancy Configuration
    Starting a Redundant Cluster
    Redundant Platform Example
  Sample Applications
  Problem Determination
    Error logging and Trace
      Error and Trace files
      BVR Error and Trace Outputs
      Trace File Locations
      File and Kafka Message Format
      Controlling Tracing and Logging
    Problem Data Collection
    Web UI
    Apache Kafka
    CCXML Tracing
    VoiceXML Tracing
    SIP Message Tracing
    MRCP Message Tracing
    Errors
  Trademarks