Update the Name or Description of a Connection Property

You can update the user-facing name and description of a connection property at any time. Integration developers see these values in the Oracle Integration user interface when configuring a connection.

  1. In Visual Studio Code, in the Explorer pane, expand definitions, and select the adapter definition document.

    The adapter definition document has an extension of .add.json, such as adapter.add.json.

    The adapter definition document appears in the workspace.

  2. Expand the connection section of the adapter definition document.
  3. Update the following properties for the connection definition as needed.
    • displayName: User-facing name of the connection property.
    • description: User-facing hint text for the connection property.
    • shortDescription: User-facing description of the connection property.

    This properties appear below in bold.

    "connectionProperties": [
      {
        "name": "accountid",
        "type": "string",
        "displayName": "Customer Account ID",
        "description": "Account ID",
        "shortDescription": "Enter the account id.",
        "required": false,
        "hidden": false,
        "scope": ["ACTION"]
      }
    ]
  4. Save your changes.