Articles in this section

Part 2: Deploying CMS Enterprise Server and Companion Servers

Carlo
  • Updated
Follow

This article applies to the following ScreenBeam products:

CMSv2_with_circle_and_name.png

 

Sections in this document:

Section 2.1: CMS Server
    Section 2.1.1: System Requirements
    Section 2.1.2: Install ScreenBeam CMS Enterprise
    Section 2.1.3: Check CMS Service Status
    Section 2.1.4: Uninstall ScreenBeam CMS
Section 2.2: DNS Server and DHCP Server
Section 2.3: HTTP Server
    Section 2.3.1: What Is The Web Server For?
    Section 2.3.2: Install IIS Web Server
    Section 2.3.3: Setup Directory For ScreenBeam Files
    Section 2.3.4: Test IIS Web Server

 

2.1 CMS Server

ScreenBeam CMS Enterprise can be deployed directly on an X86 Windows device.

 

2.1.1 System Requirements

Designate an x86-based Windows device to host the CMS server. The device that hosts the CMS server should meet the following requirements:

Minimum Requirements

  • Windows 10 (64-bit) Enterprise build 17763 or higher or Windows Server 2019 build 17763 or higher
  • 2 Core I5 2 GHz or higher
  • 8 GB Memory
  • 30 GB available Hard Disk Space
  • Network connectivity

Recommended Requirements

  • Windows Server 2019 build 17763 or higher
  • 4 Core Xeon 2 GHz or higher
  • 16 GB Memory or higher
  • 50 GB available Hard Disk Space
  • Network connectivity

This device is to be configured based on the number of receivers deployed.

 

Ensure the following ports are opened on the PC hosting ScreenBeam CMS:

  • CMS communication port: TCP 7237 (or the port specified during CMS installation), used to communicate with the ScreenBeam receivers.
  • Receiver log upload port: TCP 7238 (or the port specified during CMS installation), used for uploading receiver logs to the CMS server.
  • CMS WebApp port: TCP 8888 (or the port specified during CMS installation), used for accessing CMS via a web browser.
  • CMS Hub port: TCP 5001 (or the port specified during CMS installation), used for communication between web app and the CMS server.
  • CMS Identity Server port: TCP 8890 (or the port specified during CMS installation), used for communication between the Identity server and CMS server.
  • Service Platform WebApp port: TCP 8889 (or the port specified during CMS installation),
    used for accessing Service Platform via a web browser.
  • Redis port: TCP 6388 (or the port specified during CMS installation), used for
    communication between the Redis server and the Service Platform.
  • SQL server port: TCP 1433 (or the port specified during CMS installation), used for
    communication between SQL server and the CMS server.

Ensure that network policies allow TCP traffic on the CMS ports across the network routers and if necessary port forwarded accordingly.

spcmse_part2.1.1_1.png

In addition, https://upgrade.screenbeam.com needs to be whitelisted to download apps from
the ScreenBeam App Library.

Note the IP address, hostname or fully qualified domain name belonging to the device hosting CMS server.

 

2.1.2 Install ScreenBeam CMS Enterprise

ScreenBeam CMS Enterprise Installer version is a replacement to CMS Enterprise Docker 4.0 or CMS V2.x. Therefore, if any of these versions are installed on the machine, be sure to remove it first.  If Docker and Hyper-V are not used by other programs, uninstall them, as well.

To install ScreenBeam CMS Enterprise, follow this procedure:

  1. Go to https://www.screenbeam.com/support, and download the latest version of ScreenBeam CMS Enterprise software.
     
  2. Unzip the downloaded software package, and run the ScreenBeam CMS installer.
    Note: A user with Administrator privilege is required to run the ScreenBeam CMS installer.
    spcms_part2.1.2_1.jpg
     
  3. The Microsoft Defender Smartscreen window may appear. Click More Info and then click Run Anyway to continue.
    2.1.2_3a.png  2.1.2_3b.png
     
  4. During the installation, the software license agreement appears first. Read the agreement carefully. Select I accept the agreement and click Next to continue.
    2.1.2_4.png
     
  5. The Directory Service Selection window appears.
    • ScreenBeam CMS User Management. ScreenBeam CMS users will be managed
      locally with the Identity server.
    • Azure Active Directory Service (AAD) (Beta). ScreenBeam CMS users will be
      managed using Azure Active Directory
    spcms_part2.1.2_5.jpg
     
  6. (Optional) If you choose Azure Directory Service (AAD) (Beta), you need to specify the following parameters on the Azure Active Directory Configuration page that appears:
    • Delegation: CMS needs a signed-in user in order to request data from AAD.
    • Stand-Alone/Daemon: CMS can request permitted data without a signed-in user.
    • Azure Active Directory (Tenant) ID: The ID of the tenant used to manage ScreenBeam CMS.
    • Azure Active Directory Application (client) ID: It is the ID of the registered app for ScreenBeam CMS.
    • Azure Active Directory Group ID: It is the ID of the Security group that is assigned to manage ScreenBeam CMS.
    • Azure Active Directory Client Secret: It is the secret of the registered application for ScreenBeam CMS.
       
    Note: For detailed setups about Azure AD and ScreenBeam CMS, refer to Appendix I. spcms_part2.1.2_6.jpg
     
  7. The SQL Server Database Setup window appears. Users are allowed to use an existing SQL server or install a new SQL Server instance.
    It is highly recommended to install an SQL Server instance on the same machine. As an existing SQL server on a separate machine can result in network latency, which will slow down CMS functions.
    2.1.2_5a.png

    If you choose to use an existing SQL server, you must set up the following parameters: SQL server host, SQL server port, username and password.
    2.1.2_5b.png

    If you choose to install a new SQL Server instance on your system, you are required to define an SQL Server port and a password. Microsoft SQL 2017 Express will be installed.
    2.1.2_5c.png
    After the parameters are defined, click Next to continue.

  8. The ScreenBeam SPCMS Web App configuration window appears.
    • Service Platform WebApp port: This port is for accessing the Service Platform via a
      web browser. The default port is 8889. If this port is already in use, specify a new one.
    • Redis port: This port is for communication between the Redis server and the Service
      Platform. The default port is 6388. If this port is already in use, specify a new one.

      Ensure that any custom port numbers are noted for future reference.
      spcms_part2.1.2_8.jpg
      After the parameters are define, click Next to continue.

  9. The ScreenBeam CMSv4 port configuration window appears.

    • CMS WebApp port: This port is for accessing the CMS server via a web browser. The default port is 8888. If this port is already in use, specify a new one.
    • CMS Hub port: This port is for communication between the web app and the CMS server. The default port is 5001. If this port is already in use, specify a new one.
    • CMS receiver port: This port is for communication between receivers and the CMS server. The default port is 7237. If this port is already in use, specify a new one. Valid port ranges from 1024 to 65535, provided these ports are not used by other devices on the network.
    • CMS receiver log port: This port is for uploading receiver logs to the CMS server. The default port is 7238. If this port is already in use, specify a new one.

      Note: Valid port ranges are from 1024 to 65535, provided these ports are not used by other devices on the network.
      Ensure that any custom port numbers are noted for future reference. spcms_part2.1.2_9.jpg
      After the parameters are defined, click Next to continue.

  10. The Ready to Install window appears. Click Install to continue.
    The remaining installation process is automated. It may take some time to complete the installation.
    2.1.2_7a.png
    Enable IIS features.
    2.1.2_7b.png
    Install ScreenBeam CMS Enterprise.
    2.1.2_7c.png
    Install SQL server, if you choose to install a new SQL server instance.
    2.1.2_7d.png
    Note: Don’t click in the Windows Powershell window during the installation. If you have done it, the installation may pause. In this case, you can press Enter to resume.

    A message box that shows how to access the CMS WebApp appears. The CMS WebApp can be accessed via https://<your_server_ip>:WebApp_port
    2.1.2_7e.png

  11. ScreenBeam CMS Enterprise is successfully installed when the installation completion window appears. Click Finish.
    2.1.2_8.png

 

2.1.3 Check CMS Service Status

After the CMS is installed, you may want to check if the CMS services are running or not.
To check the CMS service status, follow this procedure:

  1. Open Internet Information Services (IIS) Manager on your server.
    2.1.3_1.png

  2. On the Connections pane, navigate to Sites, and check the status of these two sites: CMSHubAppSite, CMSIdentityServerAppSite, CMSSpcmsAppSite and CMSWebAppSite.
    • When these sites are started, CMS is running.
    • When one of these sites are stopped, CMS is out of service
    spcms_part2.1.3_2.jpg

  3. On the Connections pane, select Application Pools, and check the status of the following pools:  ScreenBeamCMSHubPool, ScreenBeamCMSIdentityServerPool, ScreenBeamCMSSpcmsAppPool, and ScreenBeamCMSWebAppPool.
    • When these pools are started, the CMS is running.
    • When one of these sites is stopped, the CMS is out of service.
    spcms_part2.1.3_3.jpg

2.1.4 Uninstall ScreenBeam CMS

Note: Ensure that all receivers are switched to the new CMS server before starting the uninstallation process. CMS data backup and restoration are currently not supported.

 

To uninstall ScreenBeam CMS, follow this procedure:

  1. Go to Control Panel > All Control Panel Items > Programs and Features, select ScreenBeam CMS Enterprise version 4.1.x.x and click Uninstall.
    2.1.4_1.png
  2. The ScreenBeam CMS Enterprise Uninstall message box appears. Click Yes to uninstall ScreenBeam CMS Enterprise.
    2.1.4_2.png

2.2 DNS Server and DHCP Server

A DNS server, while technically optional, is strongly recommended for discovery of ScreenBeam receivers. DNS Discovery allows all ScreenBeam receivers discovered by the CMS server, requiring very little user interaction once the network is configured properly. Additional details on this method can be found in Section 3.2 Provisioning Receivers Using DNS Discovery Method.

 

2.3 HTTP Server

2.3.1 What Is The Web Server For?

An HTTP server should be deployed in parallel with CMS Enterprise to host the firmware files and other miscellaneous files used for upgrading or customizing ScreenBeam Receivers.

The HTTP server should be commercial-grade, capable of handling large number of simultaneous connections and bandwidth as policy and network capabilities shall permit.

Note: While the same CMS host can technically be used to host a web server, this may result in unpredictable CMS and/or HTTP server behavior. Use of a different server is highly recommended to ensure optimal performance.

 

2.3.2 Install IIS Web Server

1.

On the Windows PC which you will use as the IIS web server, open Control Panel, go to Programs, then Programs and Features, then choose Turn Windows Features on or off from the menu on the left side of the window.  The Feature we will add is called Internet Information Services.  Check the box next to Internet Information Services and press Ok to begin the installation.

IIS_00a.png

 

2.

Once the installation is complete, open the Start menu and type IIS Manager, then click on the Internet Information Services (IIS) Manager.

IIS_01.png

3.

In the IIS manager click on MIME Types.

IIS_08.png

4.

From the Actions pane on the right side of the screen select Add… In the window that opens enter img as the File name extension and application/octet-stream for the MIME type.  Note that this procedure only needs to be done one time, as part of the initial configuration of the HTTP server.

IIS_00b.png

 

2.3.3 Setup Directory For ScreenBeam Files

Now that your IIS web server is installed it’s time to create a directory on the server where you can put the files used for ScreenBeam receiver configuration.

1.

On the IIS web server PC, launch Windows Explorer and navigate to C:\inetpub\wwwroot.  This is the default root directory setup by IIS.

IIS_02.png

 

2.

Create a new folder in this directory called screenbeam.  To do this, right-click an empty space in the explorer window and select New à Folder and name it “screenbeam”.

IIS_03.png

3.

Copy your firmware and background image files to this directory. Firmware image files are typically named img 

Note: For later test purposes please copy an image file to this directory and name it background.jpg.  The image resolution should be no larger than 1920x1080, and the file size should be less than 2MB.

IIS_04.png

 

2.3.4 Test IIS Web Server

Let’s make sure everything is working properly and that your IIS web server is ready to host files for ScreenBeam receiver configuration. You will temporarily need another laptop/PC to use to test your server.

1.

Connect a laptop/PC to the network you will be using for your ScreenBeam receivers.

TestPC_IISSetup.png

 

2.

Open a browser window and for the URL, enter the IP address of the HTTP server then /screenbeam/install.img

For instance, if your web server IP address is 192.168.1.100, you would enter http://192.168.1.100/screenbeam/install.img as the URL.

IIS_06.png

3.

 If working correctly, you will be prompted to Open or Save the install.img file.  This means the web server is working properly.

IIS_07.png

 

 

     

 

Comments

0 comments

Article is closed for comments.