Page History

...

Introduction

Briefly describe in general terms the system/application and the purpose for which it is intended, written in non-technical terminology. Consider including a high-level architecture diagram for the system. The description should include, but is not limited to, the following:

• Key features or major functions/use cases performed by the system/application
• Architecture of the system in non-technical terms (e.g., client server, Web-based, etc.)
• System environment or special conditions

Backup and Restore is a Troubleshooting feature developed for the WebUI considering RPi as the reference platform.

...

Environment Setup

• Set-up Considerations

<Briefly describe and graphically depict as appropriate the equipment, communications, and network configuration of the system in a way that a non-technical user can understand>

Backup and Restore functionalities are supported by a set of script files. Following are the mentioned script files:

...

These script files which are already present in the RDK build, will execute when the Backup and Restore buttons are clicked.

• User Access Considerations

<Briefly describe and graphically depict as appropriate the equipment, communications, and network configuration of the system in a way that a non-technical user can understand>

• Accessing the System

...

The User needs to login to the WebUI using <username> admin and <password> password (These are default username and password). Once logged in, the following procedure has to be followed:

...

Please check the following figure for reference:

• System Work Flow

...

Once Backup is performed, the following path can be checked to ensure that backup has executed as expected.

...

Please check the following figure for reference:

• Exiting the System

<Mention the validation artifacts that are essential to ensure the functionality is working as expected. Also any limitation while closing the validation process>

Care should be taken that before Backup is performed, backup.tar file already existing in Download folder of Local PC has to be deleted or renamed to avoid creation of duplicate file.

Please check the following figure for reference:

Executing System

Describe the specific system function or feature in detail and depict graphically by including screen prints and descriptive narrative as appropriate. Ensure each screen print is captioned and has an associated tag providing appropriate alternative text

Follow the above for sub feature / use cases

The Backup feature creates a tar file in the /tmp/ folder. This tar file contains all the necessary files like, bbhm_bak_cfg.xml, syscfg.db and bbhm_cur_cfg.xml required for backing up all the user settings. The same tar file is downloaded to local PC.

...

Troubleshooting

• Error Messages

<Identify the error messages that a user may receive and the likely cause(s) and/or possible corrective actions for the error>

If restore is success, the following message will be displayed before automatic device reboot.

...

       * Restore configuration Failure! Please try later.

• Special Considerations

...

The backed up and restored files are by default named as backup.tar (if changed, will cause misbehavior in feature execution).

...