Software Requirement

• JDK 17

Following page provide the detailed to setup Java 17 on linux

https://wiki.rdkcentral.com/display/ASP/Automatics+Orchestration+Setup#AutomaticsOrchestrationSetup-JDK17 

• Tomcat 9.0.XX or above

Following page provide the detailed steps to setup Tomcat 9 version on linux

https://wiki.rdkcentral.com/display/ASP/Automatics+Orchestration+Setup#AutomaticsOrchestrationSetup-Tomcat9.0.XX

• Maven 3

Following page provide the detailed steps to setup maven on linux

https://wiki.rdkcentral.com/display/ASP/Automatics+Orchestration+Setup#AutomaticsOrchestrationSetup-Maven3

Setup

• Clone AutomaticsProps project from the repository (rdk/tools/automatics/automatics-props) with branch (“rdk-next”).
• Execute “mvn clean install”, and war file will be generated at target directory.
• Copy automaticsProps.war file to apache-tomcat/webapps directory and rename it to AutomaticsProps.war.
• Create a directory named “backup_file” in apache-tomcat home folder. Create sub directory automatics and place the sample “automatics.properties” and create sub directory  device and place "device_config.json" file.  When ever user edits automatics properties or device_config.json, a backup file will be generated inside this directory.
• Create a directory “automatics” inside apache-tomcat/webapps.
• Copy “automatics.properties”, "device_config.json", “config.properties” and "user_management.properties" from automatics-props\src to tomcat/webapps/automatics folder.
• Configure user credentials in user_management.properties file. The password should MD 5 Hashed format. The format is mentioned below:
  If the username and password is john and Winner@123, then it should be mentioned as john=b931cd522a614e767bcc48200819c520. Here, john is the username followed by equal sign then the MD5 encrypted password. MD5 encrypted value of Winner@123 is b931cd522a614e767bcc48200819c520. Similarly we configure multiple user credentials in user_management.properties file.
• Configure “config.properties” with base 64 encrypted passcode with login id and password separated by colon format. 
  example: admin:automatics when we encrypt it, the value will be YWRtaW46YXV0b21hdGljcw==
  It is used to authenticate automatics properties using automatics.properties.passcode. When a test is triggered from automatics orchestration, automatics core tries to communicates with automatics properties to get the data of automatics properties and device properties file. In order to communicate, automatics core authenticates itself with automatics properties using this password.
•  Start the server using command ./startup.sh.
• The base URL for Automatics Properties application will be {protocol}//{host:port}/AutomaticsProps/automatics/props. Using this URL user can login and configure the properties for “automatics.properties” and "device_config.json" files.

Changes needed for Existing Community Members for migrating to Version 1.5.0 - Support for multiple user login in Automatics Properties

• Copy "user_management.properties" from automatics-props\src to tomcat/webapps/automatics folder.
• Configure user credentials in user_management.properties file. The password should MD 5 Hashed format. The format is mentioned below:
  If the username and password is john and Winner@123, then it should be mentioned as john=b931cd522a614e767bcc48200819c520. Here, john is the username followed by equal sign then the MD5 encrypted password. MD5 encrypted value of Winner@123 is b931cd522a614e767bcc48200819c520. Similarly we configure multiple user credentials in user_management.properties file.
• Remove the existing user credential from config.properties file and enter it in user_managerment.properties file. Follow the same approach by using MD 5 Hashed format just like above example.