mirror of
https://github.com/ToolJet/ToolJet
synced 2026-05-24 09:28:31 +00:00
[docs]: Remove breaking relative links (#11326)
* docs: remove relative links * removed all the relative links * remove relative links * docs: add new tags to CYT --------- Co-authored-by: Aman Regu <amanregu@gmail.com>
This commit is contained in:
Pratik Agrawal
GitHub
parent
419732d16a
commit
ca809960db
76 changed files with 191 additions and 187 deletions
|
|
@ -15,13 +15,13 @@ Getting started is straightforward – design your interface, connect your data
|
|||
|
||||
Explore these hands-on guides to start building your first app. The step-by-step guides will walk you through the App-Builder's essential features:
|
||||
|
||||
- **[Create UIs Using Pre-Built Components](../app-builder/walkthrough/create-ui)**
|
||||
- **[Create Queries to Interact With Data Sources](../app-builder/walkthrough/create-queries)**
|
||||
- **[Use Custom Code](../app-builder/walkthrough/using-code)**
|
||||
- **[Access and Referring Values Withing The App-Builder](../app-builder/walkthrough/accessing-values)**
|
||||
- **[Create and Managing Variables](../app-builder/walkthrough/variables)**
|
||||
- **[Use Gitsync to Sync your Application with a Git Repository](../gitsync)**
|
||||
- **[Versioning and Release](../tutorial/versioning-and-release)**
|
||||
- **[Import and Export Apps](../app-builder/importing-exporting-applications)**
|
||||
- **[Create UIs Using Pre-Built Components](/docs/app-builder/walkthrough/create-ui)**
|
||||
- **[Create Queries to Interact With Data Sources](/docs/app-builder/walkthrough/create-queries)**
|
||||
- **[Use Custom Code](/docs/app-builder/walkthrough/using-code)**
|
||||
- **[Access and Referring Values Withing The App-Builder](/docs/app-builder/walkthrough/accessing-values)**
|
||||
- **[Create and Managing Variables](/docs/app-builder/walkthrough/variables)**
|
||||
- **[Use Gitsync to Sync your Application with a Git Repository](/docs/gitsync)**
|
||||
- **[Versioning and Release](/docs/tutorial/versioning-and-release)**
|
||||
- **[Import and Export Apps](/docs/app-builder/walkthrough/importing-exporting-applications)**
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: query-panel
|
|||
title: Query Panel
|
||||
---
|
||||
|
||||
The Query Panel, located at the bottom of the app-builder, allows you to create and manage queries to interact with connected **data sources**. It provides the capability to perform API requests, query **[databases](../data-sources/overview)**, and apply **[transformations](../tutorial/transformations)** or data manipulation using **[JavaScript](../data-sources/run-js)** and **[Python](../data-sources/run-py)**.
|
||||
The Query Panel, located at the bottom of the app-builder, allows you to create and manage queries to interact with connected **data sources**. It provides the capability to perform API requests, query **[databases](/docs/data-sources/overview)**, and apply **[transformations](/docs/tutorial/transformations)** or data manipulation using **[JavaScript](/docs/data-sources/run-js)** and **[Python](/docs/data-sources/run-py)**.
|
||||
|
||||
The Query Panel consists of two sections:
|
||||
- The **[Query Manager](#query-manager)** on the left side, which displays a list of all the created queries.
|
||||
|
|
@ -72,7 +72,7 @@ For each parameter, you need to specify:
|
|||
|
||||
**Syntax for utilizing the parameter:** Employ `parameters.<identifier>` in your query. It's important to note that parameters can only be utilized within the specific query where they are defined.
|
||||
|
||||
Learn more about **[Using Custom Parameters](../how-to/use-custom-parameters)**.
|
||||
Learn more about **[Using Custom Parameters](/docs/how-to/use-custom-parameters)**.
|
||||
|
||||
<img className="screenshot-full" src="/img/v2-beta/app-builder/querypanel/newui3/queryparams-v2.png" alt="Custom Parameters" style={{marginBottom:'15px'}}/>
|
||||
|
||||
|
|
@ -111,7 +111,7 @@ In cases where multiple data sources of the same type are connected, easily swit
|
|||
|
||||
### Transformation
|
||||
|
||||
Queries can be enhanced with transformations to modify the query results. ToolJet supports transformations using two programming languages: JavaScript & Python. Refer to the detailed documentation on **[Transformations](../tutorial/transformations)** for more information.
|
||||
Queries can be enhanced with transformations to modify the query results. ToolJet supports transformations using two programming languages: JavaScript & Python. Refer to the detailed documentation on **[Transformations](/docs/tutorial/transformations)** for more information.
|
||||
|
||||
<img className="screenshot-full" src="/img/v2-beta/app-builder/querypanel/newui2/transform-v2.png" alt="Query Editor" style={{marginBottom:'15px'}}/>
|
||||
|
||||
|
|
@ -144,7 +144,7 @@ The Result:
|
|||
- The component displaying the to-do data will be update with the lates data.
|
||||
|
||||
:::info
|
||||
Learn more about [Event Handlers and Actions](../widgets/overview#component-event-handlers).
|
||||
Learn more about [Event Handlers and Actions](/docs/widgets/overview#component-event-handlers).
|
||||
:::
|
||||
|
||||
<img className="screenshot-full" src="/img/v2-beta/app-builder/querypanel/newui2/events-v2.png" alt="Query Editor" />
|
||||
|
|
|
|||
|
|
@ -35,6 +35,6 @@ The quality of our documentation isn't just determined by how well it's written
|
|||
|
||||
## Next Steps...
|
||||
|
||||
Once you've set up your local environment, take some time to explore our [Style Guide](style-guide.md), understand our page structures, and learn how to work with Docusaurus, the framework we use for our documentation.
|
||||
Once you've set up your local environment, take some time to explore our [Style Guide](/docs/contributing-guide/documentation-guidelines/style-guide), understand our page structures, and learn how to work with Docusaurus, the framework we use for our documentation.
|
||||
|
||||
We look forward to your contributions and are excited to see how you'll help make ToolJet documentation even better!
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ The following guide is intended for contributors to set up ToolJet locally. If y
|
|||
|
||||
Docker Compose is the easiest way to set up the ToolJet server and client locally.
|
||||
|
||||
*If you just want to try out ToolJet locally with docker, you can follow the steps [here](https://docs.tooljet.com/docs/setup/try-tooljet).*
|
||||
*If you just want to try out ToolJet locally with docker, you can follow the steps [here](/docs/setup/try-tooljet).*
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
|
|||
|
|
@ -19,6 +19,6 @@ For Docker setups on Mac systems, it's advisable to use a machine with 16GB RAM
|
|||
|
||||
## Bare-Metal Setup
|
||||
|
||||
For those who prefer a [bare-metal](https://docs.tooljet.com/docs/contributing-guide/setup/docker) setup over Docker, a minimum of 8GB RAM is recommended for smooth operation.
|
||||
For those who prefer a [bare-metal](/docs/contributing-guide/setup/docker) setup over Docker, a minimum of 8GB RAM is recommended for smooth operation.
|
||||
|
||||
Before initiating the installation process, please verify that your system meets these specified requirements. It's essential to customize server specifications based on the unique demands of your deployment scenario.
|
||||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to appwrite database to read/write data.
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Appwrite data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](https://docs.tooljet.com/docs/data-sources/overview)** page from the ToolJet dashboard.
|
||||
To establish a connection with the Appwrite data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview)** page from the ToolJet dashboard.
|
||||
|
||||
ToolJet requires the following to connect to your Appwrite:
|
||||
- **Host (API endpoint)**
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to **Amazon Athena** which is an interactive query service t
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the **Amazon Athena** data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](https://docs.tooljet.com/docs/data-sources/overview)** page from the ToolJet dashboard and choose **Amazon Athena** as the data source.
|
||||
To establish a connection with the **Amazon Athena** data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview)** page from the ToolJet dashboard and choose **Amazon Athena** as the data source.
|
||||
|
||||
ToolJet requires the following to connect to your Athena.
|
||||
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ This ID will be longer than the one generated earlier, and it could look like "2
|
|||
:::tip Resources
|
||||
- You can also write custom JavaScript code to get the data from **External APIs** and manipulate the response for graphical representation. Here's the [tutorial](https://blog.tooljet.com/build-github-stars-history-app-in-5-minutes-using-low-code/) on how we used custom JavaScript code to build an app using GitHub API.
|
||||
- [Import external libraries](/docs/how-to/import-external-libraries-using-runjs) using RunJS.
|
||||
- [Intentionally Fail](docs/how-to/intentionally-fail-js-query) a RunJS query.
|
||||
- [Intentionally Fail](/docs/how-to/intentionally-fail-js-query) a RunJS query.
|
||||
- [Trigger query at specified intervals](/docs/how-to/run-query-at-specified-intervals) using RunJS.
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The Mailgun API Datasource supports for interaction with the mail endpoint of th
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the **Mailgun** data source, click on the **+ Add new data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the **Mailgun** data source, click on the **+ Add new data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
ToolJet requires the following to connect to your Mailgun:
|
||||
- **API key**
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can trigger n8n workflows using webhook URLs. Please refer [this](https:
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the n8n data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the n8n data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
Webhooks in n8n can be configured to operate with or without **Authentication**. If no authentication is required, select `None` as the **Authentication type**. For webhooks that require authentication, choose the appropriate method from the dropdown and provide the corresponding credentials.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to a Notion workspace to do operations on notion pages, data
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Notion data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the Notion data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
For integrating Notion with ToolJet we will need the API token. The API token can be generated from your Notion workspace settings. Read the official Notion docs for [Creating an internal integration with notion API](https://www.notion.so/help/create-integrations-with-the-notion-api).
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ ToolJet requires the following to connect to a REST API data source:
|
|||
### Authentication
|
||||
|
||||
:::info
|
||||
For a detailed explanation of the authentication types supported by REST API data sources, refer to the **[Authentication](./authentication)** section.
|
||||
For a detailed explanation of the authentication types supported by REST API data sources, refer to the **[Authentication](/docs/data-sources/restapi/authentication)** section.
|
||||
:::
|
||||
|
||||
ToolJet supports the following authentication types for REST API data sources:
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Pinecone
|
|||
ToolJet integrates with Pinecone to utilize its vector database capabilities. This integration enables ToolJet to perform vector operations such as updating, querying, and managing vector embeddings in Pinecone indexes.
|
||||
|
||||
:::note
|
||||
Before following this guide, it is assumed that you have already completed the process of **[Using Marketplace plugins](../marketplace-overview#using-marketplace-plugins)**.
|
||||
Before following this guide, it is assumed that you have already completed the process of **[Using Marketplace plugins](/docs/marketplace/marketplace-overview#using-marketplace-plugins)**.
|
||||
:::
|
||||
|
||||
## Connection
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ ToolJet has three default user roles, each with different levels of access:
|
|||
- **Custom Groups**: Can be created to assign specific permissions to sets of users.
|
||||
|
||||
:::info
|
||||
For detailed information on Users and Groups, refer to the [Managing Users and Groups](../tutorial/manage-users-groups.md) documentation.
|
||||
For detailed information on Users and Groups, refer to the [Managing Users and Groups](/docs/tutorial/manage-users-groups) documentation.
|
||||
:::
|
||||
|
||||
## Permission Levels
|
||||
|
|
|
|||
|
|
@ -12,29 +12,29 @@ This document outlines the key improvements introduced in ToolJet 3.0, a major u
|
|||
1. Up to 10 times faster app loading speeds
|
||||
2. Smooth app development even with 1000s of components and 100s of queries
|
||||
2. More intuitive experience in designing applications on the canvas with the new grid system
|
||||
4. Highly configurable **[page management system](../tutorial/pages)**
|
||||
5. Revamped **[components](../widgets/table/table-properties/)** with more styling and functionality customizations
|
||||
6. Enhanced developer experience in managing queries with the **[new query manager UI](../app-builder/query-panel)**
|
||||
4. Highly configurable **[page management system](/docs/tutorial/pages)**
|
||||
5. Revamped **[components](/docs/widgets/table/table-properties/)** with more styling and functionality customizations
|
||||
6. Enhanced developer experience in managing queries with the **[new query manager UI](/docs/app-builder/query-panel)**
|
||||
7. Improved coding experience with better code suggestions, linting, and type-casting
|
||||
8. Better debugging with easy-to-understand error messages
|
||||
9. Theme settings: Light/dark/auto mode at the application level
|
||||
|
||||
## Platform Enhancements
|
||||
|
||||
1. **[Group Sync OIDC](../user-authentication/sso/oidc/)**: Easily manage user access to ToolJet applications from your Identity Provider (IDP) directly
|
||||
2. **[Secrets constants](../org-management/workspaces/workspace_constants/#using-secrets)**: Ability to store encrypted credentials
|
||||
3. **[User metadata](../tutorial/manage-users-groups/#user-metadata)**: Store custom metadata with user details & access them while building applications
|
||||
1. **[Group Sync OIDC](/docs/user-authentication/sso/oidc/)**: Easily manage user access to ToolJet applications from your Identity Provider (IDP) directly
|
||||
2. **[Secrets constants](/docs/org-management/workspaces/workspace_constants/#using-secrets)**: Ability to store encrypted credentials
|
||||
3. **[User metadata](/docs/tutorial/manage-users-groups/#user-metadata)**: Store custom metadata with user details & access them while building applications
|
||||
4. User roles: Revamped user groups with granular access control
|
||||
5. **[User APIs](../tutorial/tooljet-api/#get-all-users)**: External API for creating and managing users
|
||||
5. **[User APIs](/docs/tutorial/tooljet-api/#get-all-users)**: External API for creating and managing users
|
||||
6. Security fixes: Various improvements to enhance platform security
|
||||
|
||||
## ToolJet Database (TJ DB)
|
||||
|
||||
1. **[Custom primary key](../tooljet-db/database-editor/#primary-key)** and **[foreign key support](../tooljet-db/database-editor/#foreign-key)**
|
||||
1. **[Custom primary key](/docs/tooljet-db/database-editor/#primary-key)** and **[foreign key support](/docs/tooljet-db/database-editor/#foreign-key)**
|
||||
2. Support for more data types for advanced use cases
|
||||
3. **[SQL mode](../tooljet-db/querying-tooljet-db#sql-editor)** for complex querying
|
||||
3. **[SQL mode](/docs/tooljet-db/querying-tooljet-db#sql-editor)** for complex querying
|
||||
4. Bulk upload using CSV
|
||||
5. GUI for **[complex SQL queries](../tooljet-db/querying-tooljet-db#gui-mode)** like joins, aggregates, and group by
|
||||
5. GUI for **[complex SQL queries](/docs/tooljet-db/querying-tooljet-db#gui-mode)** like joins, aggregates, and group by
|
||||
|
||||
## Integrations
|
||||
|
||||
|
|
@ -50,21 +50,21 @@ This document outlines the key improvements introduced in ToolJet 3.0, a major u
|
|||
|
||||
## AI Apps
|
||||
|
||||
Build AI apps using **[OpenAI](../marketplace/plugins/marketplace-plugin-openai)**, and **[Portkey](../marketplace/plugins/marketplace-plugin-portkey)** integrations
|
||||
Build AI apps using **[OpenAI](/docs/marketplace/plugins/marketplace-plugin-openai)**, and **[Portkey](/docs/marketplace/plugins/marketplace-plugin-portkey)** integrations
|
||||
|
||||
## Workflows
|
||||
|
||||
1. Introduction of **[loop node](../workflows/nodes#loop-node)** to implement iterative processes
|
||||
1. Introduction of **[loop node](/docs/workflows/nodes#loop-node)** to implement iterative processes
|
||||
2. Improved error handling and debugger: Improved troubleshooting
|
||||
3. Support for multiple deployment environments
|
||||
4. **[Webhook triggers](../workflows/workflow-triggers#webhooks)** to trigger workflows from external apps and services
|
||||
5. **[Multiple result nodes](../workflows/results)** for greater flexibility in defining the output
|
||||
4. **[Webhook triggers](/docs/workflows/workflow-triggers#webhooks)** to trigger workflows from external apps and services
|
||||
5. **[Multiple result nodes](/docs/workflows/results)** for greater flexibility in defining the output
|
||||
|
||||
## Migration Steps
|
||||
|
||||
Ready to upgrade to ToolJet 3.0? Follow our migration guides:
|
||||
- **[For Self-Hosted Users](../setup/upgrade-to-v3)**
|
||||
- **[For Cloud Users](../setup/cloud-v3-migration)**
|
||||
- **[For Self-Hosted Users](/docs/setup/upgrade-to-v3)**
|
||||
- **[For Cloud Users](/docs/setup/cloud-v3-migration)**
|
||||
|
||||
This release significantly enhances ToolJet's capabilities across its platform, focusing on improved performance, expanded integrations, and smoother development experience for building complex applications. The addition of AI-powered features and the release of Workflows provide users with advanced tools for creating sophisticated, automated solutions.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,6 +15,9 @@ Please find the latest LTS version here: <br/>
|
|||
| Version | Release Date | Docker Pull Command |
|
||||
|---------|--------------|----------------------|
|
||||
| Latest EE-LTS | N/A | `docker pull tooljet/tooljet:ee-lts-latest` |
|
||||
| [v3.0.2-ee-lts](https://hub.docker.com/layers/tooljet/tooljet/v3.0.2-ee-lts/images/sha256-6cb558e5e3337c7fc1b9ffc830ce7096f19253ff5f2fad177afdb46fb0b0ea9d?context=explore) | November 13, 2024 | `docker pull tooljet/tooljet:v3.0.2-ee-lts` |
|
||||
| [v3.0.1-ee-lts](https://hub.docker.com/layers/tooljet/tooljet/v3.0.1-ee-lts/images/sha256-b4f2e0779f76db07606ddd8a688cb7e06824837be3f507026ff91bb235efcc1d?context=explore) | November 12, 2024 | `docker pull tooljet/tooljet:v3.0.1-ee-lts` |
|
||||
| [v3.0.0-ee-lts](https://hub.docker.com/layers/tooljet/tooljet/v3.0.0-ee-lts/images/sha256-989f1370c502e97555dd7e669f896ef6ba2ad1d4f317c53335105bf937b5b189?context=explore) | November 12, 2024 | `docker pull tooljet/tooljet:v3.0.0-ee-lts` |
|
||||
| [EE-LTS-2.50.9.45](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.45/images/sha256-cb0030d66415ac52d156608fee2de8ce400cd4b2a7b3f865be331d13d939c883?context=explore) | October 24, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.45` |
|
||||
| [EE-LTS-2.50.9.44](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.44/images/sha256-739781626ba3b7a61890d5e6b633099fee12e0e14aa3d176ceafe102f4b4ca98?context=explore) | October 9, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.44` |
|
||||
| [EE-LTS-2.50.9.43](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.43/images/sha256-5d1cdd349872279ff23da9332dc0ec71c4ad637b35b728c44211f21fd206fa1c?context=explore) | October 3, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.43` |
|
||||
|
|
@ -28,9 +31,6 @@ Please find the latest LTS version here: <br/>
|
|||
| [EE-LTS-2.50.9.35](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.35/images/sha256-8a1b0014d470aff108ad75fd6982e01696740f2154a3bb49f08671b93d55485b?context=explore) | September 3, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.35` |
|
||||
| [EE-LTS-2.50.9.34](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.34/images/sha256-95af52997ec5b42fd5435bfef2f8996d0acc8234ae0541e155705ea4c689b272?context=explore) | August 30, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.34` |
|
||||
| [EE-LTS-2.50.9.33](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.33/images/sha256-e231b959a7e5e1455235d344ceffeaa34b482d925d9676e5169f58e966c59fbb?context=explore) | August 26, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.33` |
|
||||
| [EE-LTS-2.50.9.32](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.32/images/sha256-e231b959a7e5e1455235d344ceffeaa34b482d925d9676e5169f58e966c59fbb?context=explore) | August 26, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.32` |
|
||||
| [EE-LTS-2.50.9.31](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.31/images/sha256-9610b8a125ea622a4b07c17657c44e04e1b582df8a18c228bab3a876cdc49407?context=explore) | August 26, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.31` |
|
||||
| [EE-LTS-2.50.9.30](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.30/images/sha256-a7b0967aca4c4d29e423a78e91a7084073e2750d0a67fa2a8926d0da5eaf4ad4?context=explore) | August 21, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.30` |
|
||||
|
||||
:::info
|
||||
Users are encouraged to upgrade to the latest LTS version to ensure they benefit from the latest improvements and maintain a secure and efficient environment.
|
||||
|
|
|
|||
|
|
@ -174,7 +174,7 @@ After November 11th, applications with the old Kanban Board component will crash
|
|||
|
||||
Workspace Constants are designed to be resolved on the server-side only, ensuring a high level of security. You can assign users to a specific role and provide create, update, and delete access to Workspace Constants.
|
||||
|
||||
For detailed instructions on migrating from Workspace Variables to Workspace Constants, please refer to our [Workspace Variables Migration Guide](../org-management/workspaces/workspace-variables-migration).
|
||||
For detailed instructions on migrating from Workspace Variables to Workspace Constants, please refer to our [Workspace Variables Migration Guide](/docs/org-management/workspaces/workspace-variables-migration).
|
||||
|
||||
|
||||
## Response Headers and Metadata
|
||||
|
|
@ -196,7 +196,7 @@ Now, you should use:
|
|||
{{queries.<queryName>.metadata}}
|
||||
```
|
||||
|
||||
The `metadata` object will contain detailed information about the request and response, including request URL, method, headers, parameters, response status code, and headers. You can read more about metadata [here](../data-sources/restapi/metadata-and-cookies/#metadata).
|
||||
The `metadata` object will contain detailed information about the request and response, including request URL, method, headers, parameters, response status code, and headers. You can read more about metadata [here](/docs/data-sources/restapi/metadata-and-cookies/#metadata).
|
||||
|
||||
## Help and Support
|
||||
|
||||
|
|
|
|||
|
|
@ -151,7 +151,7 @@ Please note the subpath is to be set with trailing `/` and is applicable only wh
|
|||
|
||||
ToolJet uses SMTP services to send emails (e.g., invitation emails when you add new users to your workspace).
|
||||
|
||||
For Enterprise Edition, you must configure SMTP settings through the user interface (UI) in the ToolJet Settings. For more information, see [SMTP Configuration](../org-management/smtp-configuration.md).
|
||||
For Enterprise Edition, you must configure SMTP settings through the user interface (UI) in the ToolJet Settings. For more information, see [SMTP Configuration](/docs/org-management/smtp-configuration).
|
||||
|
||||
:::info
|
||||
If you have upgraded from a version prior to v2.62.0, the SMTP variables in your .env file will automatically be mapped to the UI.
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ Once the Service is created and live, to make the Cloud Service URL public. Ple
|
|||
## Deploying ToolJet Database
|
||||
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly:
|
||||
- [Self Hosted](./upgrade-to-v3.md)
|
||||
- [Self Hosted](/docs/setup/upgrade-to-v3)
|
||||
|
||||
1. Cloud Run requires prebuilt image to be present within cloud registry. You can pull specific PostgREST image from docker hub and then tag with your project to push it to cloud registry.
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ You'll need to setup the following environment variables if ToolJet installation
|
|||
|
||||
|
||||
:::info
|
||||
See all **[Environment Variables](./env-vars)** here.
|
||||
See all **[Environment Variables](/docs/setup/env-var)** here.
|
||||
:::
|
||||
|
||||
## Upgrading to the Latest Version
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ docker run \
|
|||
|
||||
- Runs the ToolJet server on the port 80 on your machine.
|
||||
- Container has postgres already configured within. All the data will be available in the docker volume `tooljet_data`.
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](./env-vars).
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](/docs/setup/env-vars).
|
||||
- Use `docker stop tooljet` to stop the container and `docker start tooljet` to start the container thereafter.
|
||||
|
||||
#### Dynamic Port Setup
|
||||
|
|
|
|||
|
|
@ -20,14 +20,15 @@ ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life
|
|||
|
||||
The upgrade process depends on your deployment method. You can follow the upgrade process under the respective setup guides:
|
||||
|
||||
- [Upgrade ToolJet on DigitalOcean](../digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](../docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](../ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](../ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](../openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](../helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](../kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](../kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](../kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](../azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](../google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on DigitalOcean](/docs/setup/digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](/docs/setup/docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](/docs/setup/ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](/docs/setup/ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](/docs/setup/openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](/docs/setup/helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](/docs/setup/kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](/docs/setup/kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](/docs/setup/kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](/docs/setup/azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](/docs/setup/google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ ToolJet Database supports several data types to accommodate various kinds of inf
|
|||
|
||||
## Permissible Constraints per Data Type
|
||||
|
||||
The following table shows which constraints are permissible for each data type. For more detailed explanations of each constraint type, please refer to the [Column Constraints](./database-editor#column-constraints) section.
|
||||
The following table shows which constraints are permissible for each data type. For more detailed explanations of each constraint type, please refer to the [Column Constraints](/docs/tooljet-db/database-editor#column-constraints) section.
|
||||
|
||||
| Data Type | Primary Key | Foreign Key | Unique | Not Null |
|
||||
|:-----------:|:--------------:|:-------------:|:--------:|:----------:|
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ To create a new table in the ToolJet Database:
|
|||
| **Option** | **Description** |
|
||||
| --- | --- |
|
||||
| **Column name** | Enter a unique name for the column. |
|
||||
| **Data type** | Select the appropriate data type for the column from the dropdown menu. For more information on available data types, see the [Supported Data Types](./data-types#supported-data-types) section. |
|
||||
| **Data type** | Select the appropriate data type for the column from the dropdown menu. For more information on available data types, see the [Supported Data Types](/docs/tooljet-db/data-types#supported-data-types) section. |
|
||||
| **Default value (optional)** | Specify any default value to be assigned to the column. If left blank, the column will allow null values. |
|
||||
| **Primary Key** | Check this box to designate the column as the [Primary Key](#primary-key). Multiple columns can be selected, creating a composite primary key. |
|
||||
| **NULL/NOT NULL toggle** | Use this toggle to determine whether the column should allow null values or require a value. By default, null values are permitted. |
|
||||
|
|
@ -60,7 +60,7 @@ ToolJet Database supports several column constraints to maintain data integrity
|
|||
|
||||
**Not Null**: The not null constraint ensures that the designated column(s) cannot have null values, requiring a value for every row in the table.
|
||||
|
||||
For a detailed overview of which constraints are allowed for each data type, refer to the [Permissible Constraints per Data Type](./data-types#permissible-constraints-per-data-type) table.
|
||||
For a detailed overview of which constraints are allowed for each data type, refer to the [Permissible Constraints per Data Type](/docs/tooljet-db/data-types#permissible-constraints-per-data-type) table.
|
||||
|
||||
## Primary Key
|
||||
|
||||
|
|
@ -281,7 +281,7 @@ To add a new column to a table, either click on the kebab menu icon on the right
|
|||
A drawer from the right will open up where you can enter the details for the new column:
|
||||
|
||||
- **Column Name**: Enter a unique name for the new column, serving as its key identifier.
|
||||
- **Data Type**: Choose the appropriate data type for the column from the [available options](./data-types#supported-data-types). For more information on data types and their associated constraints, see the [Supported Data Types](./data-types#supported-data-types) and [Permissible Constraints per Data Type](./data-types#permissible-constraints-per-data-type) sections.
|
||||
- **Data Type**: Choose the appropriate data type for the column from the [available options](/docs/tooljet-db/data-types#supported-data-types). For more information on data types and their associated constraints, see the [Supported Data Types](/docs/tooljet-db/data-types#supported-data-types) and [Permissible Constraints per Data Type](/docs/tooljet-db/data-types#permissible-constraints-per-data-type) sections.
|
||||
- **Default Value**: Specify any default value that should be assigned to the column. Optionally, users can leave this field blank. When a table contains rows and NOT NULL is applied to one of its existing or new columns, specifying a default value becomes compulsory.
|
||||
- **Foreign Key Relation**: Click on the toggle to add a foreign key relationship to the column. This will open a menu where you can select the target table and column to reference.
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,8 @@ You will be redirected to the visual app editor once the app has been created. C
|
|||
</div>
|
||||
|
||||
The main components of an app:
|
||||
an app:
|
||||
|
||||
- **[Widgets](https://docs.tooljet.com/docs/tutorial/adding-widget)** - UI components such as tables, buttons, dropdowns.
|
||||
- **[Data sources](https://docs.tooljet.com/docs/tutorial/adding-a-datasource)** - ToolJet can connect to databases, APIs and external services to fetch and modify data.
|
||||
- **[Queries](https://docs.tooljet.com/docs/tutorial/building-queries)** - Queries are used to access the connected data sources.
|
||||
- **[Widgets](/docs/tutorial/adding-widget)** - UI components such as tables, buttons, dropdowns.
|
||||
- **[Data sources](/docs/tutorial/adding-a-datasource)** - ToolJet can connect to databases, APIs and external services to fetch and modify data.
|
||||
- **[Queries](/docs/tutorial/building-queries)** - Queries are used to access the connected data sources.
|
||||
|
|
@ -5,7 +5,7 @@ title: Managing Users and Groups
|
|||
|
||||
# Managing Users and Groups
|
||||
|
||||
This guide explains how to manage users and groups in ToolJet. For an overview of the permission system, please refer to the [Permissions](../org-management/permissions.md) documentation.
|
||||
This guide explains how to manage users and groups in ToolJet. For an overview of the permission system, please refer to the [Permissions](/docs/org-management/permissions) documentation.
|
||||
|
||||
## Managing Users Across Workspaces
|
||||
|
||||
|
|
@ -160,7 +160,7 @@ Admins of a workspace can create custom groups to manage permissions. To create
|
|||
### Modifying Group Permissions
|
||||
|
||||
:::info
|
||||
For detailed information on permissions, refer to the [Permissions](../org-management/permissions.md) documentation.
|
||||
For detailed information on permissions, refer to the [Permissions](/docs/org-management/permissions) documentation.
|
||||
:::
|
||||
|
||||
When changing permissions for a custom group:
|
||||
|
|
|
|||
|
|
@ -89,9 +89,9 @@ The duplicate page option allows you to create and add a copy of the page in the
|
|||
|
||||
Like other ToolJet components, pages can also be attached to event handlers. For pages, the **On page load** event is available. You can use all the available actions for this event, along with the new actions added specifically for Pages.
|
||||
|
||||
- **[Switch Page](../actions/switch-page)**
|
||||
- **[Set Page Variable](../actions/set-page-variable)**
|
||||
- **[Unset Page Variable](../actions/unset-page-variable)**
|
||||
- **[Switch Page](/docs/actions/switch-page)**
|
||||
- **[Set Page Variable](/docs/actions/set-page-variable)**
|
||||
- **[Unset Page Variable](/docs/actions/unset-page-variable)**
|
||||
|
||||
### Disable Page
|
||||
|
||||
|
|
@ -114,6 +114,6 @@ You can **delete** a page from an application using this option. <br/>
|
|||
| handle | The handle represents the slug of the page within an app. In the URL `https://app.tooljet.com/applications/crm2/home`, **crm2** refers to the app name, and **home** corresponds to the handle. The handle is automatically set when a page is added, and you can also [rename](#rename) the handle from the Page options. To access the value of the handle variable dynamically, use `{{page.handle}}`|
|
||||
| name | The name indicates the name of the page set during its creation. To access the value of the name variable dynamically, use `{{page.name}}` |
|
||||
| id | Each page in the ToolJet app receives a unique identifier upon creation. To access the value of the id dynamically, use `{{page.id}}` |
|
||||
| variables | Variables is an object that contains all the variables created for a specific page using the [Set Page Variable](../actions/set-page-variable) action. The value of a specific variable can be accessed dynamically using `{{page.variables.<pageVariableName>}}`, where `<pageVariableName>` refers to the variable created for that page using the Set Page variable action. |
|
||||
| variables | Variables is an object that contains all the variables created for a specific page using the [Set Page Variable](/docs/actions/set-page-variable) action. The value of a specific variable can be accessed dynamically using `{{page.variables.<pageVariableName>}}`, where `<pageVariableName>` refers to the variable created for that page using the Set Page variable action. |
|
||||
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -31,10 +31,10 @@ Server-side operations refer to tasks executed on the server, such as data fetch
|
|||
|
||||
Following server side operations can be performed on a Table in ToolJet:
|
||||
|
||||
- [Search](./search.md)
|
||||
- [Sort](./sort.md)
|
||||
- [Filter](./filter.md)
|
||||
- [Pagination](./pagination.md)
|
||||
- [Search](/docs/widgets/table/serverside-operations/search/)
|
||||
- [Sort](/docs/widgets/table/serverside-operations/sort/)
|
||||
- [Filter](/docs/widgets/table/serverside-operations/filter/)
|
||||
- [Pagination](/docs/widgets/table/serverside-operations/pagination/)
|
||||
|
||||
<img className="screenshot-full" src="/img/widgets/table/serverside-operations/serverside-operations.png" alt="Serverside Operations Present for Table Component in ToolJet" />
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The **Toggle Switch** component can be used for binary choices, such as turning
|
|||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
:::info
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/2.43.0/widgets/toggle-switch)** document.
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/widgets/toggle-switch)** document.
|
||||
:::
|
||||
|
||||
## Properties
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The **Toggle Switch** component can be used for binary choices, such as turning
|
|||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
:::info
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/2.43.0/widgets/toggle-switch)** document.
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/widgets/toggle-switch)** document.
|
||||
:::
|
||||
|
||||
## Properties
|
||||
|
|
|
|||
|
|
@ -35,6 +35,6 @@ The quality of our documentation isn't just determined by how well it's written
|
|||
|
||||
## Next Steps...
|
||||
|
||||
Once you've set up your local environment, take some time to explore our [Style Guide](style-guide.md), understand our page structures, and learn how to work with Docusaurus, the framework we use for our documentation.
|
||||
Once you've set up your local environment, take some time to explore our [Style Guide](/docs/contributing-guide/documentation-guidelines/style-guide), understand our page structures, and learn how to work with Docusaurus, the framework we use for our documentation.
|
||||
|
||||
We look forward to your contributions and are excited to see how you'll help make ToolJet documentation even better!
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ The following guide is intended for contributors to set up ToolJet locally. If y
|
|||
|
||||
Docker Compose is the easiest way to set up the ToolJet server and client locally.
|
||||
|
||||
*If you just want to try out ToolJet locally with docker, you can follow the steps [here](https://docs.tooljet.com/docs/setup/try-tooljet).*
|
||||
*If you just want to try out ToolJet locally with docker, you can follow the steps [here](/docs/setup/try-tooljet).*
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
|
|||
|
|
@ -19,6 +19,6 @@ For Docker setups on Mac systems, it's advisable to use a machine with 16GB RAM
|
|||
|
||||
## Bare-Metal Setup
|
||||
|
||||
For those who prefer a [bare-metal](https://docs.tooljet.com/docs/contributing-guide/setup/docker) setup over Docker, a minimum of 8GB RAM is recommended for smooth operation.
|
||||
For those who prefer a [bare-metal](/docs/contributing-guide/setup/docker) setup over Docker, a minimum of 8GB RAM is recommended for smooth operation.
|
||||
|
||||
Before initiating the installation process, please verify that your system meets these specified requirements. It's essential to customize server specifications based on the unique demands of your deployment scenario.
|
||||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to **Amazon Athena** which is an interactive query service t
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the **Amazon Athena** data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](https://docs.tooljet.com/docs/data-sources/overview)** page from the ToolJet dashboard and choose **Amazon Athena** as the data source.
|
||||
To establish a connection with the **Amazon Athena** data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview)** page from the ToolJet dashboard and choose **Amazon Athena** as the data source.
|
||||
|
||||
ToolJet requires the following to connect to your Athena.
|
||||
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ This ID will be longer than the one generated earlier, and it could look like "2
|
|||
:::tip Resources
|
||||
- You can also write custom JavaScript code to get the data from **External APIs** and manipulate the response for graphical representation. Here's the [tutorial](https://blog.tooljet.com/build-github-stars-history-app-in-5-minutes-using-low-code/) on how we used custom JavaScript code to build an app using GitHub API.
|
||||
- [Import external libraries](/docs/how-to/import-external-libraries-using-runjs) using RunJS.
|
||||
- [Intentionally Fail](docs/how-to/intentionally-fail-js-query) a RunJS query.
|
||||
- [Intentionally Fail](/docs/how-to/intentionally-fail-js-query) a RunJS query.
|
||||
- [Trigger query at specified intervals](/docs/how-to/run-query-at-specified-intervals) using RunJS.
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The Mailgun API Datasource supports for interaction with the mail endpoint of th
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the **Mailgun** data source, click on the **+ Add new data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the **Mailgun** data source, click on the **+ Add new data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
ToolJet requires the following to connect to your Mailgun:
|
||||
- **API key**
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can trigger n8n workflows using webhook URLs. Please refer [this](https:
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the n8n data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the n8n data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
Webhooks in n8n can be configured to operate with or without **Authentication**. If no authentication is required, select `None` as the **Authentication type**. For webhooks that require authentication, choose the appropriate method from the dropdown and provide the corresponding credentials.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to a Notion workspace to do operations on notion pages, data
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Notion data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the Notion data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
For integrating Notion with ToolJet we will need the API token. The API token can be generated from your Notion workspace settings. Read the official Notion docs for [Creating an internal integration with notion API](https://www.notion.so/help/create-integrations-with-the-notion-api).
|
||||
|
||||
|
|
|
|||
|
|
@ -174,7 +174,7 @@ After November 11th, applications with the old Kanban Board component will crash
|
|||
|
||||
Workspace Constants are designed to be resolved on the server-side only, ensuring a high level of security. You can assign users to a specific role and provide create, update, and delete access to Workspace Constants.
|
||||
|
||||
For detailed instructions on migrating from Workspace Variables to Workspace Constants, please refer to our [Workspace Variables Migration Guide](../org-management/workspaces/workspace-variables-migration).
|
||||
For detailed instructions on migrating from Workspace Variables to Workspace Constants, please refer to our [Workspace Variables Migration Guide](/docs/org-management/workspaces/workspace-variables-migration).
|
||||
|
||||
|
||||
## Response Headers and Metadata
|
||||
|
|
|
|||
|
|
@ -113,7 +113,7 @@ To use ToolJet Database, you'd have to set up and deploy PostgREST server which
|
|||
<img className="screenshot-full" src="/img/cloud-run/port-and-capacity-postgrest.png" alt="port-and-capacity-postgrest" />
|
||||
</div>
|
||||
|
||||
5. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](./env-vars/#enable-tooljet-database--optional-).
|
||||
5. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](/docs/setup/env-vars/#enable-tooljet-database--optional-).
|
||||
|
||||
6. Please go to connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up for ToolJet application or the separate PostgreSQL database created respective to ToolJet Database from the drop-down option.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ You'll need to setup the following environment variables if ToolJet installation
|
|||
|
||||
|
||||
:::info
|
||||
See all **[Environment Variables](./env-vars)** here.
|
||||
See all **[Environment Variables](/docs/setup/env-var)** here.
|
||||
:::
|
||||
|
||||
## Upgrading to the Latest Version
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ docker run \
|
|||
|
||||
- Runs the ToolJet server on the port 80 on your machine.
|
||||
- Container has postgres already configured within. All the data will be available in the docker volume `tooljet_data`.
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](./env-vars).
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](/docs/setup/env-vars).
|
||||
- Use `docker stop tooljet` to stop the container and `docker start tooljet` to start the container thereafter.
|
||||
|
||||
#### Dynamic Port Setup
|
||||
|
|
|
|||
|
|
@ -20,14 +20,14 @@ ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life
|
|||
|
||||
The upgrade process depends on your deployment method. You can follow the upgrade process under the respective setup guides:
|
||||
|
||||
- [Upgrade ToolJet on DigitalOcean](../digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](../docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](../ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](../ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](../openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](../helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](../kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](../kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](../kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](../azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](../google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on DigitalOcean](/docs/2.50.0-lts/setup/digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](/docs/2.50.0-lts/setup/docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](/docs/2.50.0-lts/setup/ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](/docs/2.50.0-lts/setup/ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](/docs/2.50.0-lts/setup/openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](/docs/2.50.0-lts/setup/helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](/docs/2.50.0-lts/setup/kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](/docs/2.50.0-lts/setup/kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](/docs/2.50.0-lts/setup/kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](/docs/2.50.0-lts/setup/azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](/docs/2.50.0-lts/setup/google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
|
|
|
|||
|
|
@ -25,7 +25,8 @@ You will be redirected to the visual app editor once the app has been created. C
|
|||
</div>
|
||||
|
||||
The main components of an app:
|
||||
an app:
|
||||
|
||||
- **[Widgets](https://docs.tooljet.com/docs/tutorial/adding-widget)** - UI components such as tables, buttons, dropdowns.
|
||||
- **[Data sources](https://docs.tooljet.com/docs/tutorial/adding-a-datasource)** - ToolJet can connect to databases, APIs and external services to fetch and modify data.
|
||||
- **[Queries](https://docs.tooljet.com/docs/tutorial/building-queries)** - Queries are used to access the connected data sources.
|
||||
- **[Widgets](/docs/tutorial/adding-widget)** - UI components such as tables, buttons, dropdowns.
|
||||
- **[Data sources](/docs/tutorial/adding-a-datasource)** - ToolJet can connect to databases, APIs and external services to fetch and modify data.
|
||||
- **[Queries](/docs/tutorial/building-queries)** - Queries are used to access the connected data sources.
|
||||
|
|
@ -8,7 +8,7 @@ The **Toggle Switch** component can be used for binary choices, such as turning
|
|||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
:::info
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/2.43.0/widgets/toggle-switch)** document.
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/widgets/toggle-switch)** document.
|
||||
:::
|
||||
|
||||
## Properties
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The **Toggle Switch** component can be used for binary choices, such as turning
|
|||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
:::info
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/2.43.0/widgets/toggle-switch)** document.
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/widgets/toggle-switch)** document.
|
||||
:::
|
||||
|
||||
## Properties
|
||||
|
|
|
|||
|
|
@ -15,13 +15,13 @@ Getting started is straightforward – design your interface, connect your data
|
|||
|
||||
Explore these hands-on guides to start building your first app. The step-by-step guides will walk you through the App-Builder's essential features:
|
||||
|
||||
- **[Create UIs Using Pre-Built Components](../app-builder/walkthrough/create-ui)**
|
||||
- **[Create Queries to Interact With Data Sources](../app-builder/walkthrough/create-queries)**
|
||||
- **[Use Custom Code](../app-builder/walkthrough/using-code)**
|
||||
- **[Access and Referring Values Withing The App-Builder](../app-builder/walkthrough/accessing-values)**
|
||||
- **[Create and Managing Variables](../app-builder/walkthrough/variables)**
|
||||
- **[Use Gitsync to Sync your Application with a Git Repository](../gitsync)**
|
||||
- **[Versioning and Release](../tutorial/versioning-and-release)**
|
||||
- **[Import and Export Apps](../app-builder/importing-exporting-applications)**
|
||||
- **[Create UIs Using Pre-Built Components](/docs/app-builder/walkthrough/create-ui)**
|
||||
- **[Create Queries to Interact With Data Sources](/docs/app-builder/walkthrough/create-queries)**
|
||||
- **[Use Custom Code](/docs/app-builder/walkthrough/using-code)**
|
||||
- **[Access and Referring Values Withing The App-Builder](/docs/app-builder/walkthrough/accessing-values)**
|
||||
- **[Create and Managing Variables](/docs/app-builder/walkthrough/variables)**
|
||||
- **[Use Gitsync to Sync your Application with a Git Repository](/docs/gitsync)**
|
||||
- **[Versioning and Release](/docs/tutorial/versioning-and-release)**
|
||||
- **[Import and Export Apps](/docs/app-builder/walkthrough/importing-exporting-applications)**
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: query-panel
|
|||
title: Query Panel
|
||||
---
|
||||
|
||||
The Query Panel, located at the bottom of the app-builder, allows you to create and manage queries to interact with connected **data sources**. It provides the capability to perform API requests, query **[databases](../data-sources/overview)**, and apply **[transformations](../tutorial/transformations)** or data manipulation using **[JavaScript](../data-sources/run-js)** and **[Python](../data-sources/run-py)**.
|
||||
The Query Panel, located at the bottom of the app-builder, allows you to create and manage queries to interact with connected **data sources**. It provides the capability to perform API requests, query **[databases](/docs/data-sources/overview)**, and apply **[transformations](/docs/tutorial/transformations)** or data manipulation using **[JavaScript](/docs/data-sources/run-js)** and **[Python](/docs/data-sources/run-py)**.
|
||||
|
||||
The Query Panel consists of two sections:
|
||||
- The **[Query Manager](#query-manager)** on the left side, which displays a list of all the created queries.
|
||||
|
|
@ -72,7 +72,7 @@ For each parameter, you need to specify:
|
|||
|
||||
**Syntax for utilizing the parameter:** Employ `parameters.<identifier>` in your query. It's important to note that parameters can only be utilized within the specific query where they are defined.
|
||||
|
||||
Learn more about **[Using Custom Parameters](../how-to/use-custom-parameters)**.
|
||||
Learn more about **[Using Custom Parameters](/docs/how-to/use-custom-parameters)**.
|
||||
|
||||
<img className="screenshot-full" src="/img/v2-beta/app-builder/querypanel/newui3/queryparams-v2.png" alt="Custom Parameters" style={{marginBottom:'15px'}}/>
|
||||
|
||||
|
|
@ -111,7 +111,7 @@ In cases where multiple data sources of the same type are connected, easily swit
|
|||
|
||||
### Transformation
|
||||
|
||||
Queries can be enhanced with transformations to modify the query results. ToolJet supports transformations using two programming languages: JavaScript & Python. Refer to the detailed documentation on **[Transformations](../tutorial/transformations)** for more information.
|
||||
Queries can be enhanced with transformations to modify the query results. ToolJet supports transformations using two programming languages: JavaScript & Python. Refer to the detailed documentation on **[Transformations](/docs/tutorial/transformations)** for more information.
|
||||
|
||||
<img className="screenshot-full" src="/img/v2-beta/app-builder/querypanel/newui2/transform-v2.png" alt="Query Editor" style={{marginBottom:'15px'}}/>
|
||||
|
||||
|
|
@ -144,7 +144,7 @@ The Result:
|
|||
- The component displaying the to-do data will be update with the lates data.
|
||||
|
||||
:::info
|
||||
Learn more about [Event Handlers and Actions](../widgets/overview#component-event-handlers).
|
||||
Learn more about [Event Handlers and Actions](/docs/widgets/overview#component-event-handlers).
|
||||
:::
|
||||
|
||||
<img className="screenshot-full" src="/img/v2-beta/app-builder/querypanel/newui2/events-v2.png" alt="Query Editor" />
|
||||
|
|
|
|||
|
|
@ -35,6 +35,6 @@ The quality of our documentation isn't just determined by how well it's written
|
|||
|
||||
## Next Steps...
|
||||
|
||||
Once you've set up your local environment, take some time to explore our [Style Guide](style-guide.md), understand our page structures, and learn how to work with Docusaurus, the framework we use for our documentation.
|
||||
Once you've set up your local environment, take some time to explore our [Style Guide](/docs/contributing-guide/documentation-guidelines/style-guide), understand our page structures, and learn how to work with Docusaurus, the framework we use for our documentation.
|
||||
|
||||
We look forward to your contributions and are excited to see how you'll help make ToolJet documentation even better!
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ The following guide is intended for contributors to set up ToolJet locally. If y
|
|||
|
||||
Docker Compose is the easiest way to set up the ToolJet server and client locally.
|
||||
|
||||
*If you just want to try out ToolJet locally with docker, you can follow the steps [here](https://docs.tooljet.com/docs/setup/try-tooljet).*
|
||||
*If you just want to try out ToolJet locally with docker, you can follow the steps [here](/docs/setup/try-tooljet).*
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
|
|||
|
|
@ -19,6 +19,6 @@ For Docker setups on Mac systems, it's advisable to use a machine with 16GB RAM
|
|||
|
||||
## Bare-Metal Setup
|
||||
|
||||
For those who prefer a [bare-metal](https://docs.tooljet.com/docs/contributing-guide/setup/docker) setup over Docker, a minimum of 8GB RAM is recommended for smooth operation.
|
||||
For those who prefer a [bare-metal](/docs/contributing-guide/setup/docker) setup over Docker, a minimum of 8GB RAM is recommended for smooth operation.
|
||||
|
||||
Before initiating the installation process, please verify that your system meets these specified requirements. It's essential to customize server specifications based on the unique demands of your deployment scenario.
|
||||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to appwrite database to read/write data.
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Appwrite data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](https://docs.tooljet.com/docs/data-sources/overview)** page from the ToolJet dashboard.
|
||||
To establish a connection with the Appwrite data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview)** page from the ToolJet dashboard.
|
||||
|
||||
ToolJet requires the following to connect to your Appwrite:
|
||||
- **Host (API endpoint)**
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to **Amazon Athena** which is an interactive query service t
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the **Amazon Athena** data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](https://docs.tooljet.com/docs/data-sources/overview)** page from the ToolJet dashboard and choose **Amazon Athena** as the data source.
|
||||
To establish a connection with the **Amazon Athena** data source, you can either click on the **+ Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview)** page from the ToolJet dashboard and choose **Amazon Athena** as the data source.
|
||||
|
||||
ToolJet requires the following to connect to your Athena.
|
||||
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ This ID will be longer than the one generated earlier, and it could look like "2
|
|||
:::tip Resources
|
||||
- You can also write custom JavaScript code to get the data from **External APIs** and manipulate the response for graphical representation. Here's the [tutorial](https://blog.tooljet.com/build-github-stars-history-app-in-5-minutes-using-low-code/) on how we used custom JavaScript code to build an app using GitHub API.
|
||||
- [Import external libraries](/docs/how-to/import-external-libraries-using-runjs) using RunJS.
|
||||
- [Intentionally Fail](docs/how-to/intentionally-fail-js-query) a RunJS query.
|
||||
- [Intentionally Fail](/docs/how-to/intentionally-fail-js-query) a RunJS query.
|
||||
- [Trigger query at specified intervals](/docs/how-to/run-query-at-specified-intervals) using RunJS.
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The Mailgun API Datasource supports for interaction with the mail endpoint of th
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the **Mailgun** data source, click on the **+ Add new data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the **Mailgun** data source, click on the **+ Add new data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
ToolJet requires the following to connect to your Mailgun:
|
||||
- **API key**
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can trigger n8n workflows using webhook URLs. Please refer [this](https:
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the n8n data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the n8n data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
Webhooks in n8n can be configured to operate with or without **Authentication**. If no authentication is required, select `None` as the **Authentication type**. For webhooks that require authentication, choose the appropriate method from the dropdown and provide the corresponding credentials.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ToolJet can connect to a Notion workspace to do operations on notion pages, data
|
|||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Notion data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](https://docs.tooljet.com/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
To establish a connection with the Notion data source, click on the **+ Add new Data source** button located on the query panel or navigate to the [Data Sources](/docs/data-sources/overview) page from the ToolJet dashboard.
|
||||
|
||||
For integrating Notion with ToolJet we will need the API token. The API token can be generated from your Notion workspace settings. Read the official Notion docs for [Creating an internal integration with notion API](https://www.notion.so/help/create-integrations-with-the-notion-api).
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ ToolJet requires the following to connect to a REST API data source:
|
|||
### Authentication
|
||||
|
||||
:::info
|
||||
For a detailed explanation of the authentication types supported by REST API data sources, refer to the **[Authentication](./authentication)** section.
|
||||
For a detailed explanation of the authentication types supported by REST API data sources, refer to the **[Authentication](/docs/data-sources/restapi/authentication)** section.
|
||||
:::
|
||||
|
||||
ToolJet supports the following authentication types for REST API data sources:
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Pinecone
|
|||
ToolJet integrates with Pinecone to utilize its vector database capabilities. This integration enables ToolJet to perform vector operations such as updating, querying, and managing vector embeddings in Pinecone indexes.
|
||||
|
||||
:::note
|
||||
Before following this guide, it is assumed that you have already completed the process of **[Using Marketplace plugins](../marketplace-overview#using-marketplace-plugins)**.
|
||||
Before following this guide, it is assumed that you have already completed the process of **[Using Marketplace plugins](/docs/marketplace/marketplace-overview#using-marketplace-plugins)**.
|
||||
:::
|
||||
|
||||
## Connection
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ ToolJet has three default user roles, each with different levels of access:
|
|||
- **Custom Groups**: Can be created to assign specific permissions to sets of users.
|
||||
|
||||
:::info
|
||||
For detailed information on Users and Groups, refer to the [Managing Users and Groups](../tutorial/manage-users-groups.md) documentation.
|
||||
For detailed information on Users and Groups, refer to the [Managing Users and Groups](/docs/tutorial/manage-users-groups) documentation.
|
||||
:::
|
||||
|
||||
## Permission Levels
|
||||
|
|
|
|||
|
|
@ -12,29 +12,29 @@ This document outlines the key improvements introduced in ToolJet 3.0, a major u
|
|||
1. Up to 10 times faster app loading speeds
|
||||
2. Smooth app development even with 1000s of components and 100s of queries
|
||||
2. More intuitive experience in designing applications on the canvas with the new grid system
|
||||
4. Highly configurable **[page management system](../tutorial/pages)**
|
||||
5. Revamped **[components](../widgets/table/table-properties/)** with more styling and functionality customizations
|
||||
6. Enhanced developer experience in managing queries with the **[new query manager UI](../app-builder/query-panel)**
|
||||
4. Highly configurable **[page management system](/docs/tutorial/pages)**
|
||||
5. Revamped **[components](/docs/widgets/table/table-properties/)** with more styling and functionality customizations
|
||||
6. Enhanced developer experience in managing queries with the **[new query manager UI](/docs/app-builder/query-panel)**
|
||||
7. Improved coding experience with better code suggestions, linting, and type-casting
|
||||
8. Better debugging with easy-to-understand error messages
|
||||
9. Theme settings: Light/dark/auto mode at the application level
|
||||
|
||||
## Platform Enhancements
|
||||
|
||||
1. **[Group Sync OIDC](../user-authentication/sso/oidc/)**: Easily manage user access to ToolJet applications from your Identity Provider (IDP) directly
|
||||
2. **[Secrets constants](../org-management/workspaces/workspace_constants/#using-secrets)**: Ability to store encrypted credentials
|
||||
3. **[User metadata](../tutorial/manage-users-groups/#user-metadata)**: Store custom metadata with user details & access them while building applications
|
||||
1. **[Group Sync OIDC](/docs/user-authentication/sso/oidc/)**: Easily manage user access to ToolJet applications from your Identity Provider (IDP) directly
|
||||
2. **[Secrets constants](/docs/org-management/workspaces/workspace_constants/#using-secrets)**: Ability to store encrypted credentials
|
||||
3. **[User metadata](/docs/tutorial/manage-users-groups/#user-metadata)**: Store custom metadata with user details & access them while building applications
|
||||
4. User roles: Revamped user groups with granular access control
|
||||
5. **[User APIs](../tutorial/tooljet-api/#get-all-users)**: External API for creating and managing users
|
||||
5. **[User APIs](/docs/tutorial/tooljet-api/#get-all-users)**: External API for creating and managing users
|
||||
6. Security fixes: Various improvements to enhance platform security
|
||||
|
||||
## ToolJet Database (TJ DB)
|
||||
|
||||
1. **[Custom primary key](../tooljet-db/database-editor/#primary-key)** and **[foreign key support](../tooljet-db/database-editor/#foreign-key)**
|
||||
1. **[Custom primary key](/docs/tooljet-db/database-editor/#primary-key)** and **[foreign key support](/docs/tooljet-db/database-editor/#foreign-key)**
|
||||
2. Support for more data types for advanced use cases
|
||||
3. **[SQL mode](../tooljet-db/querying-tooljet-db#sql-editor)** for complex querying
|
||||
3. **[SQL mode](/docs/tooljet-db/querying-tooljet-db#sql-editor)** for complex querying
|
||||
4. Bulk upload using CSV
|
||||
5. GUI for **[complex SQL queries](../tooljet-db/querying-tooljet-db#gui-mode)** like joins, aggregates, and group by
|
||||
5. GUI for **[complex SQL queries](/docs/tooljet-db/querying-tooljet-db#gui-mode)** like joins, aggregates, and group by
|
||||
|
||||
## Integrations
|
||||
|
||||
|
|
@ -50,21 +50,21 @@ This document outlines the key improvements introduced in ToolJet 3.0, a major u
|
|||
|
||||
## AI Apps
|
||||
|
||||
Build AI apps using **[OpenAI](../marketplace/plugins/marketplace-plugin-openai)**, and **[Portkey](../marketplace/plugins/marketplace-plugin-portkey)** integrations
|
||||
Build AI apps using **[OpenAI](/docs/marketplace/plugins/marketplace-plugin-openai)**, and **[Portkey](/docs/marketplace/plugins/marketplace-plugin-portkey)** integrations
|
||||
|
||||
## Workflows
|
||||
|
||||
1. Introduction of **[loop node](../workflows/nodes#loop-node)** to implement iterative processes
|
||||
1. Introduction of **[loop node](/docs/workflows/nodes#loop-node)** to implement iterative processes
|
||||
2. Improved error handling and debugger: Improved troubleshooting
|
||||
3. Support for multiple deployment environments
|
||||
4. **[Webhook triggers](../workflows/workflow-triggers#webhooks)** to trigger workflows from external apps and services
|
||||
5. **[Multiple result nodes](../workflows/results)** for greater flexibility in defining the output
|
||||
4. **[Webhook triggers](/docs/workflows/workflow-triggers#webhooks)** to trigger workflows from external apps and services
|
||||
5. **[Multiple result nodes](/docs/workflows/results)** for greater flexibility in defining the output
|
||||
|
||||
## Migration Steps
|
||||
|
||||
Ready to upgrade to ToolJet 3.0? Follow our migration guides:
|
||||
- **[For Self-Hosted Users](../setup/upgrade-to-v3)**
|
||||
- **[For Cloud Users](../setup/cloud-v3-migration)**
|
||||
- **[For Self-Hosted Users](/docs/setup/upgrade-to-v3)**
|
||||
- **[For Cloud Users](/docs/setup/cloud-v3-migration)**
|
||||
|
||||
This release significantly enhances ToolJet's capabilities across its platform, focusing on improved performance, expanded integrations, and smoother development experience for building complex applications. The addition of AI-powered features and the release of Workflows provide users with advanced tools for creating sophisticated, automated solutions.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,6 +15,9 @@ Please find the latest LTS version here: <br/>
|
|||
| Version | Release Date | Docker Pull Command |
|
||||
|---------|--------------|----------------------|
|
||||
| Latest EE-LTS | N/A | `docker pull tooljet/tooljet:ee-lts-latest` |
|
||||
| [v3.0.2-ee-lts](https://hub.docker.com/layers/tooljet/tooljet/v3.0.2-ee-lts/images/sha256-6cb558e5e3337c7fc1b9ffc830ce7096f19253ff5f2fad177afdb46fb0b0ea9d?context=explore) | November 13, 2024 | `docker pull tooljet/tooljet:v3.0.2-ee-lts` |
|
||||
| [v3.0.1-ee-lts](https://hub.docker.com/layers/tooljet/tooljet/v3.0.1-ee-lts/images/sha256-b4f2e0779f76db07606ddd8a688cb7e06824837be3f507026ff91bb235efcc1d?context=explore) | November 12, 2024 | `docker pull tooljet/tooljet:v3.0.1-ee-lts` |
|
||||
| [v3.0.0-ee-lts](https://hub.docker.com/layers/tooljet/tooljet/v3.0.0-ee-lts/images/sha256-989f1370c502e97555dd7e669f896ef6ba2ad1d4f317c53335105bf937b5b189?context=explore) | November 12, 2024 | `docker pull tooljet/tooljet:v3.0.0-ee-lts` |
|
||||
| [EE-LTS-2.50.9.45](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.45/images/sha256-cb0030d66415ac52d156608fee2de8ce400cd4b2a7b3f865be331d13d939c883?context=explore) | October 24, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.45` |
|
||||
| [EE-LTS-2.50.9.44](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.44/images/sha256-739781626ba3b7a61890d5e6b633099fee12e0e14aa3d176ceafe102f4b4ca98?context=explore) | October 9, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.44` |
|
||||
| [EE-LTS-2.50.9.43](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.43/images/sha256-5d1cdd349872279ff23da9332dc0ec71c4ad637b35b728c44211f21fd206fa1c?context=explore) | October 3, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.43` |
|
||||
|
|
@ -28,9 +31,6 @@ Please find the latest LTS version here: <br/>
|
|||
| [EE-LTS-2.50.9.35](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.35/images/sha256-8a1b0014d470aff108ad75fd6982e01696740f2154a3bb49f08671b93d55485b?context=explore) | September 3, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.35` |
|
||||
| [EE-LTS-2.50.9.34](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.34/images/sha256-95af52997ec5b42fd5435bfef2f8996d0acc8234ae0541e155705ea4c689b272?context=explore) | August 30, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.34` |
|
||||
| [EE-LTS-2.50.9.33](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.33/images/sha256-e231b959a7e5e1455235d344ceffeaa34b482d925d9676e5169f58e966c59fbb?context=explore) | August 26, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.33` |
|
||||
| [EE-LTS-2.50.9.32](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.32/images/sha256-e231b959a7e5e1455235d344ceffeaa34b482d925d9676e5169f58e966c59fbb?context=explore) | August 26, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.32` |
|
||||
| [EE-LTS-2.50.9.31](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.31/images/sha256-9610b8a125ea622a4b07c17657c44e04e1b582df8a18c228bab3a876cdc49407?context=explore) | August 26, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.31` |
|
||||
| [EE-LTS-2.50.9.30](https://hub.docker.com/layers/tooljet/tooljet/EE-LTS-2.50.9.30/images/sha256-a7b0967aca4c4d29e423a78e91a7084073e2750d0a67fa2a8926d0da5eaf4ad4?context=explore) | August 21, 2024 | `docker pull tooljet/tooljet:EE-LTS-2.50.9.30` |
|
||||
|
||||
:::info
|
||||
Users are encouraged to upgrade to the latest LTS version to ensure they benefit from the latest improvements and maintain a secure and efficient environment.
|
||||
|
|
@ -46,4 +46,4 @@ Pre-Release versions are designed for those looking to explore the latest featur
|
|||
|
||||
Past versions of ToolJet are those that are no longer actively maintained or supported. These versions may still be available but are not recommended, especially in production environments, as they do not receive updates, bug fixes, or security patches.
|
||||
|
||||
*Versions **2.45.x.x** and all earlier versions are considered past versions and are no longer maintained.*
|
||||
*Versions **2.45.x.x** and all earlier versions are considered past versions and are no longer maintained.*
|
||||
|
|
@ -174,7 +174,7 @@ After November 11th, applications with the old Kanban Board component will crash
|
|||
|
||||
Workspace Constants are designed to be resolved on the server-side only, ensuring a high level of security. You can assign users to a specific role and provide create, update, and delete access to Workspace Constants.
|
||||
|
||||
For detailed instructions on migrating from Workspace Variables to Workspace Constants, please refer to our [Workspace Variables Migration Guide](../org-management/workspaces/workspace-variables-migration).
|
||||
For detailed instructions on migrating from Workspace Variables to Workspace Constants, please refer to our [Workspace Variables Migration Guide](/docs/org-management/workspaces/workspace-variables-migration).
|
||||
|
||||
|
||||
## Response Headers and Metadata
|
||||
|
|
@ -196,7 +196,7 @@ Now, you should use:
|
|||
{{queries.<queryName>.metadata}}
|
||||
```
|
||||
|
||||
The `metadata` object will contain detailed information about the request and response, including request URL, method, headers, parameters, response status code, and headers. You can read more about metadata [here](../data-sources/restapi/metadata-and-cookies/#metadata).
|
||||
The `metadata` object will contain detailed information about the request and response, including request URL, method, headers, parameters, response status code, and headers. You can read more about metadata [here](/docs/data-sources/restapi/metadata-and-cookies/#metadata).
|
||||
|
||||
## Help and Support
|
||||
|
||||
|
|
|
|||
|
|
@ -151,7 +151,7 @@ Please note the subpath is to be set with trailing `/` and is applicable only wh
|
|||
|
||||
ToolJet uses SMTP services to send emails (e.g., invitation emails when you add new users to your workspace).
|
||||
|
||||
For Enterprise Edition, you must configure SMTP settings through the user interface (UI) in the ToolJet Settings. For more information, see [SMTP Configuration](../org-management/smtp-configuration.md).
|
||||
For Enterprise Edition, you must configure SMTP settings through the user interface (UI) in the ToolJet Settings. For more information, see [SMTP Configuration](/docs/org-management/smtp-configuration).
|
||||
|
||||
:::info
|
||||
If you have upgraded from a version prior to v2.62.0, the SMTP variables in your .env file will automatically be mapped to the UI.
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ Once the Service is created and live, to make the Cloud Service URL public. Ple
|
|||
## Deploying ToolJet Database
|
||||
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly:
|
||||
- [Self Hosted](./upgrade-to-v3.md)
|
||||
- [Self Hosted](/docs/setup/upgrade-to-v3)
|
||||
|
||||
1. Cloud Run requires prebuilt image to be present within cloud registry. You can pull specific PostgREST image from docker hub and then tag with your project to push it to cloud registry.
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ You'll need to setup the following environment variables if ToolJet installation
|
|||
|
||||
|
||||
:::info
|
||||
See all **[Environment Variables](./env-vars)** here.
|
||||
See all **[Environment Variables](/docs/setup/env-var)** here.
|
||||
:::
|
||||
|
||||
## Upgrading to the Latest Version
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ docker run \
|
|||
|
||||
- Runs the ToolJet server on the port 80 on your machine.
|
||||
- Container has postgres already configured within. All the data will be available in the docker volume `tooljet_data`.
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](./env-vars).
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](/docs/setup/env-vars).
|
||||
- Use `docker stop tooljet` to stop the container and `docker start tooljet` to start the container thereafter.
|
||||
|
||||
#### Dynamic Port Setup
|
||||
|
|
|
|||
|
|
@ -20,14 +20,15 @@ ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life
|
|||
|
||||
The upgrade process depends on your deployment method. You can follow the upgrade process under the respective setup guides:
|
||||
|
||||
- [Upgrade ToolJet on DigitalOcean](../digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](../docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](../ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](../ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](../openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](../helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](../kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](../kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](../kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](../azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](../google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on DigitalOcean](/docs/setup/digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](/docs/setup/docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](/docs/setup/ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](/docs/setup/ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](/docs/setup/openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](/docs/setup/helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](/docs/setup/kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](/docs/setup/kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](/docs/setup/kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](/docs/setup/azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](/docs/setup/google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ ToolJet Database supports several data types to accommodate various kinds of inf
|
|||
|
||||
## Permissible Constraints per Data Type
|
||||
|
||||
The following table shows which constraints are permissible for each data type. For more detailed explanations of each constraint type, please refer to the [Column Constraints](./database-editor#column-constraints) section.
|
||||
The following table shows which constraints are permissible for each data type. For more detailed explanations of each constraint type, please refer to the [Column Constraints](/docs/tooljet-db/database-editor#column-constraints) section.
|
||||
|
||||
| Data Type | Primary Key | Foreign Key | Unique | Not Null |
|
||||
|:-----------:|:--------------:|:-------------:|:--------:|:----------:|
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ To create a new table in the ToolJet Database:
|
|||
| **Option** | **Description** |
|
||||
| --- | --- |
|
||||
| **Column name** | Enter a unique name for the column. |
|
||||
| **Data type** | Select the appropriate data type for the column from the dropdown menu. For more information on available data types, see the [Supported Data Types](./data-types#supported-data-types) section. |
|
||||
| **Data type** | Select the appropriate data type for the column from the dropdown menu. For more information on available data types, see the [Supported Data Types](/docs/tooljet-db/data-types#supported-data-types) section. |
|
||||
| **Default value (optional)** | Specify any default value to be assigned to the column. If left blank, the column will allow null values. |
|
||||
| **Primary Key** | Check this box to designate the column as the [Primary Key](#primary-key). Multiple columns can be selected, creating a composite primary key. |
|
||||
| **NULL/NOT NULL toggle** | Use this toggle to determine whether the column should allow null values or require a value. By default, null values are permitted. |
|
||||
|
|
@ -60,7 +60,7 @@ ToolJet Database supports several column constraints to maintain data integrity
|
|||
|
||||
**Not Null**: The not null constraint ensures that the designated column(s) cannot have null values, requiring a value for every row in the table.
|
||||
|
||||
For a detailed overview of which constraints are allowed for each data type, refer to the [Permissible Constraints per Data Type](./data-types#permissible-constraints-per-data-type) table.
|
||||
For a detailed overview of which constraints are allowed for each data type, refer to the [Permissible Constraints per Data Type](/docs/tooljet-db/data-types#permissible-constraints-per-data-type) table.
|
||||
|
||||
## Primary Key
|
||||
|
||||
|
|
@ -281,7 +281,7 @@ To add a new column to a table, either click on the kebab menu icon on the right
|
|||
A drawer from the right will open up where you can enter the details for the new column:
|
||||
|
||||
- **Column Name**: Enter a unique name for the new column, serving as its key identifier.
|
||||
- **Data Type**: Choose the appropriate data type for the column from the [available options](./data-types#supported-data-types). For more information on data types and their associated constraints, see the [Supported Data Types](./data-types#supported-data-types) and [Permissible Constraints per Data Type](./data-types#permissible-constraints-per-data-type) sections.
|
||||
- **Data Type**: Choose the appropriate data type for the column from the [available options](/docs/tooljet-db/data-types#supported-data-types). For more information on data types and their associated constraints, see the [Supported Data Types](/docs/tooljet-db/data-types#supported-data-types) and [Permissible Constraints per Data Type](/docs/tooljet-db/data-types#permissible-constraints-per-data-type) sections.
|
||||
- **Default Value**: Specify any default value that should be assigned to the column. Optionally, users can leave this field blank. When a table contains rows and NOT NULL is applied to one of its existing or new columns, specifying a default value becomes compulsory.
|
||||
- **Foreign Key Relation**: Click on the toggle to add a foreign key relationship to the column. This will open a menu where you can select the target table and column to reference.
|
||||
|
||||
|
|
|
|||
|
|
@ -26,6 +26,6 @@ You will be redirected to the visual app editor once the app has been created. C
|
|||
|
||||
The main components of an app:
|
||||
|
||||
- **[Widgets](https://docs.tooljet.com/docs/tutorial/adding-widget)** - UI components such as tables, buttons, dropdowns.
|
||||
- **[Data sources](https://docs.tooljet.com/docs/tutorial/adding-a-datasource)** - ToolJet can connect to databases, APIs and external services to fetch and modify data.
|
||||
- **[Queries](https://docs.tooljet.com/docs/tutorial/building-queries)** - Queries are used to access the connected data sources.
|
||||
- **[Widgets](/docs/tutorial/adding-widget)** - UI components such as tables, buttons, dropdowns.
|
||||
- **[Data sources](/docs/tutorial/adding-a-datasource)** - ToolJet can connect to databases, APIs and external services to fetch and modify data.
|
||||
- **[Queries](/docs/tutorial/building-queries)** - Queries are used to access the connected data sources.
|
||||
|
|
@ -5,7 +5,7 @@ title: Managing Users and Groups
|
|||
|
||||
# Managing Users and Groups
|
||||
|
||||
This guide explains how to manage users and groups in ToolJet. For an overview of the permission system, please refer to the [Permissions](../org-management/permissions.md) documentation.
|
||||
This guide explains how to manage users and groups in ToolJet. For an overview of the permission system, please refer to the [Permissions](/docs/org-management/permissions) documentation.
|
||||
|
||||
## Managing Users Across Workspaces
|
||||
|
||||
|
|
@ -160,7 +160,7 @@ Admins of a workspace can create custom groups to manage permissions. To create
|
|||
### Modifying Group Permissions
|
||||
|
||||
:::info
|
||||
For detailed information on permissions, refer to the [Permissions](../org-management/permissions.md) documentation.
|
||||
For detailed information on permissions, refer to the [Permissions](/docs/org-management/permissions) documentation.
|
||||
:::
|
||||
|
||||
When changing permissions for a custom group:
|
||||
|
|
|
|||
|
|
@ -89,9 +89,9 @@ The duplicate page option allows you to create and add a copy of the page in the
|
|||
|
||||
Like other ToolJet components, pages can also be attached to event handlers. For pages, the **On page load** event is available. You can use all the available actions for this event, along with the new actions added specifically for Pages.
|
||||
|
||||
- **[Switch Page](../actions/switch-page)**
|
||||
- **[Set Page Variable](../actions/set-page-variable)**
|
||||
- **[Unset Page Variable](../actions/unset-page-variable)**
|
||||
- **[Switch Page](/docs/actions/switch-page)**
|
||||
- **[Set Page Variable](/docs/actions/set-page-variable)**
|
||||
- **[Unset Page Variable](/docs/actions/unset-page-variable)**
|
||||
|
||||
### Disable Page
|
||||
|
||||
|
|
@ -114,6 +114,6 @@ You can **delete** a page from an application using this option. <br/>
|
|||
| handle | The handle represents the slug of the page within an app. In the URL `https://app.tooljet.com/applications/crm2/home`, **crm2** refers to the app name, and **home** corresponds to the handle. The handle is automatically set when a page is added, and you can also [rename](#rename) the handle from the Page options. To access the value of the handle variable dynamically, use `{{page.handle}}`|
|
||||
| name | The name indicates the name of the page set during its creation. To access the value of the name variable dynamically, use `{{page.name}}` |
|
||||
| id | Each page in the ToolJet app receives a unique identifier upon creation. To access the value of the id dynamically, use `{{page.id}}` |
|
||||
| variables | Variables is an object that contains all the variables created for a specific page using the [Set Page Variable](../actions/set-page-variable) action. The value of a specific variable can be accessed dynamically using `{{page.variables.<pageVariableName>}}`, where `<pageVariableName>` refers to the variable created for that page using the Set Page variable action. |
|
||||
| variables | Variables is an object that contains all the variables created for a specific page using the [Set Page Variable](/docs/actions/set-page-variable) action. The value of a specific variable can be accessed dynamically using `{{page.variables.<pageVariableName>}}`, where `<pageVariableName>` refers to the variable created for that page using the Set Page variable action. |
|
||||
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -31,10 +31,10 @@ Server-side operations refer to tasks executed on the server, such as data fetch
|
|||
|
||||
Following server side operations can be performed on a Table in ToolJet:
|
||||
|
||||
- [Search](./search.md)
|
||||
- [Sort](./sort.md)
|
||||
- [Filter](./filter.md)
|
||||
- [Pagination](./pagination.md)
|
||||
- [Search](/docs/widgets/table/serverside-operations/search/)
|
||||
- [Sort](/docs/widgets/table/serverside-operations/sort/)
|
||||
- [Filter](/docs/widgets/table/serverside-operations/filter/)
|
||||
- [Pagination](/docs/widgets/table/serverside-operations/pagination/)
|
||||
|
||||
<img className="screenshot-full" src="/img/widgets/table/serverside-operations/serverside-operations.png" alt="Serverside Operations Present for Table Component in ToolJet" />
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The **Toggle Switch** component can be used for binary choices, such as turning
|
|||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
:::info
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/2.43.0/widgets/toggle-switch)** document.
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/widgets/toggle-switch)** document.
|
||||
:::
|
||||
|
||||
## Properties
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The **Toggle Switch** component can be used for binary choices, such as turning
|
|||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
:::info
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/2.43.0/widgets/toggle-switch)** document.
|
||||
To get the configuration of legacy Toggle Switch component, please refer to **[this](/docs/widgets/toggle-switch)** document.
|
||||
:::
|
||||
|
||||
## Properties
|
||||
|
|
|
|||
Loading…
Reference in a new issue