Installation and User Guide for an InformaCast Virtual Appliance Environment

Transcription

1 DialStreamer Installation and User Guide for an InformaCast Virtual Appliance Environment Corporate Headquarters: Singlewire Software 1002 Deming Way Madison, WI Singlewire. All rights reserved.

2 2019 Singlewire. All rights reserved. InformaCast is a trademark of Singlewire Software. All other referenced trademarks are trademarks of their respective owners and our reference to them does not imply or indicate any approval, endorsement, sponsorship or affiliation with such owners unless such approval, endorsement, sponsorship or affiliation is expressly indicated. Last updated: January 22, 2019

3 Table of Contents DialStreamer Overview Solution Components Prerequisites Intended Audience A Note on Usage Getting Help Install the Barix Instreamer Configure a Unified Communications Manager Application User.. 11 Configure InformaCast Add DialStreamer.js to Script Plugin Create a Recipient Group for Your Script Recipient Create an InformaCast Message for DialStreamer Create a CallAware Plugin Call Redirect Configure Cisco Unity Connection Use DialStreamer Acknowledgments

4 DialStreamer Overview DialStreamer Overview Solution Components Prerequisites DialStreamer is a Singlewire solution that allows an IP phone to join a multicast stream that was not originated by InformaCast. For example, IP phone users are sitting in a loud room with multiple TVs. The loudness of the room makes it impossible to clearly hear a TV s audio. Using DialStreamer, each user can pick up their phones, dial a number connected to a TV, and listen to that TV s audio. DialStreamer uses the following components: InformaCast Virtual Appliance or later 1 Barix Instreamer 100 Before configuring DialStreamer, you should already have: InformaCast installed and working (refer to the InformaCast Virtual Appliance Installation and User Guide or later for further instructions) The CallAware plugin configured and working In addition, you will need: A Barix Instreamer 100 Note There are several similarly named Barix products: the Instreamer and the Exstreamer. The Instreamer takes audio input from an A/V source, like a TV, while the Exstreamer sends audio output to an A/V source or speaker. This application requires an Instreamer and will not work with an Exstreamer. Intended Audience A Note on Usage An RCA two-channel (right/left) male-to-male cable The software distribution package for DialStreamer (available as a ZIP file), which includes the DialStreamer.js script meant for use with the InformaCast Script plugin This user guide is written with two audiences in mind, the installers and users of DialStreamer. Specific fonts are used to represent specific kinds of information in this user guide. The fonts and their meaning are listed here: Bold fonts indicate the name of a button, text field, or other element with which you interact and any text that you must enter. 1. DialStreamer is not supported on InformaCast , , or

5 DialStreamer Overview Italic fonts indicate the name of an area or section on one of InformaCast s pages. Angled brackets enclose text that varies with your specific environment, i.e. IP Address> means that you would enter your specific IP address instead of the brackets and what they enclose. Blue, underlined text indicates a hyperlink. There are several kinds of notification boxes used in this guide: Tip. These offer advice or best practices. Note. These contain additional information, usually relevant in special cases. Caution. These contain information about a procedure that may reduce the performance of your system. Warning. These contain information about a procedure that can impair or disable your system. Getting Help You can find additional help from the Singlewire Support Community (available to you with a current maintenance contract). If you still have questions, initiate a request for support. 2

6 Install the Barix Instreamer Install the Barix Instreamer Before you can begin using DialStreamer, you must install the Barix Instreamer with which it will work. Step 1 Step 2 Step 3 Step 4 Step 5 Connect the Instreamer to your IP network and the LAN port with an Ethernet cable. Connect the RCA-style audio output jacks on your TV (or the device you re using to source audio) to the Instreamer. Connect the power cable to a power source and the Pwr jack of the Instreamer. Plug headphones into the headphone jack of the Instreamer and listen for the IP address that the Instreamer receives. Open a web browser and enter the IP address that the Instreamer read to you. By default, there is no username or password set. The Barix Instreamer page appears. 3

7 Install the Barix Instreamer Step 6 Click the Configuration button. The Settings page appears and should open to the Network tab. If it doesn t, click the Network tab. Step 7 Enter the Instreamer s IP address in the IP Address fields (it read this to you in Step 4) or leave the fields at zero and the Instreamer will receive an address via DHCP. If you entered an IP address, continue with Step 8 on page 5. If you re using DHCP, continue with Step 10 on page 7. 4

8 Install the Barix Instreamer Step 8 Click the Apply button. The Settings page refreshes with a countdown. 5

9 Install the Barix Instreamer Step 9 Wait for the countdown to finish, then click the Wait for the countdown and then click here to continue link. The Settings page appears open to the Network tab and your IP address is now set. 6

10 Install the Barix Instreamer Step 10 Click the Audio tab. The Settings page refreshes. 7

11 Install the Barix Instreamer Step 11 Select G.711 µlaw/8 khz mono from the Encoding+Frequency dropdown menu and click the Apply button to save your changes. The Settings page refreshes with a countdown. When the countdown finishes, your browser should automatically forward you to the Audio tab on the Settings page. If it doesn t, click the here link to return. 8

12 Install the Barix Instreamer Step 12 Click the Streaming tab. The Settings page refreshes. Step 13 Step 14 Scroll down to the Stream to area and select RTP from the Conn. type dropdown menu in the first row. Enter your multicast IP address and port number in the IP #, #, and Port # fields in the first row. The multicast IP address should be chosen after consultation with your networking group and the port number must be an even numbered port that is greater than

13 Install the Barix Instreamer Step 15 Click the Apply button to save your changes. The Settings page refreshes with a countdown. Step 16 When the countdown finishes, your browser should automatically forward you to the Streaming tab on the Settings page. If it doesn t, click the here link to return. Close this window. Your Instreamer configuration is complete. 10

14 Configure a Unified Communications Manager Application User Configure a Unified Communications Manager Application User DialStreamer uses a Cisco Unified Communications Manager application user to authorize authentication requests sent by phones to Unified Communications Manager. Every phone that will use DialStreamer must be listed as a controlled device of the DialStreamer application user. Step 1 Go to User Management Application User. The Find and List Application Users page appears. 11

15 Configure a Unified Communications Manager Application User Step 2 Click the Add New button. The Application User Configuration page appears. Step 3 Step 4 Step 5 Step 6 Enter an appropriate user ID in the User ID field, e.g. DialStreamer. Enter a password into the Password field, and enter it again in the Confirm Password field. You will need to remember the user ID and password values because you will enter them into the DialStreamer CallAware Redirect s Long Text field in Step 11 on page 26. Select all phones that will use DialStreamer in the Device Information area and move them from the Available Devices field to the Controlled Devices field using the down arrow. Click the Save button to save your changes. Your application user is saved. 12

16 Configure InformaCast Configure InformaCast Configuring InformaCast for use with DialStreamer involves: Adding the DialStreamer.js script as a script recipient in the Script plugin Creating a recipient group that contains your script recipient Creating an InformaCast message that will be broadcast with DialStreamer Creating a call redirect in the CallAware plugin Add DialStreamer.js to Script Plugin The DialStreamer.js script must be added to the Script plugin as a script recipient. Step 1 Open a web browser, enter the IP address of the InformaCast Virtual Appliance, and press the Enter key. The InformaCast Virtual Appliance landing page appears. 13

17 Configure InformaCast Step 2 Click the InformaCast link. A separate tab/window opens to InformaCast s Login page. Step 3 Enter your username and password in the Login and Password fields and click the Log In button. InformaCast s homepage appears. 14

18 Configure InformaCast Step 4 Go to Plugins Script. The Script Plugin page appears. Step 5 Click the Configuration link. The Script Recipient Configuration page appears. 15

19 Configure InformaCast Step 6 Click the Add button. The Add Script page appears. Step 7 Enter a name for your script in the Script Name field, e.g. Multicast Listen Script. Note You will need just one script, regardless of the number of audio streams you wish to make available using the script. Step 8 Click the Choose File button next to Script File. The Choose File to Upload dialog box appears. Step 9 Navigate to where you downloaded your software distribution package for DialStreamer, select the DialStreamer.js file, and click the Open button. 16

20 Configure InformaCast Step 10 Click the Save button. The Script Recipient Configuration page appears, confirming your script s addition. 17

21 Configure InformaCast Create a Recipient Group for Your Script Recipient Once you ve added DialStreamer.js to the Script plugin, you ll need to create a recipient group that contains that script recipient. Step 1 Go to Recipients Edit Recipient Groups. The Edit Recipient Groups page appears. This page shows the number of phones, plugin recipients, and currently registered IP speakers for each group. Note Only licensed options will appear on this page. For example, if your system is not licensed for IP speakers, the Speakers column will not appear. 18

22 Configure InformaCast Step 2 Click the Add button. The Add Recipient Group page appears. Step 3 Step 4 Step 5 Enter a name for your recipient group in the Name field. Enter a dial code for your recipient group (if applicable) in the Dial Code field. Add/Select an existing recipient group tag from the Tags field/add a Tag dropdown menu (optional). 19

23 Configure InformaCast Step 6 Select the Individually checkbox on the Add Recipient Group page and click its Edit button. The Select Individual Recipients pop-up window appears. Step 7 Scroll through the list until you find the script name you created in Step 7 on page 16. Step 8 Double click your script s name or select it and click the Add link to move it from the Available Recipients area to the Selected Recipients area. 20

24 Configure InformaCast Step 9 Click the Submit button. The script recipient is added to the recipient group. Step 10 Click the Update button. Your recipient group is created. 21

25 Configure InformaCast Create an InformaCast Message for DialStreamer After you ve created your DialStreamer recipient group, you ll need to add the InformaCast message that DialStreamer will use. Step 1 Go to Messages Send or Edit Messages. The Send or Edit Messages page appears. 22

26 Configure InformaCast Step 2 Click the Add button. The Add Message page appears. Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Enter a name for your message in the Description field. Select Text from the Message Type dropdown menu. Select the Allow Customization checkbox. Enter Replaced by the CallAware Plugin in the Short and Long Text fields. Set any other message parameters that pertain to your environment. Click the Add button. Your message is saved. 23

27 Configure InformaCast Create a CallAware Plugin Call Redirect Your call redirect will use the InformaCast message and recipient group you created in Create a Recipient Group for Your Script Recipient on page 18 and Create an InformaCast Message for DialStreamer on page 22. Note If you have not yet set up the CallAware plugin, you will need the Cisco Unified Communications Manager application username and password you created for InformaCast before you can create your call redirect. Contact your administrator if you don t know your application username or password, and see CallAware Plugin Overview for more information on configuring the plugin. Step 1 Go to Plugins CallAware. The CallAware Plugin page appears. 24

28 Configure InformaCast Step 2 Click the Call Redirects link. The Call Redirects page appears. Step 3 Click the Add button. The Add Call Redirect page appears. Step 4 Enter DialStreamer in the Name field. 25

29 Configure InformaCast Step 5 Step 6 Step 7 Step 8 Step 9 Step 10 Step 11 Step 12 Use an existing route point in your environment that has no calling search space assigned to it as the value for the Route Point Name,DN field. Enter the Unity Connection voic pilot number in the Redirect Call to DN field. This will cause calls to go to Unity Connection where a custom routing rule and call handler will accept the call and hang it up (see Configure Cisco Unity Connection on page 27 for more information). Select the Route Point s CSS radio button for Redirect Call using. Select the InformaCast message you created in Step 3 on page 23 from the InformaCast Message dropdown menu. Select the recipient group you created in Step 3 on page 19 from the Recipient Groups field. Enter ${callingphone} in the Short Message Text field. Enter { "phone_user": "InformaCast_JS", "phone_password": "changeme", "multicast_ip": " ", "multicast_port": "20480" } in the Long Message Text field, substituting your DialStreamer application username and password for phone_user and phone_password, respectively. Click the Save button. Your call redirect is saved. 26

30 Configure Cisco Unity Connection Configure Cisco Unity Connection Cisco s CTIManager service is failing to recognize when calls should be dropped during DialStreamer s use. When calls aren t dropped properly, they get stuck on the phone and eventually cause all calls to the phone to fail. To prevent these failures from occurring, you will create a system call handler in Cisco Unity Connection with a rule to direct all calls from CallAware s CTI route point to be dropped with no greeting played. This same system call handler can also be used to drop calls from InformaCast that accidentally end up in voic . Step 1 Open a web browser and log into the administration interface of Unity Connection (the address will be similar to Connection IP Address>/cuadmin). The Cisco Unity Connection Administration page appears. 27

31 Configure Cisco Unity Connection Step 2 Go to Call Management System Call Handlers in the left navigation menu. The Search Call Handlers page appears. 28

32 Configure Cisco Unity Connection Step 3 Click the Add New button. The New Call Handler page appears. 29

33 Configure Cisco Unity Connection Step 4 Enter a name for your call handler in the Display Name field, e.g. Drop Calls from DialStreamer, and click the Save button. The Edit Call Handler Basics page appears. 30

34 Configure Cisco Unity Connection Step 5 Go to Edit Greetings in the Edit Call Handler Basic page s menu structure. The Greetings page appears. 31

35 Configure Cisco Unity Connection Step 6 Click the Standard link. The Edit Greeting (Standard) page appears. Step 7 Step 8 Select the Nothing radio button in the Callers Hear area. Scroll down the page to the After Greeting area, select Hang Up from the Call Action dropdown menu, and click the Save button. 32

36 Configure Cisco Unity Connection Step 9 Go to Call Management Call Routing Forwarded Routing Rules in the left navigation menu. The Forwarded Routing Rules page appears. 33

37 Configure Cisco Unity Connection Step 10 Click the Add New button. The New Forwarded Routing Rule page appears. 34

38 Configure Cisco Unity Connection Step 11 Enter a name for your forwarded routing rule in the Display Name field, e.g. Drop Calls from DialStreamer, and click the Save button. The Edit Forwarded Routing Rule (Drop Calls from DialStreamer) page appears. 35

39 Configure Cisco Unity Connection Step 12 Click the Add New button in the Routing Rule Conditions table. The Edit Forwarded Routing Rule Condition page appears. Step 13 Step 14 Step 15 Select the Forwarding Station radio button. Ensure In is selected from the dropdown menu and enter the DN users will dial to start streaming audio via DialStreamer in the field (this is the same DN you entered in Step 5 on page 26). Click the Save button. 36

40 Configure Cisco Unity Connection Step 16 Click the Edit Forwarded Routing Rule (Drop Calls from DialStreamer) link at the top of the page to return to the Edit Forwarded Routing Rule (Drop Calls from DialStreamer) page. You can see the Forwarding Station parameter that now appears in the Routing Rule Conditions table. Step 17 Step 18 Step 19 Select the Call Handler radio button in the Send Call to area. Ensure Drop Call appears in the Call Handler dropdown menu. Select the Go Directly to Greetings radio button and click the Save button. 37

41 Configure Cisco Unity Connection Step 20 Click the Forwarded Routing Rules link at the top of the page to return to the Forwarded Routing Rules page. You can see your new forwarded routing rule that now appears in the Forwarded Routing Rules in Descending Order of Precedence table. Note Your newly created forwarded routing rule should appear as a higher preference than other, generic rules. If it appears lower in the Forwarded Routing Rules in Descending Order of Precedence table, click the Change Order button and move the rule higher in the list of rules. 38

42 Use DialStreamer Use DialStreamer Now that you ve completed your configuration of DialStreamer, you can pick up the receiver of an IP phone on your network, dial the redirect number you created in the CallAware plugin, and listen to the audio on a TV (or the device of your choice that s sourcing audio). Your device s connection through RCA cables to the Instreamer converts its audio into a multicast RTP stream available to your IP phone. 39

43 Acknowledgments Acknowledgments 2019 Singlewire. All rights reserved. InformaCast is a trademark of Singlewire Software. All other referenced trademarks are trademarks of their respective owners and our reference to them does not imply or indicate any approval, endorsement, sponsorship or affiliation with such owners unless such approval, endorsement, sponsorship or affiliation is expressly indicated. Singlewire Software products would not be what they are without the use of open source software. Singlewire takes its open source compliance obligations seriously, and towards this end, the open source information for each product release is published here. 40