Sections in this document:

Section 4.1: Login
Section 4.2: Basic Functions
Section 4.3: CMS User
    Section 4.3.1: Add a New User
    Section 4.3.2: Re-assign Roles
    Section 4.3.3: Edit User Info and/or Change User Password
    Section 4.3.4: Delete a User
Section 4.4: Receivers
    Section 4.4.1: Add a New Site
    Section 4.4.2: Rename a Site
    Section 4.4.3: Delete a Site
    Section 4.4.4: Add Receivers to Site
    Section 4.4.5: Release Receivers from Site
    Section 4.4.6: Add Users to Site
    Section 4.4.7: Release Users from Site
    Section 4.4.8: Configure Receiver
    Section 4.4.9: Update Receiver Firmware
    Section 4.4.10: Connect Receiver to RADIUS Authenticated AP/LAN
    Section 4.4.11: Switch CMS Server for Receivers
Section 4.5: Scheduler
    Section 4.5.1: Schedule a Task
    Section 4.5.2: Add Receiver to Task
    Section 4.5.3: Remove Receiver from Task
    Section 4.5.4: Edit a Task
    Section 4.5.5: Delete a Task
Section 4.6: Logs
    Section 4.6.1: Upload Receiver Log
    Section 4.6.2: View Receiver Logs
    Section 4.6.3: Export Receiver Logs
    Section 4.6.4: View Scheduler Log
    Section 4.6.5: Export Scheduler Log

 

After ScreenBeam CMS Enterprise server and companion servers are deployed and ScreenBeam receivers are provisioned, the ScreenBeam receivers can then be managed using CMS. The capabilities of CMS Enterprise are shown below.

Note: Verify that Docker Desktop is running before CMS server is accessed.

 

4.1 Login

ScreenBeam CMS Enterprise uses a multi-user web-based user interface, meaning that multiple users can use CMS simultaneously to monitor and manage ScreenBeam receivers. The CMS web interface can be accessed using the hostname or IP at a port of 8888 (or the port of choice during CMS configuration), e.g. https://<CMS_ Address>:8888.

The Default Administrator role user name and password are Administrator and Screenbeam, respectively. All other user logins will use the credentials provided by the Administrator.



It is strongly recommended to change the Administrator password after initial login.

The browser may give an error stating “The connection or site is not secure or private.” Manually accept the connection as follows:

• Chrome browser: click Advanced, and then click Proceed.
• Edge/IE browser: click Details, and then Go on to the webpage (not recommended).
• Firefox browser: click Advanced, then click Add Exception, then click Confirm Security Exception.

To avoid the certificate warning page, follow this procedure:

1. Create a forward lookup zone on your DNS, and name it "sbcmsweb.com".
   
    
2. Add an A record to this zone, eg cms.sbcmsweb.com, and point it to the IP address of the CMS machine.
3. Ensure the PC running the browser can resolve the CMS IP address.
4. Type the URL eg https://cms.sbcmsweb.com:8888

 

4.2 Basic Functions

The primary functional areas available in a ScreenBeam CMS session are:

• Dashboard – provides a general overview and statistics of the CMS.
• Receivers – provides information on all receivers managed by a CMS user through the Sites pane, Receivers pane and Users pane.
  • Site pane – displays the sites where ScreenBeam receivers are located.
  • Receivers pane – displays receivers’ basic information, allows users to configure receivers, update receiver firmware, reboot/reset receivers
  • Users pane – allows CMS SysAdmin to view users assigned to site, and re-assign roles or delete roles.
• Scheduler – creates scheduled tasks for receivers.
• Receiver Log – gives access to receiver logs (sysadmin only).
• Scheduler Log – gives access to scheduler logs (sysadmin only).
• USB Provisioning – allows receiver configuration using a USB flash drive.
• Member Management – allows the CMS system administrator to add, delete, and edit users and roles.

These items will be discussed in additional detail below.

 

4.3 CMS User

As access to different CMS functions is dependent on the type of CMS user, CMS user management should first be implemented before deployment.

 

4.3.1 Add a New User

To add a new user of any type:

1. Go to the Member Management page by clicking Member Management on the left pane.
   
    
2. Click on Add New Member, and the Add New Member window will appear.
   
    
3. Fill in the required information, and click Execute.
   
    

 

4.3.2 Re-assign Roles

By default, any newly added user is a CMS user. The user’s role can be changed by a CMS System Administrator by following the procedure below:

1. Go to the Member Management page by clicking Member Management on the left pane.
   
    
2. Select CMS SysAdmin or CMS User from the Role box of the user’s entry.
   Note: Existing roles that the user is bound to may need to be cleared first.
   
    

There are two kinds of standard CMS users: SB Admin and SB Monitor. These roles can be assigned to CMS users when adding users to sites as follows:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Right-click a site on the Sites pane and select Add User from the short-cut menu.
   
    
3. The Add Users to Site xxx window appears.
   
    
4. Select a user from the All Users box, and then click Add to add the selected user to the Admins box or the Monitors box. If the user is added to the Admins box, that user belongs to administrators of the site; similarly, if the user is added to the Monitors box, that user belongs to monitors of the site.
   
   
    

Different roles can be assigned to a CMS user in the Users pane as follows:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Go to the Users pane by clicking on the Users tab.
   
    
3. Select a site on the Sites pane to display the users that manage this site.
   
    
4. Select CMS Admin or CMS Monitor from the Role box of the user’s entry.
   
    

 

4.3.3 Edit User Info and/or Change User Password

To edit a user’s info and/or change a user’s password, follow this procedure:

1. Go to the Member Management page by clicking Member Management on the left pane.
   
    
2. Click the Edit button (the yellow pen) in the Action column of a user entry.
   
    
3. The Edit User window appears. Edit user information such as First name, Last name, and E-mail address.
   
    
4. Check the Change Password box. Password options appear. Enter a new password and retype it to confirm.
   
    
5. Click the Execute button to confirm.

 

4.3.4 Delete a User

To delete a user, follow this procedure:

1. Go to the Member Management page by clicking Member Management on the left pane.
   
    
2. Click the Delete button (the red trash bin) in the Action column of a user entry to delete the corresponding user.
   
    
3. The Delete user box appears. Click Execute to delete the user.
   
    

 

4.4 Receivers

A CMS system administrator can add new sites, add receivers to sites, add users to sites, etc.

 

4.4.1 Add a New Site

To add a new site, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Click the plus sign on the bottom right corner of the Sites pane.
   
    
3. The Add Site window appears. Select a Parent site and enter a name for the new site in the Site Name box.
   
    
4. (Optional) Click Add User to open the Add Users to Site xxx window. Select users from the All Users box, and then click Add to add the selected users to the Admins box or the Monitors box.
   
   
    
5. Click Execute to create a new site.
   
    

 

4.4.2 Rename a Site

To rename a site, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Go to the Site pane, right-click the site that you want to rename, and select Rename from the shortcut menu.
   
    
3. Type a new name and press Enter to confirm.

 

4.4.3 Delete a Site

To delete a site, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Go to the Site pane, right-click the site that you want to delete, and select Delete Site from the shortcut menu.
   
    
3. Click Execute on the Delete Site message box.

 

4.4.4 Add Receivers to Site

To add one or more receivers to a site, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Click the Receivers tab to bring the Receivers pane to front if it is not.
    
3. Click Unassigned on the Sites pane to display the receivers that are not added to any site on the Receivers pane.
   
    
4. Select the receiver(s) to be added on the Receivers pane, right-click the site where the selected receiver(s) are to be added, and select Join Receivers from the short-cut menu.
   
    
5. The selected receiver(s) are added the desired site.
   
    

 

4.4.5 Release Receivers from Site

To release one or more receivers from a site, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Click the Receivers tab to bring the Receivers pane to front if it is not.
    
3. Select the site to display the receivers that are added to the site.
   
    
4. Select the receivers that you want to release, right-click the site name in the Site pane, and select Release Receivers from the shortcut menu.
   
    

 

4.4.6 Add Users to Site

To add one or more users to a site, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Right-click the site where you are going to add users, and select Add Users from the short-cut menu.
   
    
3. The Add Users to Site xxx window appears. Select one or more users from the All Users box, and then click Add to add the selected users to the Admins box or the Monitors box.
   Note: The figure below shows adding Admin2 to Site C as Monitor.
   
    
4. Click Execute to confirm.
   
    

 

4.4.7 Release Users from Site

To release one or more users from a site, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Click the Users tab to display the Users page.
    
3. Select the site where you want to release users in the Site pane. Users that are added to this site will be displayed in the Users page.
    
4. Click the Delete button (the red trash bin) in the Action column of a user entry to release the corresponding user from the site.
   
    

 

4.4.8 Configure Receiver

To configure one or more receivers, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Select one or more receivers on the Receivers page, and then select Actions > Settings.
   
    
3. The Settings or Multiple Receiver Settings window appears. Configure the receiver settings on the window and click Execute.
   Note: Refer to the receiver’s user manual for details about setting up a receiver.
   
    

 

4.4.9 Update Receiver Firmware

To update firmware for one or more receivers, follow this procedure:

1. Ensure the receiver’s firmware update image resides on the HTTP server.
2. Go to the Receivers page by clicking Receivers on the left pane.
   
    
3. Select one or more receivers on the Receivers page, and then select Actions > Update Firmware.
   
    
4. The Update Firmware window appears. Select an Update Type, enter the firmware file URL in the Enter the firmware file URL box, and click Execute.
   Note: Click the Test URL button to check the validity of the URL if desired.
   
    

 

4.4.10 Connect Receiver to RADIUS Authenticated AP/LAN

ScreenBeam receivers can connect to a RADIUS authenticated access point (AP) or local area network (LAN) using IEEE 802.1x protocol.

To connect a ScreenBeam receiver to a RADIUS authenticated access point, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Select the receiver to connect to a RADIUS authenticated AP/LAN on the Receivers page, and then select Actions > Settings.
   
    
3. The Settings window appears. Navigate to the Network Settings page.
   
    
4. To connect to a RADIUS authenticated LAN, go to Network Interface Settings > Ethernet Interface, and select PEAP-MSCHAPV2 or EAP-TLS in the Authentication box, enter Username and Password for authentication.
   To connect to a RADIUS authenticated AP, go to Network Interface Settings > Wireless Interface, and select PEAP-MSCHAPV2 or EAP-TLS in the Security Type box, enter network name of the AP, Username and Password for authentication.
   • Network Name - It is network name of the AP.
   • User Name - It is RADIUS account User Name.
   • Password - It is RADIUS account password.
   • Validity Period - It displays the effective period of the certificates.
   
    
5. Click Execute to confirm.
    
6. If EAP-TLS is selected, relevant certificates are required for authentication. Ensure these certificates are resided on an HTTP server.
    
7. Select the receiver, and then select Actions > Install Certificate.
   
    
8. The Install Certificate window appears. Select Ethernet or Wireless according to the kind of network the receiver connects to, and enter URLs of the certificates.
   • CA Certificate - It is the root certificate.
   • User Certificate - It is the user certificate.
   • Private Key - It is the user’s private key.
   
    
9. Click Execute to confirm.
    

 

4.4.11 Switch CMS Server for Receivers

If multiple ScreenBeam Central Management System Enterprise servers are deployed, some receivers on the current CMS server may be required to be switched to these additional or replacement servers. ScreenBeam CMS provides a simple server switch function, which can switch receivers to another CMS easily and quickly.

To assign one or more receivers to another server, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Select the online receivers to be switched to another CMS server on the Receivers page, and then select Actions > Switch CMS for Receivers.
   
    
3. The Switch CMS for Receivers window appears. Enter the IP address, hostname, or FQDN of the CMS server in the CMS Server IP/Hostname/FQDN box and the communication port of the CMS server in the CMS Communication Port box.
   
    
4. Click Execute to confirm.
    

 

4.5 Scheduler

Scheduler can help administrators automate receiver management, allowing activities such as staggering large firmware updates during off-work hours.

 

4.5.1 Schedule a Task

To schedule a task, follow this procedure:

1. Go to the Scheduler page by clicking Scheduler on the left pane.
   
    
2. Click the Schedule Task button on the Scheduler pane to open the Schedule Task window.
   
    
3. On the General tab, give your task a name in the Name box, and describe your task in the Description box.
   
    
4. On the Actions tab, select an action.
   
    
5. On the Trigger tab, define a start date and select a recurrence.
   • Start Date: It is the date and time when the task is executed.
   • Recurrence:
     • Once - the task will be executed once on the defined start date.
     • Minutes - execution of the task will be repeated every xx minutes (xx refers to the number of minutes you define). (used only for testing)
     • Daily - execution of the task will be repeated every xx days (xx refers to the number of days you define).
     • Weekly - execution of the task will be repeated on the defined week day(s).
     • Monthly - execution of the task will be repeated on the defined date of month.
   • End Date: This is the date and time when execution of the task is stopped.
   
   
    
6. On the Add Receivers tab, read the instructions on how to add receivers to a task.
   
    
7. Click Execute to create a task.

 

4.5.2 Add Receiver to Task

To add receivers to a task, follow this procedure:

1. Go to the Scheduler page by clicking Scheduler on the left pane.
   
    
2. Ensure no task is selected.
    
3. On the Receivers pane, select the receiver(s) that the added task should be assigned to.
   
    
4. On the Scheduler pane, right-click the task to add receivers to, and select Add Receivers from the short-cut menu.
   
    
5. The selected receivers are added to the intended task.
   
    

 

4.5.3 Remove Receiver from Task

To remove receivers from a task, follow this procedure:

1. Go to the Scheduler page by clicking Scheduler on the left pane.
   
    
2. Select the task where receivers are to be removed.
   
    
3. On the Receivers pane, select the receiver(s) to remove from the task.
   
    
4. On the Scheduler pane, right-click the task, and select Remove Receivers from the short-cut menu.
   
    
5. The selected receivers are removed from the task.
    

 

4.5.4 Edit a Task

Follow the procedure below to edit a task:

1. Go to the Scheduler page by clicking Scheduler on the left pane.
   
    
2. Right-click the entry of a scheduler task that you want to edit, and select Edit Task from the short-cut menu.
   
    
3. Follow the procedure described in Section 4.5.1 Schedule a Task to edit the task.
    

 

4.5.5 Delete a Task

To delete a task, follow this procedure:

1. Go to the Scheduler page by clicking Scheduler on the left pane.
   
    
2. Right-click the entry of a scheduler task to delete, and select Delete Task from the short-cut menu.
   
    
3. Click Execute on the Delete Task message box.
    

 

4.6 Logs

Receiver logs and scheduler logs capture basic events of ScreenBeam receivers to be able to track down problems efficiently. Logs are available to CMS system administrators only.

 

4.6.1 Upload Receiver Log

ScreenBeam receivers will log events automatically, with new event logs replacing the oldest event logs when the log cache is full. Event logs will not, however, be uploaded to CMS by default. The logs can be uploaded to the CMS server manually using the Receiver Log function or automatically using Scheduler.

To upload receiver logs, follow this procedure:

1. Go to the Receivers page by clicking Receivers on the left pane.
   
    
2. Select all receivers, go to Actions → Receiver Log, and select Disable Upload Logs. Click Execute.
   
   
    
3. Select the receiver(s) for log upload to CMS on the Receivers page, and then open Actions → Receiver Log.
   
    
4. The Receiver Log window will then appear. On the Receiver Log window, select Get Logs immediately, and click Execute.
   
    

Alternatively, logs can be uploaded automatically using the Scheduler.

 

As the receiver log upload can sometimes take a few hours, it is recommended to schedule the receiver uploads during non business hours. Once a log uploading task is scheduled and started, it is not able to request receiver log immediately until the task has completed.

 

4.6.2 View Receiver Logs

To view receiver logs, follow this procedure:

1. Log in as a CMS system administrator (CMS SysAdmin).
    
2. Go to the Receiver Log page by clicking Receiver Log on the left pane.
   
    
3. Click a column name to sort events by the respective type.
   
    
4. Select a filter type from the filter menu, and select a time period or input your key word to search.
   • Date & Time - defines a time period to search.
   • Receiver Name - CMS will search the receiver name only.
   • Receiver MAC - CMS will search the receiver MAC only.
   • Firmware Version - CMS will search the receiver’s firmware version only.
   • Event Type - CMS will search the event type only.
   • Event Description - CMS will search the event description only.
   • Source Name - CMS will search the source name only.
   • Source MAC - CMS will search the source MAC only.
   
    
5. To check if there are new logged events that are not displayed in the Receiver Log page, click the Refresh button.
   
    
6. To export receiver logs, click the Export as CSV button.
   
    

 

4.6.3 Export Receiver Logs

To export receiver logs, follow this procedure:

1. Log in as a CMS system administrator (CMS SysAdmin).
    
2. Go to the Receiver Log page by clicking Receiver Log on the left pane.
   
    
3. Click the Refresh button to check if there are new logged events that are not displayed in the Receiver Log page.
   
    
4. Click the Export as CSV button to export receiver logs in CSV format.
   
    

 

4.6.4 View Scheduler Log

ScreenBeam CMS records scheduler logs automatically and displays them in the Scheduler Log page.
To view scheduler logs, follow this procedure:

1. Log in as a CMS system administrator (CMS SysAdmin).
    
2. Go to the Scheduler Log page by clicking Scheduler Log on the left pane.
   
    
3. Click a column name to sort events by the respective type.
   
    
4. Select a filter type from the filter menu, and select a time period or input your key word to search.
   • Task Name - CMS will search the task name only.
   • Date & Time - It is used to define a time period to search.
   
    
5. To check if there are new logged events that are not displayed in the Scheduler Log page, click the Refresh button.
   
    
6. To export scheduler logs, click the Export as CSV button.
   
    

 

4.6.5 Export Scheduler Log

To export scheduler logs, follow this procedure:

1. Log in as a CMS system administrator (CMS SysAdmin).
    
2. Go to the Scheduler Log page by clicking Scheduler Log on the left pane.
   
    
3. Click the Refresh button to check if there are new logged events that are not displayed in the Scheduler Log page.
   
    
4. Click the Export as CSV button to export scheduler logs.
   
    

 

Previous