Device Manager UI  Login

By giving the respective credentials such as UserId & password , user can login to Device Manager Tool.

Manage Devices

To perform test execution device details need to be added  this can be done in Manage devices page.

Add device details

Before adding device details as a prerequisite Device Group , Device Category , Device Model , Head End need to be added.

To add device details user can click on add STB details icon on right top of the page . Fields Mac and IP should be unique that identifies the device details.

on Next page user can add extra properties for the device if available by providing the config Name and Its value.

Click on Save button to add new device details. 

Connected Client devices too should be added as devices under same account number as the router device to which it is connected.

Please follow Connected Client Extra Properties to get the details of extra properties to be configured for connected clients

Update Device Details

Edit the device details by clicking on edit icon in the Action column of each device

User can edit the device details from here.

Delete Device details

To delete device details click on delete icon 

Edit Device Extra Properties 

The steps for configuring connected clients is same as configuring standalone device except that it requires additional data like device login details etc.. to be included while adding the device.

• The connected clients and router device should be mapped under same account number while adding them to device manager.
• For connected clients, the additional data should be configured in extraProperties section while adding the client device.

 To Edit and View Device Extra Properties click on Edit Device Extra Properties.

User can View, Add, Delete, and Update Device Extra Properties here.

Property Name provided as an input to Name filed and respected value is provided as an input to Value filed . Click on Add button to add extra property

Add Head End

Steps to Add Head End details

• click on "Add Head End" button on top right of the web page.

• Provide Head End Name.
• Click on "Save" button to add Head End Details.

Delete Head End

Steps to Delete Head End Details

• Navigate to Manage Devices → Add Head End .
• Click on "Remove Head End" symbol in Actions Column as shown below

Add Device Category

Steps to add device category deatils:

• Click on ManageDevices->Add Device Category option.[top right of the webpage].

• Provide "Device Category Name" details .
• Click on "Save" option to add device category details.

Delete Device Category

Steps to Delete Device Category Details:

• Click on ManageDevices->Add Device Category option.
• Click on Remove Device Category Symbol available in Action Section . Refer below attachment.

• On Successfully Deleting Device Category Details Success pop up will be shown and table will be updated with latest changes.

Add Device Model

Steps to Add Device Model details.

• Click on "Add Device Model" option on right top side of the web page.

• Provide Device Model Name 

• Click on Save button to add device model details.
• Verify that device model list table is updated with provided device model details.

Delete Device Model

Steps to Delete Device model details :

• Navigate to Manage Devices → Add Device Model .
• Click on "Remove Device Model" symbol in Actions Column as shown below.
• On Successfully Deleting Device Category Details Success pop up will be shown and table will be updated with latest changes.

Add Feature

Steps to add Feature Details:

• Click on "Add Feature" on right top side of the web page .

• Provide feature Name  and Select "Is Special Feature " if the provided feature is Special Feature.

• Click on Save option to save feature details.
• On successfully adding device details pop up message will be shown and feature list table will be updated with latest feature details .

Delete Feature

Steps to Delete Feature details :

• Navigate to Manage Devices → Add Feature .
• Click on "Remove Feature" symbol in Actions Column as shown below.

Bulk Operations

User can do Bulk Operations on selected device details.

• Pool Status Change

User is provided with option "POOL Status Change" which supports two option:

YES - the selected devices will be Excluded from the pool execution.

NO -  the selected device will be not be Excluded from pool execution.

Steps to do Pool Status Change:

• •  Select devices 
  • Click on Bulk Operation option on right top side of web page.
  • Click on "Pool Status Change ".
  • Click on "Yes" option if you want to exclude selected devices from pool execution if not select "NO" option.

• • Provide remarks and click on yes button to do bulk operation.

• • On successful bulk operation pop will be shown as bulk operation is successful and selected device details "is Executed From Pool" filed will be updated .

• Delete

User is provided with DELETE option to delete selected devices one go:

Steps to do Pool Status Change:

• •  Select devices 
  • Click on Bulk Operation option on right top side of web page.
  • Click on "Delete ".
  • Provide remarks and click on yes button to do bulk operation delete.

• • On successful bulk operation pop will be shown as bulk operation is successful and selected device details will be deleted.

• Status Change

User is provided with option  "Status Change" to change the device status on selected devices on selecting the any one of options as listed below.

• • GOOD
  • BAD
  • IN USE
  • RESERVED
  • NO AV 

Steps to do Pool Status Change:

• • Select devices 
  • Click on Bulk Operation option on right top side of web page.
  • Click on "Pool Status Change ".
  • Click on GOOD , BAD , IN_USE , RESERVED or NO_AV any one option to set device status on selected device status.

• • Provide remarks and click on yes button to do bulk operation delete.

• • On successful bulk operation pop will be shown as bulk operation is successful and selected devices Device Status field will be updated .

Device Groups

To manage Device Group details click on "Device Groups" option.

Add device group

Steps to Add device group details 

• Click on Device Group tab
• Fill Device Group Name filed
• Click on "Save Device Group "option to save device group details.

• ON successful adding device group details pop up will shown with successfully added device group details message and group list table will be updated.

Delete device group

Steps to Delete device group details 

• Click on Device Group tab
• Click on "Remove the Device Group" symbol in Actions Column as shown below

• On successfully deleting device group details successful pop will be shown and Device Group table will be updated.

User Management

• From Device Manager UI, Click on User Management Tab

User can Add/Delete the user details.

• Click on Add New User

• • Enter Preferred User Id: “guest”
  • Enter the user name: “guest”
  • Enter Email address
  • Enter Password
  • Click on Add
• Edit User Details
  
  • Select the User , you want to edit and click on Edit the User symbol in the Action section of respected user.

• • Update Email and username details. 
  • Click on update to update user changes.
• Delete User
  
  • Select the User , you want to delete and click on Remove the User symbol in the Action section of respected user.

Power Manager - Configure Peripheral Power Units/SPDU

Automatics users can configure SPDU details in Device Manager to leverage its remote device power management support in Automatics test scripts. If SPDU has REST APIs to manage power operations, then those details can be configured in Device Manager. In addition to this, user has to make below configurations too.

• In Automatics Properties, please add property peripheral.powerProvider=true for test scripts to use SPDU rest endpoints for power operations.
• In partner implementation project, please add <bean id="powerProvider" class="com.automatics.providers.rack.impl.DefaultPowerProviderImpl" lazy-init="true" scope = "prototype"/> and comment out if any other PowerProvider implementation is included in partner-applicationContext.xml and deploy the 

In Device Manager, user configure SPDU details in 3 steps.

• Configure SPDU details via Manage Power Devices
• Add the power operations supported by SPDU
• Map the devices/DUTs against SPDU slots

Once above configurations are done, user is good to use SPDUs for power management from test scripts.

Configure SPDU Details

Power Manager Details needs to be configured before mapping the device.

Add New SPDU Details

• From Device Manager UI, Navigate to  Manager Power Devices  > Power Manager 

• Click on Add New Power Manager

• • Enter Power Manager Name:  Enter name to identify SPDU name: eg “PDU-4”
  • Enter Power Manager Url - Url to access SPDU home page
  • Enter Outlet Count  - Enter total number of power slots supported in SPDU
  • Enter Outlet Start Index - Enter the starting index of slots. In some SPDU, slot numbering starts with 0, in that case add 0.
  • Select Supported Operations - Select power management operations supported by SPDU like ON, OFF, POWER_STATUS, POWER_CYCLE
  • Click on Next 
  • Provide the list of slot numbers mapped to group names as configured in the power manager.

In SPDU that supports groups, eg the first 8 ports will be mapped under group A and next 8 will be under group B

GroupName - GroupName defined in SPDU device should be provided. If SPDU has groups eg: A, B and under each group there will be 8 slots available. Please enter group name if it is supported or else please give a dummy value.

SlotNumber - Select list of Slot numbers that are mapped to under group name as configured in SPDU devices. Here in screenshot, Slots 1 to 8 in SPDU are mapped in group A and 8 to 16 under group B. Similar to that mapping is added here.

• • Click on Save Button to add power manager details.
  • Success Popup will be shown once power manager is added is successfully.

Edit SPDU Details 

• • Select the Power Manager  , you want to edit and click on Edit the Power Manager symbol in the Action section of respected power manager.

• • Update power manager name , power manager url , Supported Operations and group device details
  • Click on Update to update power manager changes.

• Delete SPDU Details

  • Select the Power manager , you want to delete and click on Remove the Power Manger  symbol in the Action section of respected power manager.

Configure SPDU Operations

User has to configure the power operations supported by SPDU like POWER ON, POWER OFF, POWER STATUS,POWER CYCLE 

• From Device Manager UI, Navigate to   Manager Power Devices  > Power Operations

Add SPDU Supported Power Operations

• Click on Add Power Operations icon.

• • Select Power Manager Name
  • Select Power Operation
  • Select Request type
  • Enter url template to trigger power operation at PDU device - Rest API Url to perform given operation on SPDU. Please replace  group name,  slot  or device mac address in url with respective place holders {GROUP_NAME}, {SLOT_NUMBER}, {MAC_ADDRESS} so that they are replaced with SPDU details configured in Device Manager during test execution. The complete url with placeholder is expected here.
  • Enter Requested Body template -  Similar to mentioned in url template section, please provide request body template for POST requests with place holders.
  • Enter Response body template - Here, we can give the field in the response from SPDU rest API which can be used to verify if power operation was success. For eg: if response body from SPDU for POWER ON is {"status": "SUCCESS"}, we can provide $.status under response body template to validate the value of field status in json response. Similar to Json path, we add Xpath or plain text if response is in json or plain text. After this, the expected value for status field should be configured in Automatics Props tool. For each operation, expected value can be configured against property powerOnValues, powerOffValues, powerCycleValues.
  • Enter Response Code - Enter the expected the response code from SPDU rest API on successful operation. This is used in test for validation.
  • Click on Next 
  • User has an option to configure additional data in extra properties for defined  power operation. Like, for POST request user can configure request and response types here in additional properties against fields

requestContentType  and responseContentType. They will be used by automatics-core while creating request SPDU and during response validation

• • Click on Save Button to add power operation details.
  • Success Popup will be shown once power manager is added is successfully.

Edit Power Operations 

• • Select the Power Operation, you want to edit and click on Edit the Power Operation symbol in the Action section of respected power operation.

• • Update Power Operation details
  • Click on Update to update power operation changes.

Delete Power Operation

• • Select the Power Operation , you want to delete and click on Remove the Power Operation  symbol in the Action section of respected power Operation.

Map SPDU Slots with Device

Configured Power manager details can be mapped to the configured device in Device manager application.

• From Device Manager UI, Navigate to Manager Power Devices tab.

User can Add/Delete/Update the power Device mapped details.

• Add New Device Mapping
  • Click on Add New Power Devices

• • Select Power manager 
  • Select Device Mac Address from the dropdown
  • Select the group name 
  • Select the slot number to which the device is connected
  • Click on Save
  • Success Popup will be shown once device mapping is done  successfully.

• Edit Device Mapped details
  • Select the power manager name to get the list out the device mapping available and click on fetch/refresh button.

• • Select the device mapping , you want to edit and click on Edit the Power Device symbol in the Action section of respected mapped devices.

• • Update device mapping details
  • Click on Update 
• Delete Device Mapping
  
  • Select the Device Mapping , you want to delete and click on Remove the Device Mapping  symbol in the Action section of respected Device Mapping.

Configuration

Configuration required to support health check in devices are listed out in the Configuration tab. These parameters need to be updated to trigger the health check on devices

Update Health Check Parameters Configuration

• Follow below Steps to update Config params
  • Navigate to Configuration Tab
  • Click on the edit symbol of the desired config value to be updated 

• • Provide the data that need to be added in the pop up and click on update to save the details

Health Check

• • Device Manager has a support for health check feature.
  • It empowers the testers and other users to do health check on the devices before executing any test cases.
  • User can easily get the list of devices which are in good state and bring up the devices manually which are in bad state before triggering test cases.
  • It reduces the tester time for verifying and getting the devices which are in good state.

Schedule New Health Check

Tester or user can schedule the health check for the list device daily or weekly or once based on the requirement.

Follow below steps to Schedule the devices for health check

• • • Update Health Check Configuration - This step is required only when partner is going to schedule health check for the first time. Below list of config parameters need to configured before scheduling the health check on priority. Please refer UpdateHealthCheckParametersConfiguration
      • JENKINS_URL - Jenkins Url where health check job is defined this param value is used in the device manager while triggering the health check job.
      • USERNAME - Jenkins user name.
      • PASSWORD - Jenkins password.
      • APPENDERS - User can update there custom appenders to the already available list This param is getting used in providing options to the user to filter the execution results on the dashboard.
    • Click on add new schedule details button available on the right top of the UI page.

• • • New Scheduler pop up will be show as below .Provide mentioned details and click on submit button to schedule the execution

• • • • Execution Name -  Provide the user execution name 
      • Appender - user can select the appenders from the provided options to filter the results on dashboard.
      • Execution Date and Time (EST) - Select the EST time range within which the executions should be happening.
      • Occurrence - User need to select the the number of times executions need to be repeated from the mentioned options
        • Once - Need to execute only once
        • Daily - Need to execute daily within the date range selected
        • Weekly - Need to execute the executions on selected date range
      • Job Name - User need to provide the JOB Name defined in the jenkins for health check executions[Refer Health Check Job Creation for more details on how to create jenkins jobs for health check]
      • Schedule type - Need to be selected as health check.
      • Select the devices to be added for the Scheduled that are restricted to 20 count for each schedule.
    • On successful creation user should be able to see a successful pop up message and the dashboard is updated with the scheduled details

Add devices to the scheduled executions

If user or tester need to add the devices once the scheduling is done Please refer below steps to add the devices to already scheduled executions.

• • • Click on the executions which in scheduled state to which the devices need to be added.

• • • Click on add devices options select the devices need to be added to the executions Will be provided options i.e
      • "Add to Current Event " – Click on this option  if devices need to be added only for that executions
      • "Add to Event Series" – Click on this option if devices need to the added for the series of executions scheduled this option is seen only if the scheduled executions are set to DAILY or WEEKLY

• • • On successful addition device list will be updated and successful pop up message will be seen

Delete device from the scheduled executions

• • • Click on the executions seen on the dashboard which are in scheduled state.

• • • select devices option 

• • • will be able to see the list of devices added will be shown

• • • Click on Delete  button for the device that need to be removed from the scheduled execution

• • • Confirmation pop up will be shown to delete the device from the Current execution alone or from the all the execution series 

• • • On successful deletion success pop up will be seen and device list will be updated.

Show list of devices added for scheduling

User can see the list of devices added for scheduled executions Refer below steps.

• • • Click on the executions seen on the dashboard.

• • • select devices option will be able to see the list of devices added as shown below.

Clone Schedule

User needs to schedule the execution on different time range with the features of an already scheduled execution then user can refer below to create a clone of already defined scheduled execution with different execution date and time range.

• • • Click on executions in scheduled state on the dashboard user need to clone.

• • • Click on "Clone Schedule" option

• • • Pop up will be shown with the execution name and date range params need to be updated as required by the user and Click on submit to schedule the executions.

• • • On successful cloning the user will be able to see the Success pop up message and Executions are scheduled for the provided details on dashboard.

Execution Details

• • • Click on executions which are in complete state

• • • Execution summary is shown with once on clicking on the completed executions as shown below.

• • • • Name - Execution name defined by user
      • Execution Starts - Date and time details when executions are going to be started.
      • Total Devices -  Total number of devices assigned for executions.
      • Passed Devices - Number of devices cleared health check steps and are in good state
      • Failed Devices - Number of devices failed to clear health check validation and are in bad state.
      • Non Device Issues - Number of devices where health check got failed because of other dependencies.
      • Device Already in Use - Number of devices which already in use while executing health check.
      • Percentage Completion - Provide the completion percentage calculated based on number of devices health check completed.

Detailed results can be observed by clicking on devices options as shown below

• • • • Remarks - Section Provide the details on health check step for each devices with the results updated.

Cancel Event 

User can delete the scheduled executions before execution starts Follow below steps to delete event.

• • • • Click on executions in scheduled state on the dashboard user need to clone.

• • • • Click on "Cancel Event" option will delete the current execution alone.

Cancel Event Series

User can delete the scheduled executions for Daily or Weekly before execution starts Follow below steps to delete event series.This option is only valid for Scheduled execution done for daily or weekly.

• • • • Click on executions in scheduled state on the dashboard user need to clone.

• • • • Click on "Cancel Event Series" option will delete the current execution and upcoming executions also.