Browse Source

docs: updated extensions doc

pull/9944/head
LisaVCherian 2 days ago
parent
commit
3d9b1c53a8
  1. 34
      packages/noco-docs/docs/.135.extensions/010.overview.md
  2. 25
      packages/noco-docs/docs/.135.extensions/020.data-exporter.md
  3. 58
      packages/noco-docs/docs/.135.extensions/030.upload-data-from-csv.md
  4. 26
      packages/noco-docs/docs/.135.extensions/040.bulk-update.md
  5. 4
      packages/noco-docs/docs/.135.extensions/050.url-preview.md
  6. 29
      packages/noco-docs/docs/.135.extensions/060.world-clock.md
  7. 8
      packages/noco-docs/docs/.135.extensions/_category_.json
  8. BIN
      packages/noco-docs/static/img/v2/extensions/url-preview.png

34
packages/noco-docs/docs/.135.extensions/010.overview.md

@ -1,12 +1,12 @@
---
title: 'Overview'
title: 'Extensions overview'
description: 'Overview of the extensions available in NocoDB'
tags: ['Extensions', 'Overview']
keywords: ['Extensions overview', 'Add Extensions', 'Extension framework', 'Extension settings']
---
:::note
The Extensions feature is currently available only on NocoDB Cloud and is not supported in self-hosted instances.
The Extensions feature is available exclusively on NocoDB Cloud and is not supported in self-hosted instances.
:::
Extensions are modular components designed to expand and customize your experience with NocoDB. Functioning like plugins, extensions introduce new features and functionalities beyond the platform's core capabilities, allowing users to adapt NocoDB to suit unique requirements and workflows.
@ -21,27 +21,29 @@ This section provides an overview of the Extensions framework, detailing how to
Extensions can be developed using JavaScript and Vue.js, offering a flexible approach to adding new features to your NocoDB instance. The ability to develop custom extensions will be available soon, allowing you to tailor NocoDB to meet specific needs and workflows. Stay tuned for more updates!
Extensions side panel can be toggled from the top right corner of the NocoDB interface using `Extensions` button.
The Extensions side panel can be toggled using the `Extensions` button located in the top-right corner of the NocoDB interface.
[//]: # (![Extensions side panel](/img/v2/extensions/extensions-side-panel.png))
## Extension Marketplace
## Extensions Marketplace
Extensions Marketplace is a centralized hub where you can explore, discover, and install extensions to enhance your NocoDB experience. The marketplace offers a wide range of extensions developed by the NocoDB team and the community, providing a diverse selection of features to choose from.
The Extensions Marketplace is a centralized hub where you can explore, discover, and install extensions to enhance your NocoDB experience. The marketplace offers a wide range of extensions developed by the NocoDB team and the community, providing a diverse selection of features to choose from.
Extensions available currently are:
[//]: # (- [Data Exporter](/extensions/data-exporter))
[//]: # (- [Import CSV](/extensions/import-csv))
The following extensions are currently available in the marketplace:
- [Data Exporter](/extensions/data-exporter)
- [Upload Data from CSV](/extensions/upload-data-from-csv)
- [Bulk Update](/extensions/bulk-update)
- [URL Preview](/extensions/url-preview)
- [World Clock](/extensions/world-clock)
- [Org Chart](/extensions/org-chart)
Note that, the ability to develop custom extensions is not supported currently.
## Adding Extensions
To add an extension to your NocoDB instance, open extensions side panel and follow these steps:
1. Click on the `Add Extension` button in the Extensions side panel.
2. Click on the `Add` button to add the extension to your NocoDB instance. You can also click on the extension card to view more details about the extension.
1. Click the `Add Extension` button in the Extensions side panel.
2. Click the `Add` button to add the extension to your NocoDB instance. You can also click on the extension card to view more details about the extension.
:::info
- The extensions installed are specific to the base and are not shared across workspace.
@ -53,17 +55,17 @@ To add an extension to your NocoDB instance, open extensions side panel and foll
## Managing Extensions
Once extension is installed, you can
After installing an extension, you can manage it using the following options:
### Visibility
### 1. Adjust Visibility
Use the `expand` icon to view the extension in full screen mode.
<img src="/img/v2/extensions/expand.png" alt="Extension visibility" width="480"/>
### Reorder Extension
### 2. Reorder Extensions
Use the `drag-drop` icon to reorder the extensions in the side panel.
<img src="/img/v2/extensions/reorder.png" alt="Reorder" width="480"/>
### Other actions
### 3. Additional Actions
Use the `More` button to perform the following actions:
- Rename extension
- Duplicate extension

25
packages/noco-docs/docs/.135.extensions/020.data-exporter.md

@ -6,20 +6,20 @@ keywords: ['Data Exporter', 'Export data', 'Export JSON', 'Export CSV', 'Export
---
## Overview
Data Exporter extension is designed to simplify the process of exporting data from your NocoDB tables. With just a few clicks, you can effortlessly download CSV files for any specific table and view within your base. The download process is handled asynchronously in the background, ensuring that your application usage remains uninterrupted. Once your file is ready, you’ll receive a notification, allowing you to download the CSV into your local machine at your convenience.
The Data Exporter extension is designed to simplify the process of exporting data from your NocoDB tables. With just a few clicks, you can effortlessly download CSV files for any specific table and view within your base. The download process is handled asynchronously in the background, ensuring that your application usage remains uninterrupted. Once your file is ready, you’ll receive a notification, allowing you to download the CSV into your local machine at your convenience.
## Exporting Data
To export data from your NocoDB tables, follow the steps outlined below:
1. Select the table & associated view you wish to export.
2. Optionally, configure **Separator** & **Encoding** as required.
- Default separator is a Comma `,`.
- Other options supported are Semicolon `;`, Pipe `|` and `Tab`
3. Click on the **Export** button.
Follow these steps to export data from your NocoDB tables:
1. Select the table and associated view you wish to export.
2. Configure optional settings for Separator and Encoding:
- Default separator: Comma `,`
- Other options: Semicolon `;`, Pipe `|` and `Tab`
3. Click the **Export** button.
4. Once the export is complete, the file will be listed in the **Recent Exports** section.
5. Click on the **Download** button to save the CSV file to your local system.
5. Click the **Download** button to save the CSV file to your local device.
:::note
Separator & Encoding configurations are possible only from expanded extension panel
Separator and Encoding configurations are only accessible from the expanded extension panel.
:::
![Data Exporter](/img/v2/extensions/data-exporter.png)
@ -29,8 +29,9 @@ Separator & Encoding configurations are possible only from expanded extension pa
The files exported have a limited lifespan and are automatically removed after 6 hours. The files listed under the **Recent Exports** section are only visible to you and are not shared with other users. You can manage your exports by downloading or removing them as needed.
### Downloading Exports
- In the **Recent Exports** section, locate the file you wish to download.
- Click the **Download** icon next to the export to save it to your device.
1. In the Recent Exports section, locate the desired file.
2. Click the Download icon next to the file to save it to your device.
### Removing Exports
- If you no longer need a particular export, click the `x` icon next to it to remove it from the list.
1. Locate it in the Recent Exports section.
2. Click the `x` icon to remove it from the list.

58
packages/noco-docs/docs/.135.extensions/030.upload-data-from-csv.md

@ -6,39 +6,49 @@ keywords: ['Import CSV', 'Import data', 'CSV import', 'Data import', 'CSV files'
---
## Overview
The Import CSV Extension in NocoDB allows users to import data from CSV files directly into existing tables. This tool helps in adding new records, updating existing ones, and efficiently mapping CSV columns to NocoDB fields.
The Import CSV extension in NocoDB allows users to import data from CSV files directly into existing tables. This tool enables you to efficiently add new records, update existing ones, and map CSV columns to NocoDB fields with precision.
## Importing Data
### Mode
The Import CSV Extension supports two modes of data import:
- **Add Records**: This option adds all records from the CSV file as new entries in the specified table.
- **Merge Records**: This option updates existing records based on a specified field (referred to as **merge field** in this context) in the CSV file.
### Modes of Import
The Import CSV Extension supports two modes of data import:
&nbsp; **1. Add Records**: Import all records from the CSV file as new entries in the selected table. No existing records are modified.
&nbsp; **2. Merge Records**: Update existing records based on a designated **merge field** (a unique field used for matching) while optionally adding new records. The available options under this mode are:
- *Create New Records Only*
- Only adds new records from the CSV. Existing records are not updated. New records are identified based on the merge field specified.
- *Update Existing Records Only*
- Only updates records that already exist in the table based on the merge field. New records are not added.
- *Create and Update Records*
- Adds new records and updates existing ones as needed. New and existing records are identified based on the merge field.
**Merge Field** is field that will be used to match records from the CSV file with existing records in NocoDB table for the purpose of updating.
**Field Mapping:** You can select the fields from the CSV file to import and map them to the corresponding fields in the NocoDB table.
### Steps
To import data from a CSV file into NocoDB, drag-drop (or upload) the CSV file into the extension area and follow these steps:
1. Select the table you want to import the data into. By default, current active table is selected.
2. Select the mode of import: **Add Records** or **Merge Records**. If you choose Merge Records, you will have to additionally
- Select "Import Type" :
- *Create New Records Only*,
- *Update Existing Records Only*, or
- *Create and Update Records*.
- Select "Merge Field". Merge field typically will be your Primary Key or a unique identifier. Composite keys are not supported.
3. **Use first record as header**: If the first row of the CSV file contains the column headers, enable this option to use them as the field names.
4. Map the CSV columns to the NocoDB fields.
5. Click on the **Import** button to start the import process.
- Adds new records and updates existing ones as needed, based on the merge field.
**Merge Field:** The merge field is the key field used to match records in the CSV file with those in the NocoDB table for updating purposes. Typically, this is the Primary Key or another unique identifier. Composite keys are not supported.
**Field Mapping:** Easily map CSV columns to corresponding fields in the NocoDB table. You have the flexibility to import only the fields you need.
### Steps to Import
Follow these steps to import data from a CSV file into NocoDB:
1. Drag and drop or upload your CSV file into the Import CSV Extension area.
2. Select the table you want to import the data into. By default, current active table is selected.
3. Choose the mode of import:
- **Add Records** or
- **Merge Records** with one of the following **Import Types**:
- *Create New Records Only*
- *Update Existing Records Only*
- *Create and Update Records*
4. Set the **Merge Field** (for Merge Records mode): Select the field that will be used to match CSV records with existing table records.
5. **Use first record as header**: If the first row of the CSV file contains the column headers, enable this option to use them as the field names.
6. Map the columns from the CSV file to the corresponding fields in the NocoDB table.
7. Click the **Import** button to start the import process.
![Import CSV](/img/v2/extensions/upload-csv.png)
Once you've configured the import settings and mapped your fields, NocoDB will process the CSV file and update the table according to your specified settings. A summary of new, updated, and unchanged records will be displayed at the bottom of the interface.
### Post-Import Summary
Once the import is complete, NocoDB will display a summary detailing:
- The number of new records added
- The number of existing records updated
- Any records left unchanged
This streamlined process ensures your data is imported accurately and efficiently.

26
packages/noco-docs/docs/.135.extensions/040.bulk-update.md

@ -6,19 +6,19 @@ keywords: ['Bulk Update', 'Update multiple records', 'Update data', 'Update reco
---
## Overview
Bulk Update extension in NocoDB allows you to update multiple records in a view simultaneously. This feature is particularly useful when you need to make the same change across multiple records, saving you time and effort.
The Bulk Update extension in NocoDB allows you to update multiple records in a view simultaneously. This feature is particularly useful when you need to make the same change across multiple records, saving you time and effort.
## Updating Records
To update multiple records in a table, follow the steps outlined below:
1. Select the table & associated view you wish to update.
2. Click on the **New Action** button.
3. Select **Field** you want to update.
4. Select Update **Type**:
- **Set** Value: Set a specific value for the field.
- **Clear** Value: Clear the field value.
5. Select **Value** you want to set for the field, if option selected is **Set** Value.
6. Click on the **Update Records** button to apply the changes.
7. A confirmation dialog will appear. Number of fields and records to be updated will be displayed. Click on **Confirm Update** to proceed with the update.
Follow these steps to update multiple records in a table:
1. Select the table and associated view you wish to update.
2. Click the **New Action** button.
3. Choose the **Field** you want to update.
4. Select an **Update Type**:
- **Set Value**: Set a specific value for the field.
- **Clear Value**: Clear the field value.
5. If you selected **Set Value**, provide the **Value** to be applied.
6. Click the **Update Records** button to apply the changes.
7. A confirmation dialog will display the number of fields and records to be updated. Review the details and click **Confirm Update** to proceed.
![Bulk Update](/img/v2/extensions/bulk-update.png)
@ -31,11 +31,11 @@ The actions added are listed in the **Actions** section. You can:
- **Disable** an action by toggling the switch next to the action item. Disabling an action will prevent it from being applied to the records.
:::warning
- Bulk updates can't be undone. Ensure you review the changes before confirming the update.
- Bulk updates are irreversible. Ensure you review the changes before confirming the update.
:::
:::info
- Bulk updates are applied to all records in the view, including those that are not visible on the current page.
- Bulk updates are applied to all records in the view, including those not visible on the current page.
- Bulk updates are specific to the view and are not applied to the entire table.
:::

4
packages/noco-docs/docs/.135.extensions/050.url-preview.md

@ -7,10 +7,10 @@ keywords: ['URL Preview', 'Preview URLs', 'Preview links', 'Preview URL content'
## Overview
The URL Preview Extension in NocoDB allows you to preview URLs directly within your NocoDB instance. This feature is particularly useful when you need to quickly view the content of a URL without leaving your workspace. This extension enhances the data visualization capabilities of NocoDB by providing rich, contextual previews for supported online platforms and services.
The URL Preview extension in NocoDB allows you to preview URLs directly within your NocoDB instance. This feature is particularly useful when you need to quickly view the content of a URL without leaving your workspace. This extension enhances the data visualization capabilities of NocoDB by providing rich, contextual previews for supported online platforms and services.
## Previewing URLs
To preview a URL in NocoDB, just select a cell from URL field. A preview of the URL content will be displayed in the extension sub-panel, allowing you to view the content without navigating away from your workspace.
To preview a URL in NocoDB, just select a cell from the URL field. A preview of the URL content will be displayed in the extension sub-panel, allowing you to view the content without navigating away from your workspace.
![URL Preview](/img/v2/extensions/url-preview.png)

29
packages/noco-docs/docs/.135.extensions/060.world-clock.md

@ -0,0 +1,29 @@
---
title: 'World Clock'
description: 'Display multiple time zone clocks with in NocoDB'
tags: ['Extensions', 'World Clock', 'Time Zone', 'Clock', 'Time']
keywords: ['World Clock', 'Time Zone Clock', 'Clock', 'Time Zone', 'Time']
---
## Overview
The World Clock extension in NocoDB allows you to display multiple time zone clocks within your NocoDB instance. This feature is particularly useful when you need to track time across different regions or collaborate with team members in different time zones. The extension enhances the user experience by providing a visual representation of time zones, making it easier to manage global operations and schedules.
<img src="/img/v2/extensions/world-clock-2.png" alt="Analog" width="380"/>
<img src="/img/v2/extensions/world-clock-1.png" alt="Digital" width="420"/>
### Adding Clock
To add a clock, expand World clock extension, click `+ Add City` and select City from the dropdown available. You can add a maximum of 4 clocks per instance of an extension.
- **Clock Name**: Enter a name for the clock to identify it easily. It defaults to the selected City name.
- **Theme**: Choose one amongst the available themes for the clock display.
### Clock Display Settings
The following are the global settings that will be applied to all the clocks configured.
- **Clock Type**: Choose between **Analog**, **Digital**, or **Both** for the display format.
- **Show Numbers**: For analog clocks, you can additionally configure if hour numbers are to be displayed on the clock dial.
- **Time Format**: Choose between 12H and 24H format for the clock display.

8
packages/noco-docs/docs/.135.extensions/_category_.json

@ -0,0 +1,8 @@
{
"label": "Extensions ☁",
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index"
}
}

BIN
packages/noco-docs/static/img/v2/extensions/url-preview.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 756 KiB

After

Width:  |  Height:  |  Size: 718 KiB

Loading…
Cancel
Save