Customizing the config.json file

The config.json file contains the plug-in configuration. You can modify the config.json file with the PDK JSON Editor.

Procedure

  1. In the Project Explorer view, expand the plug-in project node.
  2. Expand the plugin folder node.
  3. Double-click the config.json file, or right-click the file and select Open with > PDK JSON Editor.
    The Overview tab, which shows the structure and contents of the plug-in, is displayed. This tab has four sections:
    Package
    Lists the parts, node parts, and roles in the plug-in. Click Add to add a part, node part, or role to the plug-in.
    Metadata
    List the components, links, and policies in the plug-in. Click Add to create a metadata element in metadata.json.
    Runtime
    Provides links to the metadata.json, operation.json, and tweak.json files for the plug-in.
    If an item is available for editing in Eclipse, you can double-click to open it.
  4. Click the Configuration tab to update the config.json file.
    The Configuration tab shows the contents of the config.json in a form-based user interface. Using this interface, you can do the following tasks:
    • Specify or modify basic plug-in information, such as the ID and version.
    • Add and remove pattern types that are associated with this plug-in.
    • Add and remove plug-in file references as needed.
    • Add and remove plug-in configuration parameters as needed.

    Values that you specify are immediately validated, and errors, such as missing required fields, duplicate IDs, are flagged, with help tips, for correction.

    In some cases, you might prefer to modify the configuration text directly, by clicking the config.json tab to present the configuration information in a formatted text editor. Changes that are made in either the Configuration user interface or the source text editor are immediately reflected in both views.