Hide a Connection Property

Oracle recommends obtaining as minimal information as possible from integration developers. Therefore, when a connection property has the same value across all connections, assign a static value to the property and hide the property. Integration developers who create a connection don't see the property in the Oracle Integration user interface.

For example, consider an application for which all invoke connections point to a specific URL. You can hard code the domain for every invoke connection and hide the URL field. That way, you simplify the experience for integration developers.

You can also use properties as global variables and hide the properties so that they can be substituted within an integration.

  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. Add the hidden and default properties below the required property for the connection definition and provide values for the properties.

    For example, the following code sample specifies a default value for the baseURL property and hides the value using the hidden property.

    Note:

    The following example does not include the displayName and description properties because the scenario doesn't require them.
    "connectionProperties": [
      {
        "name": "accountid",
        "type": "string",
        "displayName": "Account ID",
        "shortDescription": "Enter the account id.",
        "required": true,
        "hidden": false,
        "scope": "ACTION"
      },
       {
        "name": "baseURL",
        "type": "URL",
        "required": true,
        "hidden": true,
        "default": "https://connect.squareupsandbox.com/v2",
        "scope": "ACTION"
      }
    ]
  4. Save your changes.