Introduction

Automatics system reads configuration data required for test execution from Automatics Props application. It is configuration management tool for Automatics system. User can configure automatics and partner specific config data and device model specific config data using this tool. The data from Automatics Properties will be consumed by  Automatics Core/Partner Implementation/Rest Implementation Projects for executing the test cases. Partner can also configure their environment specific config data to it.

There are two types of configuration data in Automatics Props. The templates of configuration files are available at source rdk/tools/automatics/automatics-props.

• Automatics properties - Java properties file with key value pair.  (automatics.properties)
• Device Props – Json file containing device configuration for each model. (device_config.json)

Following are the properties expected in automatics.properties file. In addition to this, partner can configure their data also.

Login Page

By default Automatics Properties page will be displayed after login. User can choose the file option in login page to navigate between Automatics Properties and Device Properties. Following are the default properties for automatics.properties file.

Edit Automatics Properties

To edit, the properties, click on 'UNLOCKED' link on left top side of page. This will allow only one person to update the document at a time. We will get pop message, "Successfully Locked".

Now user can edit the values and finally click on 'Submit' button to save the values. On submit, the application will save the values and logout and display message "Updated Successfully".

Edit Device Properties

To edit, the device properties, click on 'UNLOCKED' link on left top side of page. This will allow only one person to update the document at a time. We will get pop message, "Successfully Locked". Now user can edit the values and finally click on 'Submit' button to save the values. On submit, the application will save the values and logout and display message "Updated Successfully".

Automatics properties file

• Launch {protocol}//{host:port}/AutomaticsProps/automatics/props.
• Login page will be displayed. Enter the credentials, choose 'Automatics Properties' for File option and click login.
• User will be redirected to automatics properties page where it contains all the Properties which can be changed based on the requirements.
• Automatics Core/Partner Implementation/Rest Implementation Projects will read configuration values from this file.
• To edit the values, please click on “unlocked” button. Update the values and click on submit. This will save the configuration values.

Device properties file

• Launch {protocol}//{host:port}/AutomaticsProps/automatics/props.
• Login page will be displayed. Enter the credentials, choose 'Device Configuration JSON' for File option and click login.
• User will be redirected to device configuration page where it contains all device configurations for each model.
• Automatics Core/Partner Implementation/Rest Implementation Projects will read configuration values from this file.
• To edit the values, please click on “unlocked” button. Update the values and click on submit. This will save the configuration values.

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" and “config.properties” from automatics-props\src to tomcat/webapps/automatics folder. 
• Configure“config.properties” with username and password required for Automatics Properties UI login. These credentials has to be configured under 'user' and 'pwd' keys.
• 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.