Cisco Crosswork Planning Design 7.2.x User Guide

PDF

Cisco Crosswork Planning Design 7.2.x User Guide

Create add-ons

Updated: August 14, 2026

Want to summarize with AI?

Log in

Provides step-by-step instructions for creating a customizable add-on in Cisco Crosswork Planning Design including uploading scripts, configuring UI fields with the Form Builder, validating requirements, and finalizing the add-on for use within the system.

This topic describes how to add a new customizable add-on to automate or enhance tasks in Cisco Crosswork Planning Design.

Use this process to create an add-on for use within the system, supplying your own script and customizing the UI.

Before you begin

Review the requirements in Requirements and limitations for add-on configuration.

Procedure

  1. Open the Manage Add-ons page using one of these options:

    • On the Network Design page, click Manage add-ons.

    • From the toolbar, select Actions > Add-ons > Manage add-ons.

  2. Click Add icon to open the Add-on Settings page.

  3. Enter the basic details.

    1. Enter the name of the add-on.
    2. In File, upload the compressed file containing your add-on script.
    3. In Specify executable, enter the name of the add-on script file within the uploaded zip folder that will be executed when the add-on runs.
    4. Click Proceed to form builder.

      The Form Builder page opens.

  4. (Optional) To make any changes to the add-on name, executable name, or description, click Edit in the Add-on settings section.

    Note

    You cannot upload a different add-on file using this option.

  5. On the Form Builder page, drag the required component from the left pane to the main area. Configure the steps and input controls for your add-on’s user interface. For descriptions of all the fields, refer to Add-on controls.

    1. Use the Step element to create new pages. Click to rename the label of the page.
    2. Use the Section element to create new sections in a page. Click to rename the label of your section.
    3. Use the elements under the Fields section to configure the required fields. Click to specify name, label, default values, or limitations for your fields.

  6. Ensure that each configured field meets the minimum required settings. The fields must display . If you have not met the requirements, an alert () appears. In this situation, click and specify the required fields.

  7. Click Preview to preview the add-on configuration. Verify all the details you configured.

  8. When you are satisfied with the changes, click Back to editor at the top to go back to the Form Builder page.

  9. Click Create add-on to create the add-on.

The new add-on appears on the Manage Add-ons page and is ready for use.

Add-on controls

This topic describes the fields you can use while configuring add-ons.

Table 1. Add-on controls

Field

Description

Step (new page)

Creates new pages.

Section

Groups fields together that are created within a step (page).

Field

Type of field.

  • Text Box: Text field.

  • Number: Numeric value. Supported format includes both whole and decimal numbers.

  • Dropdown: Selection of items to appear in a drop-down menu.

  • Check Box: Toggle entry. If selected, it is true and if not selected, it is false.

  • Table Selection: Select objects in a specified table. The selected objects are written to a file and then passed to the script.

    For example, if you select Circuits in the Select Table field, you need to select the required circuit objects while running the add-on.

  • Table Entry: Select a table column in a specified table.

  • File: Select a file. You can browse with a browse button to a different directory. The complete path is passed to the script.

  • Password: Text string. Characters entered are hidden. This field is used to pass sensitive text to script.