Device Manager UI is an user interface application to interact with device manager server to manage different devices by fetching the device details, adding devices, adding device groups etc

This document provides the deployment steps for setting up Device Manager UI server and all its dependencies.

For setting up this server the below applications or tools should be available in the server machine:

1. JDK – 17
2. TOMCAT – v9.0.xx
3. MAVEN – v3.8 or above
4. Device Manager 

The below software should be installed and available for running Device Manager UI.

If you already have an existing setup of Automatics you can follow the steps in this page for upgrading the software's Automatics Technology Stack - Upgrade 

Software Requirement

• JDK 17

Please note that even though the recommended version of Orchestration is JDK17, it is reverse compatible with JDK11 also. So code also be compiled with JDK11. Follow Steps below to install Java 17 on CentOS/linux.

• • Update before installing any new program

sudo yum -y update

• • Install Java 17

sudo yum install java-17-openjdk

• • Verify Java is Installed

java -version

Sample output:

• MariaDB 10.11

Follow below steps to install and configure MariaDB on CentOS/linux

• • All the packages need to be up-to-date. Use the following command to update your packages.

    sudo yum update

    Create a new repo file for the latest version.

    vi /etc/yum.repos.d/MariaDB.repo

    Copy and paste the following contents into the /etc/yum.repos.d/mariadb.repo file.

    [mariadb] name = MariaDB baseurl = http://yum.mariadb.org/10.11/centos7-amd64 gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB gpgcheck=1

    To exit and save the Vim file, type :wq and press Enter.

  • Install the Latest Version of MariaDB

Install 10.11 of MariaDB and the most common packages, using the command below.

sudo yum install MariaDB-server galera-4 MariaDB-client MariaDB-shared MariaDB-backup MariaDB-common

• • Start MariaDB

    Start the MariaDB service with this command.

    sudo systemctl start mariadb

    To set MariaDB to start automatically when the VM boots up, use the following command.

    sudo systemctl enable mariadb

    Check the current status of MariaDB using this command.

    sudo systemctl status mariadb

    Check the currently installed MariaDB version with this command.

    sudo mysql -u root -p -V

• Tomcat 9.0.XX

Follow below Steps to setup Tomcat server  on CentOs/linux.

• • Download Tomcat 9 from the Apache Tomcat Archive

wget -c https://downloads.apache.org/tomcat/tomcat-9/v9.0.85/bin/apache-tomcat-9.0.85.tar.gz

• • Extract the Tomcat archive to the directory in which you want to deploy the Automatics Tools

    sudo tar -xvf apache-tomcat-9.0.85.tar.gz -C /opt/automatics/

  • Navigate to the tomcat file path and run ./bin/startup.sh cmd to start the tomcat server.

Sample Output:

Maven – 3

Maven is the tool used for building and managing Device Manager project. Please follow the below links to download and install Maven:

• Download: https://maven.apache.org/download.cgi
• Installation: https://maven.apache.org/install.html

Following page will provide the detailed steps to setup maven.

Automatics Orchestration Setup#Maven3

Device Manager Back End Server

Device Manager Server is REST API based tool to manage different device details , add & edit device details, device groups etc. Device Manager UI is an application for visualizing and perform actions on different functionalities of device manager backend server.

Please refer below link to know more about device manager setup and deployment.

Device Manager Deployment Document

Environment Setup

Following are the steps to be followed to setup Device Manager UI and its dependent software's in a Machine:

Build Device Manager UI .war file

Build the .war file of Device Manager UI  using Maven 3 and JDK 8.

To do this follow the below steps:

• Pull the latest Device Manager UI project from the repository link : https://code.rdkcentral.com/r/admin/repos/rdk/tools/device-manager-ui.
• After completing the pull, go the resources folder in the device manager project, and add DeviceManager URL in application.properties.(device-manager-ui\src\main\resources).

Example:

• Now navigate to the project Home folder and run the command “mvn clean install”.
• This will build DeviceManagerUI.war file of device-manager-ui in the folder “project_home/target”.

Configuring Base URL in Device Manager UI

By default, the URL for logging into the Device Manager UI is {protocol}://{host:port}/DeviceManagerUI/login.html. If you wish to change the base URL of the Device Manager UI (e.g., to {protocol}://{host:port}/DeviceManagerUIDevelopment/login.html), follow these steps:

• In the application.properties file of the Device Manager UI application, set the desired context path under the server.servlet.context-path property. For example, by default, this is set to /DeviceManagerUI. You can change it to /DeviceManagerUIDevelopment.
• In the pom.xml file of the Device Manager UI, set the same value used for the server.servlet.context-path property under the <finalName> tag. By default, this is set to <finalName>DeviceManagerUI</finalName>. You can update it to <finalName>DeviceManagerUIDevelopment</finalName>.

After completing these two steps, build the project using the mvn clean install command to generate the WAR file.

Deploy Device Manager UI application

Device Manager application should be deployed in Tomcat server (ver 8.5 or above). Follow the below steps to deploy the application.

1. Copy DeviceManagerUI.war file from “project_home/target” to “TOMCAT_HOME/webapps” folder.
2. If you need to run the tomcat server in a port other than 8080, please follow the below steps to change the same.
   • Navigate to the folder “TOMCAT_HOME/conf”.
   • Open server.xml and change the connector port in this file from 8080 to an available port of your choice. If another tomcat is running the same machine then change the DEFAULT Tomcat server SHUTDOWN port from 8005 to another available port. If you dont need to a SHUTDOWN port for tomcat then change the default port from 8005 to “-1”.
3. To start Device Manager application go to “TOMCAT_HOME/bin” folder and run sh or startup.bat (if its running on Microsoft windows) script.
4. To verify server logs check “TOMCAT_HOME/logs/catalina.out” file.

• To launch Device Manager application go to the URL : “{protocol}://{host:port}/DeviceManagerUI/login.html“

• For the first time, login with username as "admin" without password.
• on success login user will be navigated to manage devices pages.

Following page will provide more information on device manager ui

Device Manager UI User Manual