Quick Start provides a simple tutorial for developers to install the open programmability environment on the local host and help developers develop and debug SSP service packages.
Preparations
Install the following software or packages on your local computer:
Note:  The Professional edition of PyCharm is used as an example. If you use Visual Studio Code, refer to Using Visual Studio Code to Configure a Debugging Environment.
Note:  For details about the differences in open programmability scenarios and software installation, refer to Introduction to Three Open Programmable Scenarios.
Start Software
  • 1

    Open the software package

    Double-click the start.bat script and wait for the software to start successfully. During execution, do not close the window.

  • 2

    Open the programming page

    Access https://127.0.0.1:32018/aocwebsite  in the browser.

Note:The SND package is provided by Huawei and can be downloaded from the resource download page of the developer community Resource Download By default, an SND package has been installed and activated in the environment. To manually install and activate a package, perform the operations below.
Load SND Package
  • 1

    Quick Entry

    Click Package Repo on the Quick Entry tab page on the home page. The Package Repo page is displayed.

  • 2

    Importing an SND package

    On the Package Repo page, import an SND package, including the software package (.zip) and signature file (.asc).

  • 3

    Activating an SND package

    Click Deploy in the Operation column to activate the SND package.

Manage Devices
  • 1

    Managing Devices

    Choose Resource > Device Management from the main menu.

  • 2

    Creating a device

    Click Create. On the Create NE page that is displayed, set basic information and communication parameters of the device.

  • 3

    Checking a device

    Choose Device Configuration > Device Configuration from the main menu. On the Device Configuration page that is displayed, check the newly added device. If the device status is normal, the device is managed successfully.

Note: An SSP package has been preinstalled and activated by default in the environment. To develop an SSP package based on service requirements, perform the operations below.
Developing an SSP package
  • 1

    Accessing the package management page

    Choose Package Repo from the main menu. On the package management page that is displayed, click Add.

  • 2

    Creating an SSP package template

    Set service package parameters and click OK. An SSP package template is created.

  • 3

    Exporting the template and developing an SSP package

    Export the SSP package template and import it to PyCharm. You can develop SSP packages in the IDE. For details, refer to Advanced Learning.

Loading an SSP Package
  • 1

    Opening the page

    In Quick Entry on the home page, click Package Repo. The Package Repo page is displayed.

  • 2

    Importing an SSP package

    Import an SSP package, including the software package (.zip) and signature file (.asc).

  • 3

    Activating an SSP package

    Click Deploy in the Operation column to activate the SSP package.

Configuration Environment
Before debugging, you need to configure the debugging environment. This includes configuring the SDK, Debug Server, and Jinja template debugging environment, and adding running files to the environment.
Configuring the SDK
  • 1

    Open PyCharm and choose File > Settings from the main menu.

  • 2

    Click Project: AOC* (AOC* indicates the project name in the video) and click Project Structure.

  • 3

    Click +Add Content Root on the right, select the mediator folder in the AOC* software package, and click OK.

  • 4

    In the navigation tree on the left of PyCharm, right-click the mediator folder and choose Mark Directory as > Sources Root from the shortcut menu.

Configuring the Debug Server
  • 1

    Open PyCharm and choose Run > Edit Configurations from the main menu.

  • 2

    Click +, click Python Debug Server, and create a debugging task of the Python Debug Server type.

  • 3

    Set Local host name to localhost and Port to 30000.

Configuring the Jinja Template Debugging Environment
  • 1

    Open PyCharm and choose File > Settings from the main menu.

  • 2

    Choose Editor > File Types, find Jinja 2 Template, and click +.

  • 3

    In the dialog box that is displayed, enter *.j2 and click OK.

Adding a Running File to PyCharm
  • 1

    Choose File > Settings from the main menu of PyCharm.

  • 2

    Click Project: AOC* (AOC* indicates the project name in the video) and click Project Structure.

  • 3

    Click +Add Content Root on the right and add a running environment path.

Debugging
  • 1

    Start the Debug Server.

  • 2

    Perform a dry run. On the Service Management page, set service parameters, and click Add. Then set username, click Create, enter an NE name and password in nename and password respectively, and click Dry-run.

  • 3

    PyCharm automatically displays the code and stops at the default code entrance. You can add breakpoints to the code to be debugged.

Advanced Learning  →

Advanced Learning explains the principles and GUIs of AOC, and the development process of the SND and SSP packages.

  • Preparations

    Quick Start provides a simple tutorial for developers to install the open programmability environment on the local host and help developers develop and debug SSP service packages.

    Install the following software or packages on your local computer:

    Note: The Professional edition of PyCharm is used as an example. If you use Visual Studio Code, refer to Using Using Visual Studio Code to Configure a Debugging Environment.
    Note: For details about the differences in open programmability scenarios and software installation, refer to Introduction to Three Open Programmable Scenarios.
  • Starting Software
    • 1

      Open the software package

      Double-click the start.bat script and wait for the software to start successfully. During execution, do not close the window.

    • 2

      Open the programming page

      Access https://127.0.0.1:32018/aocwebsite in the browser.

  • Loading an SND Package
    Note: The SND package is provided by Huawei and can be downloaded from the resource download page of the developer community Resource Download By default, an SND package has been installed and activated in the environment. To manually install and activate a package, perform the operations below.
    • 1

      Quick Entry

      Click Package Repo on the Quick Entry tab page on the home page. The Package Repo page is displayed.

    • 2

      Importing an SND package

      On the Package Repo page, import an SND package, including the software package (.zip) and signature file (.asc).

    • 3

      Activating an SND package

      Click Deploy in the Operation column to activate the SND package.

  • Managing Devices
    • 1

      Managing Devices

      Choose Resource > Device Management from the main menu.

    • 2

      Creating a device

      Click Create. On the Create NE page that is displayed, set basic information and communication parameters of the device.

    • 3

      Checking a device

      Choose Device Configuration > Device Configuration from the main menu. On the Device Configuration page that is displayed, check the newly added device. If the device status is normal, the device is managed successfully.

  • Developing an SSP Package
    Note: An SSP package has been preinstalled and activated by default in the environment. To develop an SSP package based on service requirements, perform the operations below.
    • 1

      Accessing the package management page

      Choose Package Repo from the main menu. On the package management page that is displayed, click Add.

    • 2

      Creating an SSP package template

      Set service package parameters and click OK. An SSP package template is created.

    • 3

      Exporting the template and developing an SSP package

      Export the SSP package template and import it to PyCharm. You can develop SSP packages in the IDE. For details, refer to Advanced Learning.

  • Loading an SSP Package
    • 1

      Opening the page

      In Quick Entry on the home page, click Package Repo. The Package Repo page is displayed.

    • 2

      Importing an SSP package

      Import an SSP package, including the software package (.zip) and signature file (.asc).

    • 3

      Activating an SSP package

      Click Deploy in the Operation column to activate the SSP package.

  • Configuring Debugging

    Configuration Environment

    Before debugging, you need to configure the debugging environment. This includes configuring the SDK, Debug Server, and Jinja template debugging environment, and adding running files to the environment.

    Configuring the SDK

    • 1

      Open PyCharm and choose File > Settings from the main menu.

    • 2

      Click Project: AOC* (AOC* indicates the project name in the video) and click Project Structure.

    • 3

      Click +Add Content Root on the right, select the mediator folder in the AOC* software package, and click OK.

    • 4

      In the navigation tree on the left of PyCharm, right-click the mediator folder and choose Mark Directory as > Sources Root from the shortcut menu.

    Configuring the Debug Server

    • 1

      Open PyCharm and choose Run > Edit Configurations from the main menu.

    • 2

      Click +, click Python Debug Server, and create a debugging task of the Python Debug Server type.

    • 3

      Set Local host name to localhost and Port to 30000.

    Configuring the Jinja Template Debugging Environment

    • 1

      Open PyCharm and choose File > Settings from the main menu.

    • 2

      Choose Editor > File Types, find Jinja 2 Template, and click +.

    • 3

      In the dialog box that is displayed, enter *.j2 and click OK.

    Adding a Running File to PyCharm

    • 1

      Choose File > Settings from the main menu of PyCharm.

    • 2

      Click Project: AOC* (AOC* indicates the project name in the video) and click Project Structure.

    • 3

      Click +Add Content Root on the right and add a running environment path.

  • Debugging
    • 1

      Start the Debug Server.

    • 2

      Perform a dry run. On the Service Management page, set service parameters, and click Add. Then set username, click Create, enter an NE name and password in nename and password respectively, and click Dry-run.

    • 3

      PyCharm automatically displays the code and stops at the default code entrance. You can add breakpoints to the code to be debugged.