Skip to main content

Add Parameters

Parameters are global variables whose values are set by the user when they first connect to the data source. You can use the values provided by the user throughout the configuration.

The parameters that are required or useful for your data source depend on the application you're creating a data source for. However, some common parameters include subdomain for use cases where the user is connecting a particular environment to Tonkean (for example, "yourorg.atlassian.net/api" and accessToken (or other authentication token) to support authorization.

Refer to the documentation for the application you're creating a data source for to determine what information you need from the user.

Add a Parameter

  1. In the data source configuration panel, select Parameters. The Parameters screen displays.

    params_select.png
  2. Select + Add Parameter. The Create New Parameter window displays.

    add_param_select.png
  3. Enter the Display Name, and, if desired, a Parameter description.

    create_new_param_window.png
  4. If you want to make the parameter required in order to connect the data source, select the Is Required? toggle.

    create_new_param_window_is_req.png
  5. If you want to encrypt the value, select the Should Encrypt? toggle.

    create_new_param_window_should_encrypt.png
  6. When finished, select Create. The Create New Parameter window closes and the new parameter appears on the Parameter screen.

    param_added.png

    Once added, you can select Edit to update the details of a parameter or Delete to delete it.

    Before deleting a parameter, review the configuration to make sure it's not currently being used as this could cause the data source to stop working.

  7. Repeat steps #2-6 for each parameter you want to add to the data source.

Next Step