ToolJet/docs/versioned_docs/version-2.33.0/how-to/use-custom-parameters.md
Akshay 2d08d889de
Release: Community changes (v2.34.0) (#9226)
* add custom resolvers info and editable row selection info (#9057)

* fix system requirements icon

* add auth info for webhooks and fix casing

* add regex custom validation info (#9068)

* [docs]: Marketplace 1.7 updates (#9085)

* [docs] Amazon redshift plugin

* make minor improvements

* add and update docs for marketplace 1.7

* update order of plugins in overview to match sidebar

* create new version

---------

Co-authored-by: Shubhendra <withshubh@gmail.com>

* add the latest version in the versions.json file (#9094)

* [docs]: Update PDF component (#9088)

* update PDF component

* merged with develop and added changes to the new version

* update docs favicon: (#9118)

* [docs] SSO revamp (#9031)

* add method to set default language

* update image settings through custom css and update screenshots for getting started and tooljet concepts (#9158)

* fix read documentation button

* fix formatting for setup icons (#9172)

* fix sidebar link for aws lambda

* Update static media (#9175)

* updated the screenshots

* reduced the gif size

* reverted the package.json file

* edited the zoomed in images and replaced some gifs with screenshots

* removed one gif

* update static media

* update file names

* update toolbar

* fix file names

* fix: dynamodb img path

* update media for org management dashboard

* fix: casing and formatting

* update workspace constant media

* update media in workspace settings and github

* update github sso

* minor change to github sso docs

* minor fix

* update google sso

* change includeCurrentVersion flag to false

---------

Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>

* Feature: Engagespot plugin (#9012)

* feat(plugins): added engagespot plugin

* feat(docs): added engagespot plugin docs

* chore(engagespot-plugin): revised copywritings

* Feature: Databricks data source (#9174)

* plugin-created

* Databricks integration

* icon, error handling

* removed unrelated changes from marketplace and frontend package-lock.json removed runAsync and maxRows timeouts pending

* timeout implementation

* socket timeout and error handling

* resolve comments

* resolve comments2

* solved render issue test connection improvements

* solved undefined error

* fix TJDB not null value fail for is operation (#9055)

* fix TJDB not null value fail for is operation

* handling not null and null case insenstive values

* Support for marketplace plugin deploy on render preview app (#9221)

* Fix for marketplace error on render preview app

* add marketplace build command

* Adding new workflow for building marketplace plugin

* removed render app creation

* [:docs] Add documentation for Databricks plugin (#9224)

* add docs for databricks

* update databricks docs

* update docs

* remove ref to clusters

* bump to v2.34.0

* Fixed data source cypress failure (#9227)

* updated spec with required text

* updated mongodb and import spec

* updated import spec

---------

Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>
Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com>
Co-authored-by: Midhun G S <gsmithun4@gmail.com>
Co-authored-by: Shubhendra <withshubh@gmail.com>
Co-authored-by: Aman Regu <amanregu@gmail.com>
Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Jobin Jose <129726530+jobin-logidots@users.noreply.github.com>
Co-authored-by: Syed Mohammad Akhtar Rizvi <85864291+ShazanRizvi@users.noreply.github.com>
Co-authored-by: blank0537 <111295371+blank0537@users.noreply.github.com>
Co-authored-by: Mekhla Asopa <59684099+Mekhla-Asopa@users.noreply.github.com>
2024-03-29 19:13:26 +05:30

105 lines
4.6 KiB
Markdown

---
id: use-custom-parameters
title: Use Custom Parameters
---
Custom parameters in your queries offer a flexible way to introduce variables without directly modifying query parameters. This guide will walk you through creating, utilizing, and calling queries with custom parameters.
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
### Adding Custom Parameters
1. Open the query panel and select the query you want to add custom parameters to.
2. Navigate to the **Parameters** section in the top bar.
3. Click the **+** button to add a custom parameter.
4. For each parameter, specify:
- **Name:** Identifier for the parameter.
- **Default value:** A constant string, number, or object.
<div style={{textAlign: 'center'}}>
<img style={{ border:'0', marginBottom:'15px', borderRadius:'5px', boxShadow: '0px 1px 3px rgba(0, 0, 0, 0.2)' }} className="screenshot-full" src="/img/how-to/custom-parameters/params.png" alt="How to: use custom parameters" />
</div>
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
### Syntax for Utilizing Parameters
Use `parameters.<identifier>` in your query to employ custom parameters. Note that parameters can only be used within the query where they are defined.
<div style={{textAlign: 'center'}}>
<img style={{ border:'0', marginBottom:'15px', borderRadius:'5px', boxShadow: '0px 1px 3px rgba(0, 0, 0, 0.2)' }} className="screenshot-full" src="/img/how-to/custom-parameters/syntax.png" alt="How to: use custom parameters" />
</div>
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
### Example: Create row in ToolJetDB with Custom Parameters
Let's assume we have a ToolJetDB table with the following columns: `name`, `email`, and `contact`. We will create a new row in the table using custom parameters.
- Create a new ToolJetDB query, select a table from the dropdown and select the `Create Row` operation.
- Add the following parameters:
1. **name:** `name` and **value:** `Shubh`
2. **name:** `email` and **value:** `shubh@email.com`
3. **name:** `contact` and **value:** `4638563845`
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{textAlign: 'center'}}>
<img style={{ border:'0', marginBottom:'15px', borderRadius:'5px', boxShadow: '0px 1px 3px rgba(0, 0, 0, 0.2)' }} className="screenshot-full" src="/img/how-to/custom-parameters/params1.png" alt="How to: use custom parameters" />
</div>
</div>
- Add the columns to the query and use the custom parameters to set the values.
| Column | Value |
| ------ | ----- |
| name | `{{parameters.name}}` |
| email | `{{parameters.email}}` |
| contact| `{{parameters.contact}}` |
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{textAlign: 'center'}}>
<img style={{ border:'0', marginBottom:'15px', borderRadius:'5px', boxShadow: '0px 1px 3px rgba(0, 0, 0, 0.2)' }} className="screenshot-full" src="/img/how-to/custom-parameters/params2.png" alt="How to: use custom parameters" />
</div>
</div>
- Finally, execute the query to create a new row in the ToolJetDB table with the values provided in the custom parameters.
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
### Example: Providing Custom Parameters using Events
In this example, we will demonstrate how to use custom parameters in a query by providing values from an event. We will use execute a REST API query and on its success, we will execute the ToolJetDB query to create a new row with the response data.
1. **Create a REST API Query:**
- Method: `GET`
- URL: `https://reqres.in/api/users?page=2`
2. **Add a Success Event:**
- Name: `onSuccess`
- Action: `Run Query`
- Query: `Create Row`
- Parameters: The parameters that you have added to the query will automatically be available in the event.
1. **name:** `{{queries.getSalesData.data.data[0].name}}` This will use the name from the first record of the response data.
2. **email:** `{{queries.getSalesData.data.data[0].email}}` This will use the email from the first record of the response data.
3. **contact:** `4638563845` provided as a constant value just for demonstration.
3. **Execute the REST API query and observe the new row created in the ToolJetDB table.**
**Note:** You can also use parameters in JavaScript queries. Learn more about [JS Query Parameter](/docs/data-sources/run-js/#js-parameters).
<div style={{textAlign: 'center'}}>
<img style={{ border:'0', marginBottom:'15px', borderRadius:'5px', boxShadow: '0px 1px 3px rgba(0, 0, 0, 0.2)' }} className="screenshot-full" src="/img/how-to/custom-parameters/custompara.gif" alt="How to: use custom parameters" />
</div>
</div>