Versions Compared

Key

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

...

      • 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. Able to see the

Image Added

      • New Scheduler pop up will be show as shown below

Image Removed

      • .Provide below mentioned details and click on submit button to schedule the execution

Image Added 

        • 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

Image Added

Add devices to the scheduled executions

...

      • Click on the executions which in scheduled state to which the devices need to be added will be able to see the pop as shown below.

Image 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

...

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

Image Added

      • select devices option 

Image Added

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

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

Image Added

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

...

      • Click on the executions seen on the dashboard.

Image Added

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

...

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

Image Added

      • Click on "Clone Schedule" option

Image RemovedImage Added

      • 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

Image Added

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

Image Modified

        • 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

Image Modified

        • 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.

Image Added

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

Image RemovedImage Added

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.

Image Added

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

Image RemovedImage Added