ADC Proxy Service v1.0.5

Transcription

1 ADC Proxy Service v April-2014

2 Publication Information 2014 Imagine Communications Corp. Proprietary and Confidential. Imagine Communications considers this document and its contents to be proprietary and confidential. Except for making a reasonable number of copies for your own internal use, you may not reproduce this publication, or any part thereof, in any form, by any method, for any purpose, or in any language other than English without the written consent of Imagine Communications. All others uses are illegal. This publication is designed to assist in the use of the product as it exists on the date of publication of this manual, and may not reflect the product at the current time or an unknown time in the future. This publication does not in any way warrant description accuracy or guarantee the use for the product to which it refers. Imagine Communications reserves the right, without notice to make such changes in equipment, design, specifications, components, or documentation as progress may warrant to improve the performance of the product. Trademarks Product names and other brands (such as ADC, D-Series, Nexio, Nexio Insight, Nexio Motion, PowerSmart, Versio ) are trademarks or trade names of Imagine Communications or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. All other trademarks and trade names are the property of their respective companies. Contact Information Imagine Communications has office locations around the world. For domestic and international location and contact information see: Support Contact Information For domestic and international support contact information see: Support Contacts: ecustomer Portal: Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 2 of 16

3 Integrated system Overview Contents Integrated system Overview... 4 About the ADC Proxy Service... 4 Deployment details... 4 Service Location Pre-installation Requirements... 6 (Option) on the ADC File Server... 6 Configuration... 7 (Option) on the ADC Live-Update box... 9 Configuration Uninstallation procedure Operation Notes Start Up File Masks Notification Agent Settings Troubleshooting Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 3 of 16

4 Integrated system Overview Integrated system Overview About the ADC Proxy Service The ADC Proxy Service was developed to integrate the ADC automation and a traffic system (e.g. Broadcast Master) via the BXF 2008 protocol without the Centergy system. This Web-service is implemented with the same API as the Centergy LPO from the ADC side (i.e. the same interface) and a file-based interface from the Traffic System side. Basic Workflow The following diagram depicts the basic workflow of the integrated solution, which is a simple transfer of data from one side (ADC) to another (Traffic system) and vice versa. Automation System Input Folder Traffic system ADC Proxy Service SOAP ADC Live-Update Automation System Output Folder Deployment details The ADC Proxy Service is hosted on the Microsoft IIS. If the IIS is not present on the target machine, the ADCProxyService Installer installs it automatically. This requires customer agreement of where to install the IIS: on the file-server or on the ADC Live- Update box. The security concern is that Port 80 will be opened on this machine. The recommended installation box is ADC File Server. Service Location The ADC Proxy Service is an ASP 2.0 web-application, so once installed - it can be seen in the Internet Information Services (IIS) Manager (Control panel > Administrative Tools), see the attached screenshot. Physically its files are located in the C:\inetpub\wwwroot\ADCProxyService directory. The version number can be found in the Properties of the ADCProxyService.dll Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 4 of 16

5 Integrated system Overview Its error log is located in the folder C:\temp\ADCProxyService Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 5 of 16

6 Pre-installation Requirements The following are pre-installation requirements for the ADC Proxy Service: The supported OS: Windows 7, Windows Server 2008 R2. Run the installer application under the windows account with administrative privileges. Execute the installer application from the local folder, not from the network share. (Option) on the ADC File Server When the web application is deployed on the file-server all exchange folders are local and there should not be a problem accessing them by the ADC Proxy Web Service. 1. Set up the Input and Output folders. These can be local input & output folders on the computer or network share locations of input & output folders-. Example valid scenarios: The Input and Output folders are both on the local machine The Input and Output folders are both on network share locations The Input folders are on the Local machine and the Output folders are on the network share location The Input folders are on the Network Share location and the Output folders are on the local machine With a network share manually configure the appropriate user rights. When the Input and Output folder are created with default permissions for the Operating System, typically users System and Administrators have the full access, Authenticated Users can modify, read & execute, list folder contents, read, write, and normal Users can read & execute, list folder contents, read. 2. Run the ADC Proxy Service installer: 3. Specify the Automation System Input Folder and Automation System Output Folder (the traffic system will need access to them): 2014 Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 6 of 16

7 The Install / Repair button is grayed until the Inbox and Outbox folders are specified. They can be local folders or network shares. Automation System Input Folder: Enter or browse to ( button) the specified Input Folder (e.g. C:\ADC\LU\Media or \\ADC\LU\Media). This field can point to a local folder on the computer or to a network share; with a network share manually configure the appropriate user rights. Automation System Output Folder: Enter or browse to ( button) the specified Output Folder (e.g. C:\ADC\LU\Change or \\ADC\LU\Change). This field can point to a local folder on the computer or to a network share; with a network share manually configure the appropriate user rights. 4. Press Install/Repair button. During the install procedure the window might be unresponsive because of time consuming operations, the current status is displayed in the status bar: Installing required MS IIS components, Deploying ADC Proxy Service Web Application, etc. 5. The installation is finished when the status message ADC Proxy Service installation is Done is displayed. Configuration Configure the Live-Update for BXF exchange when the ADC Proxy Service is installed on the File Server. The following procedures are performed within the ADC Live-Update UI; it is likely this is on a different machine than the File Server. BXF Configuration 1. Select the icon ( ) located in the upper left corner of the display to access the main menu Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 7 of 16

8 2. From the main menu select Configuration > BXF Configuration. The following dialog is displayed: 3. Configure the following parameters as directed. End Point will look like on the screenshot, but replace the fileserver parameter with the DNS name or IP Address of the ADC file server box: Error! Hyperlink reference not valid. The password for connecting the ADC Live-Update to this proxy is set by the Security-KeyAutomation config-key. It can be any sequence of characters, The default value is harris. Recommended because since file system access will be attempted, set the Poll Rate to a not too frequent setting. The recommended value is 5 seconds. 4. When finished Click OK. Playlist Configuration 1. Select the Harris icon ( ) located in the upper left corner of the display to access the main menu. From the main menu select Configuration > Playlist Configuration. The following dialog is displayed: 2014 Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 8 of 16

9 2. Ensure the 'Enable BXF Playlist Notifications' option is CHECKED, so the Traffic will receive the BXF "Playlist" messages from the ADC Live-Update. 3. When finished click OK. (Option) on the ADC Live-Update box When the ADC Proxy is deployed on the ADC Live-Update box, the ADC Proxy Webservice will connect to the network shares (Automation System Input Folder and Automation System Output Folder). This introduces a layer of complexity. For this scenario use the following installation procedure. 1. Set up the Input and Output folders. Typically this will be network share folders on a file server with a network share manually configure the appropriate user rights. When the Input and Output folder are created with default permissions for the Operating System, typically users System and Administrators have the full access, Authenticated Users can modify, read & execute, list folder contents, read, write, and normal Users can read & execute, list folder contents, read. 2. Run the ADC Proxy Services installer 3. Specify the Automation System Input Folder and Automation System Output Folder (the Traffic system daemon will need access to them) Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 9 of 16

10 Configuration The Install / Repair button is grayed until the Inbox and Outbox folders are specified. They can be local folders or network shares. Automation System Input Folder: Enter or browse to ( button) the specified Input Folder (e.g. \\ADC\LU\Media). With a network share manually configure the appropriate user rights. Automation System Output Folder: Enter or browse to ( button) the specified Input Folder (e.g. \\ADC\LU\Change). With a network share manually configure the appropriate user rights. 4. Press Install/Repair button and wait until the installation is finished. Use this procedure to configure the Live-Update application for BXF exchange when the ADC Proxy Service is installed on the ADC Live-Update machine itself. ADC Live-Update BXF Configuration: 1. Select the Harris icon ( ) located in the upper left corner of the display to access the main menu. 2. From the main menu select Configuration > BXF Configuration. The following dialog is displayed Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 10 of 16

11 3. Since the ADC Proxy web service has been installed on the same machine as ADC Live-Update, specify the End Point containing the URL to point to the localhost: 4. When finished click OK. ADC Live-Update Playlist Configuration 1. Select the Harris icon ( ) located in the upper left corner of the display to access the main menu. 2. From the main menu select Configuration > Playlist Configuration. The following dialog is displayed. 3. Ensure the 'Enable BXF Playlist Notifications' option is CHECKED, so the Traffic will receive the BXF "Playlist" messages from the ADC Live-Update Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 11 of 16

12 ADC Live-Update box, ADC File Server, and ADC Proxy Settings 1. Ensure that both ADC Live-Update box, which hosts the ADC Proxy, and the ADC File Server have the Windows user with the same name and password (for example, Administrator / harris, but non-admin user is OK too) 2. Ensure that the mentioned user has Full Control privilege for the Inbox and Outbox windows folders and it is allowed for Full Control on the corresponding network shares 3. Locate the Web.config file for the ADC Proxy web-service, by default it should be in the folder: C:\inetpub\wwwroot\ADCProxyService. The following credentials specify connection to the network shares. Confirm the settings are properly set; modify only as needed: For key="folderinputaccessuser" the value should be the name of the user which has right to connect to the Automation System Input Folder For key="folderinputaccessdomain" the value should be the domain for this user For key="folderinputaccesspassword" the value should be the password of this user For key="folderoutputaccessuser" the value should be the name of the user which has right to connect to the Automation System Output Folder key="folderoutputaccessdomain" the value should be the domain for this user key="folderoutputaccesspassword" the value should be the password of this user 2014 Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 12 of 16

13 Uninstallation procedure During the uninstallation procedure the MS IIS will be restarted (all sites hosted in it will unresponsive for short period of time). The ADC Proxy web-service will be removed from the web server. 1. Run the installer: 2. Press Remove button 3. During the removal procedure the window might be unresponsive because of time consuming operations, the current status is displayed in the status bar: Removing ADC Proxy Service Web Application, etc. 4. The installation is finished when the status is ADC Proxy Service removal is Done Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 13 of 16

14 Operation Notes Operation Notes Start Up The ADC Proxy Service starts automatically when the IIS is started. To Access the ADC Proxy Service Web-application The ADC Proxy Service web-application can be accessed by copying its endpoint URL to the address bar of the web browser. The window should look similar to this. File Masks The ADC Proxy Service expects xml-files in the Automation System Input Folder with the file-mask: <AppRunNumber><TransactionNumber>_<MessageType>_<Guid>.bxf. This is required to determine the message type and the messages order. The AppRunNumber and TransactionNumber are the integer values specific for the Broadcast Master, so in the common case the concatenation of these values can be a string representation of the increasing integer value. The ADC Proxy Service outputs xml-files in the Automation System Output Folder with the file mask: <MessageType>_<guid>.bxf Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 14 of 16

15 Operation Notes Notification Agent Settings ADC Notification Agent can be integrated into a system running ADC Live-Update, ADC Proxy Service and a traffic system, such as Broadcast Master (BCM). In this scenario it is important that the Input and Output folders set up with ADC Proxy Service be specified in the Web.Config files of ADC Live-Update and ADC Notification Agent machines, and the config file of the traffic system. The following folder path statements are recommended and should appear in the Web.Config file from C:\inetpub\wwwroot\ADCProxyService on both the ADC Live-Update (LU) and ADC Notification Agent (NA) machines: LU: C:\ADC\LU\Media (input) C:\ADC\LU\Change NA (ADC File SVR): C:\ADC\NA\MediaIn (output) (input) C:\ADC\NA\ChangeOut (output) Designate folder path statements required by the traffic system for input and output folders in the appropriate config file for the traffic system. Example: BroadcastMaster Adapter Daemon folder path statements are: C:\BCM\BxfToDAS (Input Folder: It contains items that are generated outside of BCM and are coming IN to the BCM target through the Daemon.) C:\BCM\BxfFromDAS (Output Folder: It contains items that are generated by BCM and are going OUT from the BCM source to the Daemon by means of the DAS and InterOp services.) Example: Basic Workflow The following is an example basic workflow of a system comprising: ADC Notification Agent, ADC Live-Update, ADC Proxy Service, and a traffic system. It is the traffic system s responsibility to transfer files between the watch folders and the traffic system. The method employed (manual, daemon, etc.) is up to the traffic system Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 15 of 16

16 Operation Notes Example: BroadcastMaster (BCM) traffic Workflow The following illustrates a BCM-specific scenario where the custom BCM Adapter Daemon is required to access input and output watch folders. Troubleshooting Issue The ADC Proxy Service is unable to read any message from the input folder because the file name dies not match the file mask: it contains the '-' characters instead of '_'. Resolution Replace these characters on the ADC Live-Update box to allow the ADC Proxy Service to read the Playlist message Imagine Communications Corp. Proprietary and Confidential 8-April-2014 Page 16 of 16