Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Configurations in Orchestration

1.User should make the following changes

     1.1 Setting Pagination Limit

 Pagination Limit: User has the freedom to set the pagination limit.

If the user sets the pagination limit to 10, it means that in a single API call, the orchestration side will receive 10 packages. If there are a total of 30 packages and the pagination limit is set to 10, then these packages will be fetched in three requests. This approach is implemented to maintain a constant JSON size and to minimize any potential overhead, ensuring efficient processing.

 user can set pagination limit in both the ways one using UI and other using MySql DB.

Add Configs in System Configuration Page

  1. Launch Automatics Orchestration tool. From menu select Settings → System Configuration as shown

...

  1. in the image below.

       Image Modified


2. User should click Click on 'Add configuration' shown on the top right corner of the System Configuration page and add the Configuration name and configuration value accordingly following 4 configurations and click on save changes button.
 

Image Modified

1.1.2 Using MySql 

 user should be able to set the pagenation limit from master_config table. (User should set CDROUTER_PAGINATION_LIMIT from MASTER_CONFIG table ).

user has to run this query to update. 


INSERT INTO master_config (CONFIG_NAME, CONFIG_VALUE) VALUES ('
Parameter NameDescription
CDROUTER_SERVICE_BASE_URLCD Router Service base url
CDROUTER_PAGINATION_LIMIT
', '10');

2.  Setting CD Routers URL

    • If there are multiple CDRouters in a single setup, the user has the option to provide details for each CDRouter by specifying their respective URLs and specific names. This allows users to include information about different CDRouters present in the same setup.

2.1.1 Using UI

1.User should navigate to Automatics home URL and click on 'System Configuration' under settings drop down as show in the image below.

Image Removed

2.  User should click on 'Add configuration' shown on the top right corner of the System Configuration page and add the Configuration name and configuration value accordingly and click on save changes button.

Image Removed

user should set the urls for different CDRouters available in MASTER_CONFIG table. If more than one CDRouters are available also user has to set the urls according in the master_config table under CDROUTERS column. the values entered by the user should be in JSON format only as shown in the figure.

...

Recommended value 10

In a single API call, the orchestration side will receive 10 packages. If there are a total of 30 packages

and the pagination limit is set to 10, then these packages will be fetched in three requests

CDROUTERS

Configure the CDRouters details to be used with Automatics in given json format. You can give a suitable name to the cdrouter application under 'name' variable and provide the base URL of the cdrouter application under 'url' variable. If you have disabled the automatic login in your cdrouter application, then you need to configure the auth token under 'auth' variable. The auth token should be provided in Base64 encrypted format.

eg: 

 [{"name":"

...

CDRouterInstanceName1","url":"http://

...

XXX.

...

XXX.

...

XXX.

...

XX"

...

,

...

"

...

INSERT INTO master_config (CONFIG_NAME, CONFIG_VALUE)
VALUES ('CDROUTERS', '[

auth":"

...

xyz"},

{"name":"

CDRouter1

CDRouterInstanceName2","url":"http://

123

XXX.

456

XXX.

789

XXX.

012

XX"

}

,

{

"

name

auth":"

CDRouter2","url":"http://987.654.321.012

pqr"}]

');

1.3 Setting CDRouter base Url:

    • User should provide CDRouter base url beacuse it's responsible for orchestrating CDRouter test executions.

       1.3.1 Using UI 

               user can add CDRouter service base url also by following above steps but changing the configuration name and configuration value accordingly.
               Image Removed

1.3.2 Using MySql DB

user should set the base CD router url in master-config table under CDROUTER_SERVICE_BASE_URL column.
Example: http://localhost:8080/api/cdrouter/service

INSERT INTO master_config (CONFIG_NAME, CONFIG_VALUE)
VALUES ('CDROUTER_SERVICE_BASE_URL', 'http://localhost:8080/api/cdrouter/service');

Note: user should add their base CDRouter service url when they setup the CDRouter service 

Test_TypesAdd test type 'CDROUTER' along with existing test type values


3. Adding a new test type as CDROUTER

1. Navigate to the automatics url  and URL  and select 'System Configuration' under the settings drop down as shown in the below image.

Image Modified


2. User should search for 'Test_Types' in the search bar and click on the edit button present on the right side of the page.

Image Modified

3. user should add 'CDROUTER' in the configuration value and click on save changes to save the new test_type.

Image Removed 

4.Creating a New Job as AUTO_CDROUTER_TEST_JOB

...


New Job Template in Job Settings Page

1 From menu select Settings → Job Settings as shown in the image below

...

. 
Image Modified

...


2 Click on add new job on the right top corner as shown below.

Image Modified


3 . User should add the following details under 'Enter Job Name' add Add job name as AUTO_CDROUTER_TEST_JOB' and under select parent job add 'AUTO_QUICK_TEST_JOB' and click on save button.

Image Modified
5. Adding

Configure CDRouter Base URL

...

under Device Models

  1. Navigate to Manage

...

  1. User should navigate to manage Scripts page and click on 'run on models' button seen on top of the page.

 Image Modified

    2. User should add CDRouter base url  under URL under Device Name and add 'CDROUTER' as Image Name prefix. Select the device type in Select Category and click on save button.
        it's a mandatory step that user should follow.  

Image Modified



Configuration

...

in

...

1.Java Version

This micro service needs JAVA 11 to run. User should use Java 11 to make this micro service up. please refer setup page for steps to install Java 11.

2. Automatics base url
         In CDrouter service user should navigate to application.properties and update automatics.url with proper automatics base url and save the changes.

Image Removed

3. Adding Automatics base url in extra properties of the device from device manager page.

  • User should navigate to device manager UI page and in the search for the device the user added.

Image Removed

...

Device Manager

Map the device with cdrouter instance

Add cdrouter url in extra properties of the device.  Basically, it is used for locking and unlocking of devices.  Every time a new CDRouter is connected to this device, the user should update the base URL of CDRouter connected to the corresponding device.

  1. Launch Device Manager tool.

Image Added

2. Click on 'Edit Device Extra Properties' button. A pop-up will be shown.

Image Modified

3. In the pop-up user should add 'cdrouterinstance' under Name category and base

...

URL of

...

CDRouter that the device is connected to

...

under value category.

...

Click on add button as well as update button at the bottom.

Image Modified

...