From 8a77c8d2e027bf0d2a23f733369e18f2496350e2 Mon Sep 17 00:00:00 2001 From: Itamar Smirra Date: Tue, 28 Oct 2025 14:08:21 +0200 Subject: [PATCH 1/4] add performance section to entities table --- .../page/catalog-page.md | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md index 1d9bfc5e5c..4a4e673a2d 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md @@ -183,9 +183,13 @@ The description will be displayed at the top of the page, under the page title: -### Initial filters +### Performance +In some cases, an entities table may be very large, resulting in long loading times. There are few tips and best practices we can use to speed things up and improve the page loading times. + +#### Initial filters + +The most effective way for reducing loading times. You can define filters that resolve when Port queries the data (rather than after querying like the table filters). This will reduce the number of entities displayed in table which will improve loading times. -In some cases, an entities table may be very large, resulting in long loading times. To prevent this, you can define filters that resolve when Port queries the data (rather than after querying). To define such a filter, use the `Initial filters` field when creating a page: @@ -204,17 +208,23 @@ You can define any [supported rule](/search-and-query/#rules) in JSON format. He ] ``` -#### Dynamic filters +##### Dynamic filters You can use [dynamic properties](/search-and-query/#dynamic-properties) of the logged-in user when creating a catalog page. -### Excluded properties +#### Excluded properties + +Another way to reduce loading times is to exclude undesired properties from an entities table when querying the data. When using this option, the new table will not contain columns for the excluded properties. We recommend excluding properties with no actual benefit when showed in the table - big object property, long array properties, etc. -Another way to reduce loading times is to exclude undesired properties from an entities table when querying the data. When using this option, the new table will not contain columns for the excluded properties. To do this, use the `Excluded properties` field when creating a page: +#### Calculation properties +While calculation properties have powerful functionality, in some cases they can have negative performance impact. If possible and needed, we recommend excluding them from the table or replace them entirely with regular properties. + +Learn more about [calculation properties performance](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/#performance-impact). + ## Customization The entities table can be customized, which will define the users' view of the Port platform. From c4173417349d3a1619a7d525f06c6e18408fb8f8 Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Wed, 29 Oct 2025 14:07:10 +0200 Subject: [PATCH 2/4] Edit the placement of the section and the wording --- .../page/catalog-page.md | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md index 4a4e673a2d..583bb8c714 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md @@ -183,12 +183,13 @@ The description will be displayed at the top of the page, under the page title: -### Performance -In some cases, an entities table may be very large, resulting in long loading times. There are few tips and best practices we can use to speed things up and improve the page loading times. +## Performance -#### Initial filters +Large entities tables can result in long loading times. Use the following tips and best practices to improve performance. -The most effective way for reducing loading times. You can define filters that resolve when Port queries the data (rather than after querying like the table filters). This will reduce the number of entities displayed in table which will improve loading times. +### Initial filters + +Initial filters are the most effective way to reduce loading times. You can define filters that resolve when Port queries the data (rather than after querying, like table filters), reducing the number of entities displayed in the table. To define such a filter, use the `Initial filters` field when creating a page: @@ -196,7 +197,8 @@ To define such a filter, use the `Initial filters` field when creating a page:

-You can define any [supported rule](/search-and-query/#rules) in JSON format. Here is an example that will only display `Deployments` that were updated in the past month: +You can define any [supported rule](/search-and-query/#rules) in JSON format. +Here is an example that will only display `Deployments` that were updated in the past month: ```json showLineNumbers [ @@ -208,22 +210,25 @@ You can define any [supported rule](/search-and-query/#rules) in JSON format. He ] ``` -##### Dynamic filters +#### Dynamic filters You can use [dynamic properties](/search-and-query/#dynamic-properties) of the logged-in user when creating a catalog page. -#### Excluded properties +### Excluded properties + +Another way to reduce loading times is to exclude undesired properties from an entities table when querying the data. When using this option, the new table will not contain columns for the excluded properties. -Another way to reduce loading times is to exclude undesired properties from an entities table when querying the data. When using this option, the new table will not contain columns for the excluded properties. We recommend excluding properties with no actual benefit when showed in the table - big object property, long array properties, etc. +We recommend excluding properties with no actual benefit when shown in the table, such as large object properties, long array properties, and other complex data types. To do this, use the `Excluded properties` field when creating a page: -#### Calculation properties -While calculation properties have powerful functionality, in some cases they can have negative performance impact. If possible and needed, we recommend excluding them from the table or replace them entirely with regular properties. +### Calculation properties + +While calculation properties provide powerful functionality, they can impact performance when used in blueprints that have many entities. To improve performance, consider excluding calculation properties from the table or replacing them with regular properties. -Learn more about [calculation properties performance](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/#performance-impact). +To learn more about calculation properties performance, refer to the [calculation property](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/#performance-impact) page. ## Customization From 7d0353d5691732743a1f1b9746cf34554aa93a6d Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Wed, 29 Oct 2025 14:50:41 +0200 Subject: [PATCH 3/4] fix entities tables wording --- .../customize-pages-dashboards-and-plugins/page/catalog-page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md index 583bb8c714..76d8428117 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md @@ -185,7 +185,7 @@ The description will be displayed at the top of the page, under the page title: ## Performance -Large entities tables can result in long loading times. Use the following tips and best practices to improve performance. +Large entity tables can result in long loading times. Use the following tips and best practices to improve performance. ### Initial filters From 683bb663b647d298fd348a96b35d1c44acb88290 Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Wed, 29 Oct 2025 16:11:21 +0200 Subject: [PATCH 4/4] added clarification on the placement of the filters and properties --- .../customize-pages-dashboards-and-plugins/page/catalog-page.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md index 76d8428117..f9b709777f 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/catalog-page.md @@ -187,6 +187,8 @@ The description will be displayed at the top of the page, under the page title: Large entity tables can result in long loading times. Use the following tips and best practices to improve performance. +The [initial filters](#initial-filters) and [excluded properties](#excluded-properties) are defined when creating the page, while [calculation properties](#calculation-properties) are configured as part of the blueprint definition. + ### Initial filters Initial filters are the most effective way to reduce loading times. You can define filters that resolve when Port queries the data (rather than after querying, like table filters), reducing the number of entities displayed in the table.