diff --git a/.github/styles/Vocab/Doc/accept.txt b/.github/styles/Vocab/Doc/accept.txt index 1389a69b..01453a35 100644 --- a/.github/styles/Vocab/Doc/accept.txt +++ b/.github/styles/Vocab/Doc/accept.txt @@ -23,4 +23,5 @@ sparkline KPI's Exton Gantt -sitewide \ No newline at end of file +sitewide +Unselect \ No newline at end of file diff --git a/.github/styles/config/vocabularies/Doc/accept.txt b/.github/styles/config/vocabularies/Doc/accept.txt index 4e14fc03..7bb5f3bc 100644 --- a/.github/styles/config/vocabularies/Doc/accept.txt +++ b/.github/styles/config/vocabularies/Doc/accept.txt @@ -27,6 +27,8 @@ Proficy Exton Gantt sitewide +Unselect +pulldown timeseries downsampled stddev @@ -76,4 +78,10 @@ Cognite SQLuser projectware picosecond -lossy \ No newline at end of file +lossy +inmation +walkthrough +toolset +timeframes +Rollups +rollups \ No newline at end of file diff --git a/.github/styles/config/vocabularies/docs/accept.txt b/.github/styles/config/vocabularies/docs/accept.txt index 4e14fc03..d2c06812 100644 --- a/.github/styles/config/vocabularies/docs/accept.txt +++ b/.github/styles/config/vocabularies/docs/accept.txt @@ -27,6 +27,8 @@ Proficy Exton Gantt sitewide +Unselect +pulldown timeseries downsampled stddev @@ -76,4 +78,7 @@ Cognite SQLuser projectware picosecond -lossy \ No newline at end of file +lossy +inmation +walkthrough +toolset \ No newline at end of file diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml.text similarity index 100% rename from .github/workflows/main.yml rename to .github/workflows/main.yml.text diff --git a/visual-kpi-docs/.sidebar/designer/index.js b/visual-kpi-docs/.sidebar/designer/index.js index e4e6d487..42387795 100644 --- a/visual-kpi-docs/.sidebar/designer/index.js +++ b/visual-kpi-docs/.sidebar/designer/index.js @@ -11,25 +11,29 @@ module.exports = [ // className: '', link: { type: 'doc', - id: 'visual-kpi-design/installation-and-setup/installation', + id: 'visual-kpi-design/installation-and-setup/overview', }, items: [ 'visual-kpi-design/installation-and-setup/installation', - 'visual-kpi-design/installation-and-setup/setup-and-connection', - 'visual-kpi-design/installation-and-setup/visual-kpi-designer-ui', + 'visual-kpi-design/installation-and-setup/connecting', + 'visual-kpi-design/installation-and-setup/ui-tour', + 'visual-kpi-design/installation-and-setup/basic-setup', ], }, + { type: 'category', label: "Authoring", // className: '', link: { type: 'doc', - id: 'visual-kpi-design/authoring/authoring', + id: 'visual-kpi-design/authoring/overview', }, items: [ - 'visual-kpi-design/authoring/default-settings', - 'visual-kpi-design/authoring/manage-objects', + 'visual-kpi-design/authoring/profiles-dashboards', + 'visual-kpi-design/authoring/contacts-alerts', + 'visual-kpi-design/authoring/features-config', + 'visual-kpi-design/authoring/advanced', ], }, { @@ -38,23 +42,89 @@ module.exports = [ // className: '', link: { type: 'doc', - id: 'visual-kpi-design/design/design', + id: 'visual-kpi-design/design/overview', }, items: [ - 'visual-kpi-design/design/create-a-kpi', - 'visual-kpi-design/design/create-an-spc', - 'visual-kpi-design/design/create-a-chart', - 'visual-kpi-design/design/create-a-trend', - 'visual-kpi-design/design/create-a-table', - 'visual-kpi-design/design/create-a-group', - 'visual-kpi-design/design/create-navbar-links', - 'visual-kpi-design/design/target-and-limit-generator', + + { + type: 'category', + label: "Groups", + //className: '', + link: { + type: 'doc', + id: 'visual-kpi-design/design/groups', + }, + items: [ + 'visual-kpi-design/design/query-builder', + 'visual-kpi-design/design/group-maps', + ], + }, + + { + type: 'category', + label: "KPIs", + //className: '', + link: { + type: 'doc', + id: 'visual-kpi-design/design/kpis', + }, + items: [ + 'visual-kpi-design/design/kpis-sources', + 'visual-kpi-design/design/spc-kpis', + 'visual-kpi-design/design/kpis-trends', + ], + }, + + { + type: 'category', + label: "Charts", + //className: '', + link: { + type: 'doc', + id: 'visual-kpi-design/design/charts', + }, + items: [ + 'visual-kpi-design/design/bar-chart', + 'visual-kpi-design/design/gantt-chart', + 'visual-kpi-design/design/pareto-chart', + 'visual-kpi-design/design/pie-chart', + 'visual-kpi-design/design/xy-plots', + 'visual-kpi-design/design/query-based-chart', + 'visual-kpi-design/design/box-plots', + ], + }, + + 'visual-kpi-design/design/tables', + 'visual-kpi-design/design/trends', + ], }, - { + // { + // type: 'category', + // label: "Reference Tables", + // // className: '', + // link: { + // type: 'doc', + // id: 'visual-kpi-design/reference-tables', + // }, + // items: [ + // 'visual-kpi-design/reference-tables/website-reference', + // 'visual-kpi-design/reference-tables/profiles-dashboards-reference', + // 'visual-kpi-design/reference-tables/ranges-dates-reference', + // 'visual-kpi-design/reference-tables/contacts-alerts-reference', + // 'visual-kpi-design/reference-tables/features-configuration-reference', + // 'visual-kpi-design/reference-tables/advanced-reference', + // 'visual-kpi-design/reference-tables/groups-reference', + // 'visual-kpi-design/reference-tables/kpis-reference', + // 'visual-kpi-design/reference-tables/charts-reference', + // 'visual-kpi-design/reference-tables/tables-reference', + // 'visual-kpi-design/reference-tables/functions-reference', + // ], + // }, + /*{ type: 'doc', id: 'visual-kpi-design/best-practices', // label: 'How to Use the Documentation', // className: '', - } + },*/ ] \ No newline at end of file diff --git a/visual-kpi-docs/.sidebar/reference-guides/index.js b/visual-kpi-docs/.sidebar/reference-guides/index.js index a85a59b8..8aad6a56 100644 --- a/visual-kpi-docs/.sidebar/reference-guides/index.js +++ b/visual-kpi-docs/.sidebar/reference-guides/index.js @@ -1,9 +1,9 @@ module.exports = [ - { + /*{ type: 'doc', id: 'references/references', label: 'References', - }, + },*/ { type: 'category', label: "Setup and Administration", @@ -35,4 +35,80 @@ module.exports = [ }, ], }, + { + type: 'category', + label: "Visual KPI Designer", + link: { + type: 'doc', + id: 'references/visual-kpi-designer/visual-kpi-designer-references', + }, + items: [ + { + type: 'category', + label: "Data Limits", + items: [ + 'references/visual-kpi-designer/data-limits/data-limits-for-attributes', + 'references/visual-kpi-designer/data-limits/data-limits-for-default-ranges', + 'references/visual-kpi-designer/data-limits/data-limits-for-groups', + 'references/visual-kpi-designer/data-limits/data-limits-for-interfaces', + 'references/visual-kpi-designer/data-limits/data-limits-for-kpis', + 'references/visual-kpi-designer/data-limits/data-limits-for-links', + 'references/visual-kpi-designer/data-limits/data-limits-for-trend-ranges', + 'references/visual-kpi-designer/data-limits/data-limits-for-trends', + 'references/visual-kpi-designer/data-limits/data-limits-for-website-configuration' + ], + }, + /*{ + type: 'doc', + id: 'references/visual-kpi-designer/groups-attributes-keywords/groups-attributes-keywords', + },*/ + { + type: 'category', + label: "Attributes & Keywords", + items: [ + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-bar-charts', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-embedded-content', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-gantt-charts', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-groups', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-kpis', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-managed-trends', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-pareto-charts', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-pie-charts', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-tables', + 'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-xy-plots' + ], + }, + { + type: 'category', + label: "Site Settings", + items: [ + 'references/visual-kpi-designer/site-settings/site-settings-alerts', + 'references/visual-kpi-designer/site-settings/site-settings-chart-color', + 'references/visual-kpi-designer/site-settings/site-settings-chart-dates', + 'references/visual-kpi-designer/site-settings/site-settings-chart-ranges', + 'references/visual-kpi-designer/site-settings/site-settings-contacts', + 'references/visual-kpi-designer/site-settings/site-settings-dashboards', + 'references/visual-kpi-designer/site-settings/site-settings-default-ranges', + 'references/visual-kpi-designer/site-settings/site-settings-event-ranges', + 'references/visual-kpi-designer/site-settings/site-settings-features', + 'references/visual-kpi-designer/site-settings/site-settings-kpi-status', + 'references/visual-kpi-designer/site-settings/site-settings-profile-groups', + 'references/visual-kpi-designer/site-settings/site-settings-profiles', + 'references/visual-kpi-designer/site-settings/site-settings-visual-kpi-website', + ], + }, + { + type: 'category', + label: "Advanced Site Settings", + items: [ + 'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-attributes', + 'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-interfaces', + 'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-nav-bar-links', + 'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-site-rollups' + ], + }, + + ], + }, + ] \ No newline at end of file diff --git a/visual-kpi-docs/.sidebar/setup-adm/index.js b/visual-kpi-docs/.sidebar/setup-adm/index.js index cbf28dba..b391b5d7 100644 --- a/visual-kpi-docs/.sidebar/setup-adm/index.js +++ b/visual-kpi-docs/.sidebar/setup-adm/index.js @@ -9,9 +9,9 @@ module.exports = [ }, installation, interfaces, - automation, - { + //automation, + /*{ type: 'doc', id: 'setup-and-administration/best-practices', - }, + },*/ ]; diff --git a/visual-kpi-docs/.sidebar/supporting-pages/index.js b/visual-kpi-docs/.sidebar/supporting-pages/index.js index 74525ac7..176c16e0 100644 --- a/visual-kpi-docs/.sidebar/supporting-pages/index.js +++ b/visual-kpi-docs/.sidebar/supporting-pages/index.js @@ -4,7 +4,7 @@ module.exports = [ id: 'supporting-pages/faqs', label: 'FAQs', }, - { + /*{ type: 'doc', id: 'supporting-pages/troubleshooting', label: 'Troubleshooting', @@ -13,7 +13,7 @@ module.exports = [ type: 'doc', id: 'supporting-pages/training', label: 'Training', - }, + },*/ { type: 'doc', id: 'supporting-pages/glossary', diff --git a/visual-kpi-docs/docs/core-concepts/core-concepts.mdx b/visual-kpi-docs/docs/core-concepts/core-concepts.mdx index 7cff8288..5288cdb6 100644 --- a/visual-kpi-docs/docs/core-concepts/core-concepts.mdx +++ b/visual-kpi-docs/docs/core-concepts/core-concepts.mdx @@ -3,7 +3,7 @@ id: core-concepts title: Core concepts slug: /core-concepts description: 'Learn about the core concepts related to Transpara Visual KPI.' -tags: [] +tags: ['documentation'] --- In this section, you can learn the essential ideas to become a pro at using Visual KPI. These concepts lay the groundwork for a better understanding of the software, making it easier to get started. diff --git a/visual-kpi-docs/docs/core-concepts/hierarchy.mdx b/visual-kpi-docs/docs/core-concepts/hierarchy.mdx index f0f7cbc1..b2749996 100644 --- a/visual-kpi-docs/docs/core-concepts/hierarchy.mdx +++ b/visual-kpi-docs/docs/core-concepts/hierarchy.mdx @@ -3,7 +3,7 @@ id: hierarchy title: Hierarchy/Groups slug: /core-concepts/hierarchy description: 'Define and describe how hierarchy works inside Visual KPI.' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/core-concepts/kpi.mdx b/visual-kpi-docs/docs/core-concepts/kpi.mdx index 3e14c04e..24a077e8 100644 --- a/visual-kpi-docs/docs/core-concepts/kpi.mdx +++ b/visual-kpi-docs/docs/core-concepts/kpi.mdx @@ -3,7 +3,7 @@ id: kpi title: KPI slug: /core-concepts/kpi description: 'Define and describes what a kpi is.' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/time.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/time.mdx index 57ec4381..ecfc0e62 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/time.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/time.mdx @@ -40,7 +40,7 @@ You can use offset time, which means that you call data based on a specific time You can keep it simple or make it as sophisticated as you want when using Visual KPI's relative time functions. Using the symbol for "now"(*) as your end time, the right edge of your trends will show the most recent value available from your data source for that item. If you use the function "y" as your end time, the right edge of your trend will show the most recent value before midnight yesterday. The same is true for start times. -You can also combine functions to get something crazy (or powerful, if you prefer), like a start time defined as "go back 12 days, then show the beginning of whatever month that is, and then show what the value was at noon on that day." Using relative time functions in Visual KPI, that would be represented as `noon(bom(*-2d)).` +You can also combine functions to get something crazy (or powerful, if you prefer), like a start time defined as "go back 12 days, then show the beginning of whatever month that's, and then show what the value was at noon on that day." Using relative time functions in Visual KPI, that would be represented as `noon(bom(*-2d)).` Here are some examples of how you can combine relative time functions: - Beginning of this month = bom(*) diff --git a/visual-kpi-docs/docs/end-user/overview.mdx b/visual-kpi-docs/docs/end-user/overview.mdx index 6b1417ab..16cdb199 100644 --- a/visual-kpi-docs/docs/end-user/overview.mdx +++ b/visual-kpi-docs/docs/end-user/overview.mdx @@ -3,7 +3,7 @@ id: overview title: End Users slug: overview description: 'The End User documentation section will guide you on how to use the Visual KPI solution.' -tags: [] +tags: ['documentation'] --- The Visual KPI End-User Guide was designed specifically for new users to help you navigate and make the most out of your Visual KPI software. This guide aims to provide a comprehensive understanding of Visual KPI features, functionalities, and how to effectively use the application to monitor, analyze, and manage your KPIs in real-time. Here, you'll learn what Visual KPI is, its capabilities, and how it can transform your data into actionable insights. Transpara's Visual KPI software offers comprehensive features and functionalities for end-users, such as dashboards, trends, and many visualization options. It's a user-friendly interface with robust tools for working with all kinds of KPIs. diff --git a/visual-kpi-docs/docs/get-started/access-level.mdx b/visual-kpi-docs/docs/get-started/access-level.mdx index cdc80e0e..6d9f4409 100644 --- a/visual-kpi-docs/docs/get-started/access-level.mdx +++ b/visual-kpi-docs/docs/get-started/access-level.mdx @@ -3,5 +3,5 @@ id: access-level title: Access Levels slug: /get-started/access-level description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/get-started/data-update-and-timestamp.mdx b/visual-kpi-docs/docs/get-started/data-update-and-timestamp.mdx index 7ee00ac5..23bf6782 100644 --- a/visual-kpi-docs/docs/get-started/data-update-and-timestamp.mdx +++ b/visual-kpi-docs/docs/get-started/data-update-and-timestamp.mdx @@ -3,5 +3,5 @@ id: data-update-and-timestamp title: Data Update and Timestamp slug: /get-started/data-update-and-timestamp description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/get-started/navigation.mdx b/visual-kpi-docs/docs/get-started/navigation.mdx index d20d5e5d..0495b95b 100644 --- a/visual-kpi-docs/docs/get-started/navigation.mdx +++ b/visual-kpi-docs/docs/get-started/navigation.mdx @@ -3,5 +3,5 @@ id: navigation title: Navigation slug: /get-started/navigation description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/get-started/notifications.mdx b/visual-kpi-docs/docs/get-started/notifications.mdx index 243d1fd5..75db89a9 100644 --- a/visual-kpi-docs/docs/get-started/notifications.mdx +++ b/visual-kpi-docs/docs/get-started/notifications.mdx @@ -3,5 +3,5 @@ id: notifications title: Notifications slug: /get-started/notifications description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/get-started/objects.mdx b/visual-kpi-docs/docs/get-started/objects.mdx index d9b930f7..dcd394a1 100644 --- a/visual-kpi-docs/docs/get-started/objects.mdx +++ b/visual-kpi-docs/docs/get-started/objects.mdx @@ -3,5 +3,5 @@ id: objects title: Objects slug: /get-started/objects description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/get-started/overview.mdx b/visual-kpi-docs/docs/get-started/overview.mdx index 67513e15..e0866578 100644 --- a/visual-kpi-docs/docs/get-started/overview.mdx +++ b/visual-kpi-docs/docs/get-started/overview.mdx @@ -3,5 +3,5 @@ id: overview title: Get Started slug: /get-started description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/get-started/visual-kpi-core-concepts.mdx b/visual-kpi-docs/docs/get-started/visual-kpi-core-concepts.mdx index f27f4db5..62ff5c87 100644 --- a/visual-kpi-docs/docs/get-started/visual-kpi-core-concepts.mdx +++ b/visual-kpi-docs/docs/get-started/visual-kpi-core-concepts.mdx @@ -3,5 +3,5 @@ id: visual-kpi-core-concepts title: Visual KPI Core Concepts slug: /get-started/visual-kpi-core-concepts description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/get-started/ways-to-use-visual-kpis.mdx b/visual-kpi-docs/docs/get-started/ways-to-use-visual-kpis.mdx index 38e39d6d..a029013f 100644 --- a/visual-kpi-docs/docs/get-started/ways-to-use-visual-kpis.mdx +++ b/visual-kpi-docs/docs/get-started/ways-to-use-visual-kpis.mdx @@ -3,5 +3,5 @@ id: ways-to-use-visual-kpi title: Ways to Use Visual KPI slug: /get-started/ways-to-use-visual-kpi description: '' -tags: [] +tags: ['documentation'] --- diff --git a/visual-kpi-docs/docs/how-to-use-the-documentation.mdx b/visual-kpi-docs/docs/how-to-use-the-documentation.mdx index 6a7d04b4..57ab788e 100644 --- a/visual-kpi-docs/docs/how-to-use-the-documentation.mdx +++ b/visual-kpi-docs/docs/how-to-use-the-documentation.mdx @@ -3,7 +3,7 @@ id: how-to-use-the-documentation title: How to Use the Documentation slug: /how-to-use-the-documentation description: 'Learn about the user types and how to use Visual KPI documentation.' -tags: [] +tags: ['documentation'] --- On this page, we describe the different Visual KPI user types and options available for them. From this page, we define the paths specific content each user should cover to optimize their time and learning curve, focusing on what you need to accomplish your goals. diff --git a/visual-kpi-docs/docs/how-visual-kpi-works.mdx b/visual-kpi-docs/docs/how-visual-kpi-works.mdx index 958a7042..0f29f054 100644 --- a/visual-kpi-docs/docs/how-visual-kpi-works.mdx +++ b/visual-kpi-docs/docs/how-visual-kpi-works.mdx @@ -3,7 +3,7 @@ id: how-visual-kpi-works title: How Visual KPI Works slug: /how-visual-kpi-works description: 'Discover how Visual KPI is structured and works.' -tags: [] +tags: ['documentation'] --- At the core of Visual KPI is its ability to effortlessly integrate with your existing operations. Visual KPI flexibility is one of its defining features. In addition to supporting thousands of data sources, it provides customizable deployment options and security functionalities to cover all industries and businesses. diff --git a/visual-kpi-docs/docs/references/references.mdx b/visual-kpi-docs/docs/references/references.mdx index 2ed94252..c15d3b40 100644 --- a/visual-kpi-docs/docs/references/references.mdx +++ b/visual-kpi-docs/docs/references/references.mdx @@ -3,7 +3,7 @@ id: references title: References slug: /references description: 'This pages could be used to list the existing reference pages. In the future, we could move from the knowladge base to the documentation.' -tags: [] +tags: ['documentation'] --- import LinkCards from '@site/src/components/Cards/LinkCards'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/group.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/group.mdx index 093aa734..72d0c796 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/group.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/group.mdx @@ -3,7 +3,7 @@ id: group-keywords title: Group Keywords slug: /reference/setup-and-administration/af-databases/group-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/setup-adm/automation/keywords/group.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/kpi.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/kpi.mdx index 6c223335..aa0349cf 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/kpi.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/kpi.mdx @@ -3,7 +3,7 @@ id: kpi-keywords title: KPI Keywords slug: /reference/setup-and-administration/af-databases/kpi-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/setup-adm/automation/keywords/kpi.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/table.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/table.mdx index 6b7df8b5..0bbebcee 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/table.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/table.mdx @@ -3,7 +3,7 @@ id: table-keywords title: Table Keywords slug: /reference/setup-and-administration/af-databases/table-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/setup-adm/automation/keywords/table.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/trend.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/trend.mdx index 8af13672..2e0a4271 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/trend.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/trend.mdx @@ -3,7 +3,7 @@ id: trend-keywords title: Trend Keywords slug: /reference/setup-and-administration/af-databases/trend-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/setup-adm/automation/keywords/trend.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/value.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/value.mdx index 437d18a2..bd51a40f 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/value.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/value.mdx @@ -3,7 +3,7 @@ id: value-keywords title: Value Keywords slug: /reference/setup-and-administration/af-databases/value-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/setup-adm/automation/keywords/value.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/index.mdx b/visual-kpi-docs/docs/references/setup-and-administration/index.mdx index 6c8114c6..74fe03ed 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/index.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/index.mdx @@ -3,7 +3,7 @@ id: setup-and-administration-reference title: Setup and Administration Reference slug: /reference/setup-and-administration-reference description: 'This pages could be used to list the existing reference pages. In the future, we could move from the knowladge base to the documentation.' -tags: [] +tags: ['documentation'] --- import LinkCards from '@site/src/components/Cards/LinkCards'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/charts.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/charts.mdx index 03cf7cbd..40985632 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/charts.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/charts.mdx @@ -3,7 +3,7 @@ id: charts-keywords title: Charts Attributes slug: /reference/setup-and-administration/sql-databases/charts-keywords description: '' -tags: [] +tags: ['documentation'] --- import BarCharts from '@site/static/data/tables/charts-attributes-keywords-reference/BarCharts.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/group.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/group.mdx index 13283ca1..e532cc8f 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/group.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/group.mdx @@ -3,7 +3,7 @@ id: group-keywords title: Groups Attributes slug: /reference/setup-and-administration/sql-databases/group-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/groups-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/kpi.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/kpi.mdx index 93940e15..040e27ae 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/kpi.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/kpi.mdx @@ -3,7 +3,7 @@ id: kpi-keywords title: KPIs Attributes slug: /reference/setup-and-administration/sql-databases/kpi-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/kpi-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json'; diff --git a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/table.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/table.mdx index ee033093..55610fad 100644 --- a/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/table.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/table.mdx @@ -3,7 +3,7 @@ id: table-keywords title: Table Attributes slug: /reference/setup-and-administration/sql-databases/table-keywords description: '' -tags: [] +tags: ['documentation'] --- import table from '@site/static/data/tables/tables-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json'; diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/attributes.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/attributes.mdx new file mode 100644 index 00000000..efa775ce --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/attributes.mdx @@ -0,0 +1,15 @@ +--- +id: advanced-site-settings-attributes +title: Attributes +slug: /reference/visual-kpi-designer/advanced-site-settings/attributes +description: '' +tags: ['Advanced Site Settings Reference'] +--- + +import table from '@site/static/data/tables/advanced-site-settings-reference/Attributes.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Site settings affect your entire site, so some of the things you configure will either become available in Visual KPI Designer as you create KPIs and other objects, or they'll show up on your Visual KPI site. You'll find Advanced settings under the Site Settings icon () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/interfaces.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/interfaces.mdx new file mode 100644 index 00000000..2300fc8d --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/interfaces.mdx @@ -0,0 +1,15 @@ +--- +id: advanced-site-settings-interfaces +title: Interfaces +slug: /reference/visual-kpi-designer/advanced-site-settings/interfaces +description: '' +tags: ['Advanced Site Settings Reference'] +--- + +import table from '@site/static/data/tables/advanced-site-settings-reference/Interfaces.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Site settings affect your entire site, so some of the things you configure will either become available in Visual KPI Designer as you create KPIs and other objects, or they'll show up on your Visual KPI site. You'll find Advanced settings under the Site Settings icon () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/nav-bar-links.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/nav-bar-links.mdx new file mode 100644 index 00000000..57784d70 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/nav-bar-links.mdx @@ -0,0 +1,15 @@ +--- +id: advanced-site-settings-nav-bar-links +title: Nav Bar Links +slug: /reference/visual-kpi-designer/advanced-site-settings/nav-bar-links +description: '' +tags: ['Advanced Site Settings Reference'] +--- + +import table from '@site/static/data/tables/advanced-site-settings-reference/NavBarLinks.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Site settings affect your entire site, so some of the things you configure will either become available in Visual KPI Designer as you create KPIs and other objects, or they'll show up on your Visual KPI site. You'll find Advanced settings under the Site Settings icon () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/site-rollups.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/site-rollups.mdx new file mode 100644 index 00000000..84ff8188 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/advanced-site-settings/site-rollups.mdx @@ -0,0 +1,15 @@ +--- +id: advanced-site-settings-site-rollups +title: Site Rollups +slug: /reference/visual-kpi-designer/advanced-site-settings/site-rollups +description: '' +tags: ['Advanced Site Settings Reference'] +--- + +import table from '@site/static/data/tables/advanced-site-settings-reference/SiteRollups.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Site settings affect your entire site, so some of the things you configure will either become available in Visual KPI Designer as you create KPIs and other objects, or they'll show up on your Visual KPI site. You'll find Advanced settings under the Site Settings icon () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/bar-charts.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/bar-charts.mdx new file mode 100644 index 00000000..73d9b66c --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/bar-charts.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-bar-charts +title: Bar Charts +slug: /reference/visual-kpi-designer/attributes-and-keywords/bar-charts +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/charts-attributes-keywords-reference/BarCharts.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/embedded-content.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/embedded-content.mdx new file mode 100644 index 00000000..327e1dff --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/embedded-content.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-embedded-content +title: Embedded Content +slug: /reference/visual-kpi-designer/attributes-and-keywords/embedded-content +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/charts-attributes-keywords-reference/EmbeddedContent.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/gantt-charts.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/gantt-charts.mdx new file mode 100644 index 00000000..09e66931 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/gantt-charts.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-gantt-charts +title: Gantt Charts +slug: /reference/visual-kpi-designer/attributes-and-keywords/gantt-charts +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/charts-attributes-keywords-reference/GanttCharts.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/groups.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/groups.mdx new file mode 100644 index 00000000..9c48699f --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/groups.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-groups +title: Groups +slug: /reference/visual-kpi-designer/attributes-and-keywords/groups +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/groups-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/kpis.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/kpis.mdx new file mode 100644 index 00000000..ad84b1cd --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/kpis.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-kpis +title: KPIs +slug: /reference/visual-kpi-designer/attributes-and-keywords/kpis +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/kpi-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/managed-trends.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/managed-trends.mdx new file mode 100644 index 00000000..a1b4a622 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/managed-trends.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-managed-trends +title: Managed Trends +slug: /reference/visual-kpi-designer/attributes-and-keywords/managed-trends +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/charts-attributes-keywords-reference/ManagedTrends.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/pareto-charts.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/pareto-charts.mdx new file mode 100644 index 00000000..f45fda3b --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/pareto-charts.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-pareto-charts +title: Pareto Charts +slug: /reference/visual-kpi-designer/attributes-and-keywords/pareto-charts +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/charts-attributes-keywords-reference/ParetoCharts.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/pie-charts.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/pie-charts.mdx new file mode 100644 index 00000000..1c696d86 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/pie-charts.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-pie-charts +title: Pie Charts +slug: /reference/visual-kpi-designer/attributes-and-keywords/pie-charts +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/charts-attributes-keywords-reference/PieCharts.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/tables.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/tables.mdx new file mode 100644 index 00000000..b180be4b --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/tables.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-tables +title: Tables +slug: /reference/visual-kpi-designer/attributes-and-keywords/tables +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/tables-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/xy-plots.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/xy-plots.mdx new file mode 100644 index 00000000..eec21f43 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/attributes-and-keywords/xy-plots.mdx @@ -0,0 +1,12 @@ +--- +id: attributes-and-keywords-xy-plots +title: XY Plots +slug: /reference/visual-kpi-designer/attributes-and-keywords/xy-plots +description: '' +tags: ['Attributes & Keywords'] +--- + +import table from '@site/static/data/tables/charts-attributes-keywords-reference/XYPlots.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/attributes.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/attributes.mdx new file mode 100644 index 00000000..7602b2cc --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/attributes.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-attributes +title: Attributes +slug: /reference/visual-kpi-designer/data-limits/attributes +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/Attributes.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Attributes. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/default-range.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/default-range.mdx new file mode 100644 index 00000000..8dbf53c1 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/default-range.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-default-ranges +title: Default Ranges +slug: /reference/visual-kpi-designer/data-limits/default-ranges +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/DefaultRange.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Default Ranges. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/groups.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/groups.mdx new file mode 100644 index 00000000..ba3049d4 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/groups.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-groups +title: Groups +slug: /reference/visual-kpi-designer/data-limits/groups +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/Groups.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Groups. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/interfaces.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/interfaces.mdx new file mode 100644 index 00000000..e0b74031 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/interfaces.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-interfaces +title: Interfaces +slug: /reference/visual-kpi-designer/data-limits/interfaces +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/Interfaces.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Interfaces. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/kpis.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/kpis.mdx new file mode 100644 index 00000000..77a6d1c8 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/kpis.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-kpis +title: KPIs +slug: /reference/visual-kpi-designer/data-limits/kpis +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/KPIs.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to KPIs. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/links.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/links.mdx new file mode 100644 index 00000000..a9d3d03d --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/links.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-links +title: Links +slug: /reference/visual-kpi-designer/data-limits/links +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/Links.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Links. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/trend-ranges.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/trend-ranges.mdx new file mode 100644 index 00000000..f846ee6d --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/trend-ranges.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-trend-ranges +title: Trend Ranges +slug: /reference/visual-kpi-designer/data-limits/trend-ranges +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/TrendRanges.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Trend Rages. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/trends.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/trends.mdx new file mode 100644 index 00000000..87fd3a88 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/trends.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-trends +title: Trends +slug: /reference/visual-kpi-designer/data-limits/trends +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/Trends.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Trends. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/website-configuration.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/website-configuration.mdx new file mode 100644 index 00000000..6b3568fd --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/data-limits/website-configuration.mdx @@ -0,0 +1,27 @@ +--- +id: data-limits-for-website-configuration +title: Website Configuration +slug: /reference/visual-kpi-designer/data-limits/website-configuration +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/data-limits/WebsiteConfiguration.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +Visual KPI Designer offers four distinct field types, each serving specific purposes: + +- **Text**: Accepts alphanumeric characters. +- **Numbers**: Accepts integers exclusively. +- **List Selection**: Enables users to choose from predefined lists. +- **Automatically Assigned**. + +Each field type has predefined limits: + +- Text fields limit indicates the maximum character count allowed. +- List Selection is limited by the options available. +- Numbers and Automatically Assigned fields don't have limitations. + +Below you find a table describing the limits of all group fields related to Website Configuration. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/groups-attributes-keywords/groups-attributes-keywords.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/groups-attributes-keywords/groups-attributes-keywords.mdx new file mode 100644 index 00000000..15fe3299 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/groups-attributes-keywords/groups-attributes-keywords.mdx @@ -0,0 +1,16 @@ +--- +id: groups-attributes-keywords +title: Groups Attributes and Keywords +slug: /reference/visual-kpi-designer/groups-attributes-keywords +description: '' +tags: ['documentation'] +--- + +import table from '@site/static/data/tables/groups-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; + +This table serves as a guide for associating metadata attributes and keywords from AF, SQL, and inmation databases with Visual KPI Remote Context Service (RCS). + +The first column denotes the Visual KPI Attribute that corresponds to your external elements. Refer to the Value column for detailed information about specific attribute values. The last three columns indicate whether such mapping is feasible within AF, SQL, or inmation databases. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/alerts.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/alerts.mdx new file mode 100644 index 00000000..48b3e993 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/alerts.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-alerts +title: Alerts +slug: /reference/visual-kpi-designer/site-settings/alerts +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/contacts-alerts-site-settings-reference/Alerts.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The site settings described on this page affect the entire Visual KPI site. The configured settings create templates that will be available for end-users as they configure alerts for individual KPIs. The settings include the alert type, the type of information to be included in the alert e-mail, alert intervals, and other parameters. You find the Alerts configurations under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-color-configuration.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-color-configuration.mdx new file mode 100644 index 00000000..18224d61 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-color-configuration.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-chart-color +title: Chart Color +slug: /reference/visual-kpi-designer/site-settings/chart-color +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/features-configuration-site-settings-reference/ChartColorConfiguration.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The site settings described on this page affect the entire Visual KPI site. The available setting will change the appearance of all charts available in your Visual KPI instance. You find the Chat Color Configuration under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-dates.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-dates.mdx new file mode 100644 index 00000000..0918806e --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-dates.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-chart-dates +title: Chart Dates +slug: /reference/visual-kpi-designer/site-settings/chart-dates +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/ranges-dates-site-settings-reference/ChartDates.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Chart Dates settings allow you to define chart names and the time represented. You find the Chart Dates Configuration under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-ranges.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-ranges.mdx new file mode 100644 index 00000000..0aea9eb9 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/chart-ranges.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-chart-ranges +title: Chart Ranges +slug: /reference/visual-kpi-designer/site-settings/chart-ranges +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/ranges-dates-site-settings-reference/ChartRanges.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Chart Ranges allow you to define the time ranges available for end-users when accessing charts trends in your Visual KPI instance. You find the Chart Dates Configuration under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/contacts.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/contacts.mdx new file mode 100644 index 00000000..c6f577ba --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/contacts.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-contacts +title: Contacts +slug: /reference/visual-kpi-designer/site-settings/contacts +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/contacts-alerts-site-settings-reference/Contacts.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The site settings described on this page affect the entire Visual KPI site. The configured settings make new contacts available in your Visual KPI instance. Users can refer to these contacts when seeking help, or you can use them when creating new KPI alerts. You find the Alerts configurations under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/dashboards.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/dashboards.mdx new file mode 100644 index 00000000..b1319338 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/dashboards.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-dashboards +title: Dashboards +slug: /reference/visual-kpi-designer/site-settings/dashboards +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/profiles-dashboards-site-settings-reference/Dashboards.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The Dashboard settings described on this page allow you to configure defaults and related profiles for Visual KPI Dashboards. The Dashboards dashboards are a custom layout of visualizations, KPIs, links, trends, tables, embedded content and any other object supported by Visual KPI. You find the Dashboard configurations under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/default-ranges.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/default-ranges.mdx new file mode 100644 index 00000000..8ac52650 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/default-ranges.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-default-ranges +title: Default Ranges +slug: /reference/visual-kpi-designer/site-settings/default-ranges +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/ranges-dates-site-settings-reference/DefaultRanges.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Default Ranges allow you to define the trend ranges that will be used as the defaults for Trends and Sparklines on Visual KPI trends. The available settings enable you to configure the default time ranges to be applied in all trends and charts available for end-users when accessing your Visual KPI instance. You find the Default Ranges Configuration under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/event-ranges.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/event-ranges.mdx new file mode 100644 index 00000000..74af4f1c --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/event-ranges.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-event-ranges +title: Event Ranges +slug: /reference/visual-kpi-designer/site-settings/event-ranges +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/ranges-dates-site-settings-reference/EventRanges.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Event Ranges allow you to define custom ranges and actions for everything, including time ranges for data retrieval queries, database time zones, and filter settings. You find the Event Ranges configurations under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/features-configuration.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/features-configuration.mdx new file mode 100644 index 00000000..365c7c9d --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/features-configuration.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-features +title: Features +slug: /reference/visual-kpi-designer/site-settings/features +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/features-configuration-site-settings-reference/FeaturesConfiguration.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The site settings described on this page affect the entire Visual KPI site. The available setting will change the features available for your end-users when using your Visual KPI instance. You find the Feature Configuration under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/kpi-status-configuration.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/kpi-status-configuration.mdx new file mode 100644 index 00000000..34425c7b --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/kpi-status-configuration.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-kpi-status +title: KPI Status +slug: /reference/visual-kpi-designer/site-settings/kpi-status +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/features-configuration-site-settings-reference/KPIStatusConfiguration.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The site settings described on this page affect the entire Visual KPI site. The available setting will change the KPI features available for your end-users when using your Visual KPI instance. You find the KPI Status Configuration under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/profile-groups.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/profile-groups.mdx new file mode 100644 index 00000000..6ebe1e3e --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/profile-groups.mdx @@ -0,0 +1,15 @@ +--- +id: site-settings-profile-groups +title: Profiles Groups +slug: /reference/visual-kpi-designer/site-settings/profiles-groups +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/profiles-dashboards-site-settings-reference/ProfileGroups.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The Profiles Groups settings described on this page allow you to manage profiles in groups, enable or disable access, and lock down editing capabilities. You find the Profiles Groups configurations under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/profiles.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/profiles.mdx new file mode 100644 index 00000000..cf1c654f --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/profiles.mdx @@ -0,0 +1,16 @@ +--- +id: site-settings-profiles +title: Profiles +slug: /reference/visual-kpi-designer/site-settings/profiles +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/profiles-dashboards-site-settings-reference/Profiles.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The Profiles Groups settings described on this page allow you to define and manage Visual KPI profiles directly from the Visual KPI Designer. +You find the Profiles Groups configurations under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/visual-kpi-website.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/visual-kpi-website.mdx new file mode 100644 index 00000000..ccbdb640 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/site-settings/visual-kpi-website.mdx @@ -0,0 +1,16 @@ +--- +id: site-settings-visual-kpi-website +title: Visual KPI Website +slug: /reference/visual-kpi-designer/site-settings/visual-kpi-website +description: '' +tags: ['Site Settings'] +--- + +import table from '@site/static/data/tables/website-settings-reference/WebsiteSettings.json'; +import JsonToTable from '@site/src/components/Table/JsonToTable'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The Website settings described on this page allow you to define basic configuration information for your Visual KPI instances. +You find the Website configurations under Site Settings () in the Document Actions panel. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/references/visual-kpi-designer/visual-kpi-designer-references.mdx b/visual-kpi-docs/docs/references/visual-kpi-designer/visual-kpi-designer-references.mdx new file mode 100644 index 00000000..dd5e8318 --- /dev/null +++ b/visual-kpi-docs/docs/references/visual-kpi-designer/visual-kpi-designer-references.mdx @@ -0,0 +1,182 @@ +--- +id: visual-kpi-designer-references +title: Visual KPI Designer References +slug: /reference/visual-kpi-designer-references +description: '' +tags: ['documentation'] +--- + +import LinkCards from '@site/src/components/Cards/LinkCards'; + +## Data Limits + + + +## Attributes & Keywords + + + +## Site Settings + + + +## Advanced Settings + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/automation.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/automation.mdx index 50398063..98890292 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/automation.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/automation.mdx @@ -2,8 +2,8 @@ id: automation title: Automation slug: /setup-and-administration/automation -description: 'Covers the Remote Context Server (RCS) content. Here subpages are required, once it is a complex topic.' -tags: [] +description: "Covers the Remote Context Server (RCS) content. Here subpages are required, once it's a complex topic." + --- import LinkCards from '@site/src/components/Cards/LinkCards'; diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx index 75910ff9..38c65959 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx @@ -3,7 +3,7 @@ id: rcs-with-af-databases title: RCS with AF databases slug: /setup-and-administration/automation/rcs-with-af-databases description: 'Describe RCS with AF databases.' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/how-to-use-the-rcs.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/how-to-use-the-rcs.mdx index 358df2ed..20671313 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/how-to-use-the-rcs.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/how-to-use-the-rcs.mdx @@ -3,7 +3,7 @@ id: rcs-configuration title: RCS Configuration slug: /setup-and-administration/automation/rcs-configuration description: 'Describe how to use the RCS.' -tags: [] +tags: ['documentation'] --- import LinkCards from '@site/src/components/Cards/LinkCards'; diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx index 986cc8d6..a0f5695c 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx @@ -3,7 +3,7 @@ id: rcs-with-sql-databases title: RCS with SQL databases slug: /setup-and-administration/automation/rcs-with-sql-databases description: 'Describe RCS with SQL databases.' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-tutorial.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-tutorial.mdx index 60eee3ce..d68ab6a8 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-tutorial.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-tutorial.mdx @@ -3,7 +3,7 @@ id: rcs-sql-tutorial title: SQL Tutorial slug: /setup-and-administration/automation/rcs-sql-tutorial description: 'RCS with SQL tutorial.' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; @@ -22,7 +22,7 @@ The next steps walk you through creating a working SQL remote context server and What you will need before starting the tutorial: - An installed version of [Visual KPI Server Manager](/docs/setup-and-administration/installation/install-visual-kpi) on a machine with all the [prerequisites and required permissions](/docs/setup-and-administration/installation/prepare-your-system). -- An installed version of [Visual KPI Designer](/docs/visual-kpi-design/installation). +- An installed version of [Visual KPI Designer](/docs/visual-kpi-design/installation-and-setup/overview). - Access (admin) to a SQL Server. This is necessary to create two databases. One of them is installed by the Server Manager for Visual KPI, while the other will be created manually and populated via a SQL script. - The scripts required to follow this tutorial, found here: [**SQLRCSTutorialScripts.zip**](https://www.transpara.com/wp-content/uploads/SQLRCSTutorialScripts.zip). diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/rcs-and-visual-kpi-design.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/rcs-and-visual-kpi-design.mdx index 479295e1..78e4d8f4 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/rcs-and-visual-kpi-design.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/rcs-and-visual-kpi-design.mdx @@ -3,7 +3,7 @@ id: rcs-and-visual-kpi-design title: RCS and Visual KPI Design slug: /setup-and-administration/automation/rcs-and-visual-kpi-design description: 'This page will address using the RCS and the Visual KPI Design. It will provide instructions for users after they import their data to Visual KPI and need to configure its presentation. The idea is to show that they will need to perform some actions with the Visual KPI to finish the configuration.' -tags: [] +tags: ['documentation'] --- This page will address how to use the RCS and the Visual KPI Design. It will provide the instructions necessary for users after they import their data to Visual KPI and need to configure its presentation. The idea is to show that they will need to perform some actions with the Visual KPI to finish the configuration. diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/rcs.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/rcs.mdx index e389a95d..d6656372 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/rcs.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/rcs.mdx @@ -3,7 +3,7 @@ id: rcs title: Remote Context Server (RCS) slug: /setup-and-administration/automation/rcs description: 'Describes what the RCS is.' -tags: [] +tags: ['documentation'] --- Visual KPI RCS allows you to configure Visual KPI dynamically or automatically, using information from another system or external application as the primary source of metadata. diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/use-cases.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/use-cases.mdx index bb6c3216..23575462 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/use-cases.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/use-cases.mdx @@ -3,7 +3,7 @@ id: use-cases title: Automation Use Cases slug: /setup-and-administration/automation/use-cases description: 'This page will present a list of use cases showing how to use the automation solution combined with different KPI sources. Each source will have its own page showing the necessary steps.' -tags: [] +tags: ['documentation'] --- This page will present a list of use cases showing how to use the automation solution combined with different KPI sources. Each source will have its own page showing the necessary steps. diff --git a/visual-kpi-docs/docs/setup-and-administration/best-practices.mdx b/visual-kpi-docs/docs/setup-and-administration/best-practices.mdx index 54ee0cd8..41bb71b8 100644 --- a/visual-kpi-docs/docs/setup-and-administration/best-practices.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/best-practices.mdx @@ -3,7 +3,7 @@ id: best-practices title: Best Practices slug: /setup-and-administration/best-practices description: 'List and describe the best practices that the system administrator can follow.' -tags: [] +tags: ['documentation'] --- List and describe the best practices that the system administrator can follow. diff --git a/visual-kpi-docs/docs/setup-and-administration/installation/install-visual-kpi.mdx b/visual-kpi-docs/docs/setup-and-administration/installation/install-visual-kpi.mdx index 87460b01..a277d62d 100644 --- a/visual-kpi-docs/docs/setup-and-administration/installation/install-visual-kpi.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/installation/install-visual-kpi.mdx @@ -3,7 +3,7 @@ id: install-visual-kpi title: Install Visual Kpi slug: /setup-and-administration/installation/install-visual-kpi description: 'Presents the steps the administrator must follow to install Visual KPI into their server or cloud.' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/setup-and-administration/installation/overview.mdx b/visual-kpi-docs/docs/setup-and-administration/installation/overview.mdx index 4f8daeda..ebd4bc8c 100644 --- a/visual-kpi-docs/docs/setup-and-administration/installation/overview.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/installation/overview.mdx @@ -3,7 +3,7 @@ id: overview title: Installation slug: /setup-and-administration/installation/overview description: 'Presents the overview regarding the installation process and links the available pages.' -tags: [] +tags: ['documentation'] --- import LinkCards from '@site/src/components/Cards/LinkCards'; diff --git a/visual-kpi-docs/docs/setup-and-administration/installation/prepare-your-system.mdx b/visual-kpi-docs/docs/setup-and-administration/installation/prepare-your-system.mdx index eb867521..a4bfc75c 100644 --- a/visual-kpi-docs/docs/setup-and-administration/installation/prepare-your-system.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/installation/prepare-your-system.mdx @@ -3,7 +3,7 @@ id: prepare-your-system title: Prepare Your System slug: /setup-and-administration/installation/prepare-your-system description: 'Describes the actions the administrator needs to take to prepare their server or cloud befre installing the Visual KPI software.' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/setup-and-administration/installation/system-update.mdx b/visual-kpi-docs/docs/setup-and-administration/installation/system-update.mdx index 6b4986d5..1dc8b73e 100644 --- a/visual-kpi-docs/docs/setup-and-administration/installation/system-update.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/installation/system-update.mdx @@ -3,7 +3,7 @@ id: system-update title: System Update slug: /setup-and-administration/installation/system-update description: 'Describes how to perform the software update.' -tags: [] +tags: ['documentation'] --- import IframeComponent from '@site/src/components/Video/IframeComponent'; diff --git a/visual-kpi-docs/docs/setup-and-administration/installation/website-and-virtual-directory-structure.mdx b/visual-kpi-docs/docs/setup-and-administration/installation/website-and-virtual-directory-structure.mdx index 2464885c..b8fede2a 100644 --- a/visual-kpi-docs/docs/setup-and-administration/installation/website-and-virtual-directory-structure.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/installation/website-and-virtual-directory-structure.mdx @@ -3,7 +3,7 @@ id: website-and-virtual-directory-structure title: Visual KPI Website and Virtual Directory Structure slug: /setup-and-administration/installation/website-and-virtual-directory-structure description: 'Describes how to perform the software update.' -tags: [] +tags: ['documentation'] --- This page will help you understand the folder/directory structure of a Visual KPI installation. diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/available-interfaces.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/available-interfaces.mdx index bfc80e66..d1c5eccd 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/available-interfaces.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/available-interfaces.mdx @@ -3,7 +3,7 @@ id: available-interfaces title: Available Interfaces slug: /setup-and-administration/interfaces/available-interfaces description: '' -tags: [] +tags: ['documentation'] --- import IconTable from '@site/src/components/Table/IconTable'; diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/configuring-interfaces.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/configuring-interfaces.mdx index 2148bfc1..0180cda8 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/configuring-interfaces.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/configuring-interfaces.mdx @@ -3,7 +3,7 @@ id: configuration title: Configuration slug: /setup-and-administration/interfaces/configuration description: '' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/core-concepts.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/core-concepts.mdx index 798c5dfe..0611f8d9 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/core-concepts.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/core-concepts.mdx @@ -3,7 +3,7 @@ id: interfaces-core-concepts title: Core Concepts slug: /setup-and-administration/interfaces/core-concepts description: '' -tags: [] +tags: ['documentation'] --- import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/data-sources.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/data-sources.mdx index 73362fb9..a9b2a293 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/data-sources.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/data-sources.mdx @@ -3,7 +3,7 @@ id: data-sources title: Supported Data Sources slug: /setup-and-administration/interfaces/data-sources description: '' -tags: [] +tags: ['documentation'] --- Visual KPI can connect to a multitude of data sources, with each source requiring its own interface and method for reading data. Data sources can be classified by category as follows: diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/interfaces.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/interfaces.mdx index c766254e..eed4b14a 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/interfaces.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/interfaces.mdx @@ -3,7 +3,7 @@ id: interfaces title: Interfaces slug: /setup-and-administration/interfaces description: 'Describes how the user will create or using existing interfaces to perform the connection to their data sources. Depending on the complexity, we can have a group of pages.' -tags: [] +tags: ['documentation'] --- import LinkCards from '@site/src/components/Cards/LinkCards'; diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/index.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/index.mdx index 000bd1f1..16095afe 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/index.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/index.mdx @@ -3,7 +3,7 @@ id: working-with-interfaces title: Working with Interfaces slug: /setup-and-administration/interfaces/working-with-interfaces description: '' -tags: [] +tags: ['documentation'] --- import LinkCards from '@site/src/components/Cards/LinkCards'; diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/json.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/json.mdx index 2abf87e2..519148dd 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/json.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/json.mdx @@ -3,7 +3,7 @@ id: json title: JSON Interface slug: /setup-and-administration/interfaces/json description: '' -tags: [] +tags: ['documentation'] --- import Tabs from '@theme/Tabs'; diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/odbc.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/odbc.mdx index 6e77066e..ddfe0fc7 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/odbc.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/odbc.mdx @@ -3,7 +3,7 @@ id: odbc title: ODBC Interface slug: /setup-and-administration/interfaces/odbc description: '' -tags: [] +tags: ['documentation'] --- import Tabs from '@theme/Tabs'; diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/parameterizing.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/parameterizing.mdx index 413e8b60..d580cf6e 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/parameterizing.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/parameterizing.mdx @@ -3,7 +3,7 @@ id: parameterizing title: Parameterizing Interfaces slug: /setup-and-administration/interfaces/parameterizing description: '' -tags: [] +tags: ['documentation'] --- import Tabs from '@theme/Tabs'; @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; Visual KPI Interfaces allows you to parameterize most of the information you may need, giving you the power to create one interface to query for different data. -When creating a query, you can pass parameters into it using index placeholders like `{0}`, `{1}`, and `{8}`. It's important to ensure that all queries have the same number of input parameters (that is, `{0}` and `{1}`), and that the Historical Value query includes the `{TIMESTAMP}` parameter, while the Trend query includes both `{STARTDATE}` and `{ENDDATE}` parameters. +When creating a query, you can pass parameters into it using index placeholders like `{0}`, `{1}`, and `{8}`. It's important to ensure that all queries have the same number of input parameters (that's, `{0}` and `{1}`), and that the Historical Value query includes the `{TIMESTAMP}` parameter, while the Trend query includes both `{STARTDATE}` and `{ENDDATE}` parameters. ## ODBC Interfaces diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/python.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/python.mdx index 8804a872..dc25f46f 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/python.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/python.mdx @@ -3,7 +3,7 @@ id: python title: Python Interface slug: /setup-and-administration/interfaces/python description: '' -tags: [] +tags: ['documentation'] --- Python interfaces are a powerful tool for retrieving data for KPIs from any data source. These interfaces provide great flexibility, allowing you to use a script to fetch data from various sources. With a Python interface, you can easily customize your data retrieval process to fit the unique requirements of your project. Whether you need to extract data from a database, a web service, or any other type of data source, a Python interface can be used as a wildcard. diff --git a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/t-store.mdx b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/t-store.mdx index d624ef3c..5b75dc79 100644 --- a/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/t-store.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/interfaces/working-with-interfaces/t-store.mdx @@ -3,7 +3,7 @@ id: t-store title: Transpara tStore Interface slug: /setup-and-administration/interfaces/t-store description: '' -tags: [] +tags: ['documentation'] --- ## Configuration diff --git a/visual-kpi-docs/docs/setup-and-administration/overview.mdx b/visual-kpi-docs/docs/setup-and-administration/overview.mdx index e473c5fc..2a26f2fa 100644 --- a/visual-kpi-docs/docs/setup-and-administration/overview.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/overview.mdx @@ -3,10 +3,27 @@ id: overview title: Overview slug: /setup-and-administration description: 'Presents the overview of administrator user and the steps to configure Visual KPI.' -tags: [] +tags: ['documentation'] --- -- Presents the overview of administrator user -- The preparation and installation steps -- Interfaces configuration and Data sources -- Automation +import LinkCards from '@site/src/components/Cards/LinkCards'; + +For Transpara, the Administrator is from the IT team, responsible for the Visual KPI integration, covering the system preparation and installation. The Setup and Administration documentation covers all steps required to download and install Visual KPI in the local or cloud environments. In addition, you also find the documentation on how to use interfaces to connect data sources to Visual KPI or automate the process using the Remote Context Server (RCS). Use the cards to access the desired content. + + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/setup-and-administration/prerequisites-downloads.mdx b/visual-kpi-docs/docs/setup-and-administration/prerequisites-downloads.mdx index ba3c12c1..530a1707 100644 --- a/visual-kpi-docs/docs/setup-and-administration/prerequisites-downloads.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/prerequisites-downloads.mdx @@ -3,7 +3,7 @@ id: prerequisites-downloads title: Prerequisites and Downloads slug: /setup-and-administration/prerequisites-downloads description: '' -tags: [] +tags: ['documentation'] --- import interfacePrerequisites from '../../static/data/setup-and-administration/interface-pre-requisites.json' diff --git a/visual-kpi-docs/docs/supporting-pages/faqs/competition.mdx b/visual-kpi-docs/docs/supporting-pages/faqs/competition.mdx index 474bd2bc..440a5d38 100644 --- a/visual-kpi-docs/docs/supporting-pages/faqs/competition.mdx +++ b/visual-kpi-docs/docs/supporting-pages/faqs/competition.mdx @@ -78,7 +78,7 @@ import SearchWrapper from '@site/src/components/accordion/SearchWrapper'; - **Community**: Often overlooked but equally critical is the global customer base of Transpara. Anyone who buys and uses our software benefits from the hundreds of customers that use it every day, battle-test it, submit support and feature requests to make it better, and create new and better use cases. Every improvement benefits all of the customers. - - **Support and expertise**: Transpara is staffed by a team of experts who can provide support deployment assistance, configuration help, troubleshooting, and more — an especially valuable asset for organizations that do not have extensive in-house IT. + - **Support and expertise**: Transpara is staffed by a team of experts who can provide support deployment assistance, configuration help, troubleshooting, and more — an especially valuable asset for organizations that don't have extensive in-house IT. diff --git a/visual-kpi-docs/docs/supporting-pages/faqs/cost-roi.mdx b/visual-kpi-docs/docs/supporting-pages/faqs/cost-roi.mdx index 93425dff..abd6186c 100644 --- a/visual-kpi-docs/docs/supporting-pages/faqs/cost-roi.mdx +++ b/visual-kpi-docs/docs/supporting-pages/faqs/cost-roi.mdx @@ -48,7 +48,7 @@ import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; - You can find all of the details about our pricing model and options at https://transpara.com/pricing. We offer multiple tiers of features, including Pro, Enterprise, and Enterprise ADI, and within each tier it is priced by the number of users who will access the system (named or concurrent users). + You can find all of the details about our pricing model and options at https://transpara.com/pricing. We offer multiple tiers of features, including Pro, Enterprise, and Enterprise ADI, and within each tier it's priced by the number of users who will access the system (named or concurrent users).
test
support

To get an estimate for your particular situation, please contact our [Support](https://www.transpara.com/contact-us/).

@@ -66,10 +66,10 @@ import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; Yes! We support expansion or changes to your license at any time, including changing plans or models, adding users, and other changes. Just reach out to us if you want to make changes.
- Transpara's licenses contain a Fair Use Policy because we understand that critical events occur from time-to-time and you should never be trapped during a crisis. We don't place hard limitations in the software, so if you need to share information with someone who isn't a licensed user, or go beyond the number of licenses you own, we are ok with that. It is only when you repeatedly or consistently violate the terms of your license do we need to increase your license or upgrade your plan. Our goal is to always be a trusted partner and a tool you can count on in a crisis. + Transpara's licenses contain a Fair Use Policy because we understand that critical events occur from time-to-time and you should never be trapped during a crisis. We don't place hard limitations in the software, so if you need to share information with someone who isn't a licensed user, or go beyond the number of licenses you own, we are ok with that. it's only when you repeatedly or consistently violate the terms of your license do we need to increase your license or upgrade your plan. Our goal is to always be a trusted partner and a tool you can count on in a crisis. - Overall, the ROI of any real-time operations and analytics platform will depend on how it is implemented, what use cases and data it surfaces, and the users that leverage it. While Transpara improves decision making, productivity, collaboration and the extracted value of existing investments, each of our customers achieves ROI in their own way. Because of this, we worked with our many customers to create a comprehensive ROI Guide which is available here. + Overall, the ROI of any real-time operations and analytics platform will depend on how it's implemented, what use cases and data it surfaces, and the users that leverage it. While Transpara improves decision making, productivity, collaboration and the extracted value of existing investments, each of our customers achieves ROI in their own way. Because of this, we worked with our many customers to create a comprehensive ROI Guide which is available here. \ No newline at end of file diff --git a/visual-kpi-docs/docs/supporting-pages/faqs/using-the-software.mdx b/visual-kpi-docs/docs/supporting-pages/faqs/using-the-software.mdx index e603cf57..1dccbf78 100644 --- a/visual-kpi-docs/docs/supporting-pages/faqs/using-the-software.mdx +++ b/visual-kpi-docs/docs/supporting-pages/faqs/using-the-software.mdx @@ -55,7 +55,7 @@ import SearchWrapper from '@site/src/components/accordion/SearchWrapper';
restart the browser

You may need to relaunch your browser for the new setting to take effect.

- Yes, it is possible to print and save your dashboards and reports from Visual KPI in PDF format. This can be done easily by using third-party tools like [HTML TO PDF Converter](https://www.html-to-pdf.net/). These tools are capable of converting complex HTML pages, such as those in Visual KPI, into properly formatted PDF files. Printing or saving to PDF directly from your web browser often results in unprofessional formatting. To avoid this issue, use HTML to PDF conversion softwares instead. + Yes, it's possible to print and save your dashboards and reports from Visual KPI in PDF format. This can be done easily by using third-party tools like [HTML TO PDF Converter](https://www.html-to-pdf.net/). These tools are capable of converting complex HTML pages, such as those in Visual KPI, into properly formatted PDF files. Printing or saving to PDF directly from your web browser often results in unprofessional formatting. To avoid this issue, use HTML to PDF conversion softwares instead.
Pro tip

Make sure to test different settings, such as Delay before conversion to allow the page to fully load before converting.

@@ -70,10 +70,10 @@ import SearchWrapper from '@site/src/components/accordion/SearchWrapper'; And while BI lets you make KPIs, you might make two right next to each other that could never be summarized. With BI, there's no way for the solution to look at everything and assess— it doesn't become a system, and you're left with only pieces and parts assembled. - With Transpara, the solution works without us (or our software) having to know what data is in there at all or where it comes from. Transpara's unique approach relies on a consistent pattern in how KPIs are defined, regardless of where the data comes from, how fast it moves, or how seemingly unrelated it is. KPIs are organized for end-user navigation with automatic roll-ups that show what's happening at any level of your hierarchy. These exception-based, at-a-glance views increase the speed of identifying problems or opportunities, while requiring less cognitive load from your users to find what they need. When compared to a BI tool or reporting software, Transpara allows you to much more easily visualize large volumes of data and KPIs at-a-glance and quickly find what needs your attention with intuitive filtering, sorting, grouping, and search – functioning more like the commercial apps you use every day such as Amazon, Zillow, and others. + With Transpara, the solution works without us (or our software) having to know what data is in there at all or where it comes from. Transpara's unique approach relies on a consistent pattern in how KPIs are defined, regardless of where the data comes from, how fast it moves, or how seemingly unrelated it's. KPIs are organized for end-user navigation with automatic roll-ups that show what's happening at any level of your hierarchy. These exception-based, at-a-glance views increase the speed of identifying problems or opportunities, while requiring less cognitive load from your users to find what they need. When compared to a BI tool or reporting software, Transpara allows you to much more easily visualize large volumes of data and KPIs at-a-glance and quickly find what needs your attention with intuitive filtering, sorting, grouping, and search – functioning more like the commercial apps you use every day such as Amazon, Zillow, and others. - Yes. Transpara is so simple to use that most customers do not need any assistance at all once they are set up. First off, most apps in our space design their UIs based on other apps in the space— we go out of our way to base our UI on the consumer apps users are already familiar with. We work for power users and regular end users alike, too. If you're a power user, great, create your own KPIs. If you're a more traditional end user, think of Transapara as 'non-destructive.' We have visualizations already in place so you can choose and refine as needed without changing the system or the view. + Yes. Transpara is so simple to use that most customers don't need any assistance at all once they are set up. First off, most apps in our space design their UIs based on other apps in the space— we go out of our way to base our UI on the consumer apps users are already familiar with. We work for power users and regular end users alike, too. If you're a power user, great, create your own KPIs. If you're a more traditional end user, think of Transapara as 'non-destructive.' We have visualizations already in place so you can choose and refine as needed without changing the system or the view. None of our customers has a full-time manager or admin in place. We may spend some initial time with you setting things up— after that, there are typically just small maintenance bits that may come up. You will have direct access to Transpara's support experts from initial deployment through to ongoing, proactive support. diff --git a/visual-kpi-docs/docs/supporting-pages/glossary.mdx b/visual-kpi-docs/docs/supporting-pages/glossary.mdx index 26d4f6a6..804a65d4 100644 --- a/visual-kpi-docs/docs/supporting-pages/glossary.mdx +++ b/visual-kpi-docs/docs/supporting-pages/glossary.mdx @@ -4,7 +4,7 @@ title: Glossary sidebar_position: 4 slug: /glossary description: '' -tags: [] +tags: ['documentation'] --- import glossary from '@site/static/data/glossary/glossary.json'; diff --git a/visual-kpi-docs/docs/supporting-pages/trainning.mdx b/visual-kpi-docs/docs/supporting-pages/trainning.mdx index 943280c3..8a673b98 100644 --- a/visual-kpi-docs/docs/supporting-pages/trainning.mdx +++ b/visual-kpi-docs/docs/supporting-pages/trainning.mdx @@ -3,7 +3,7 @@ id: training title: Training slug: /training description: 'On this page we should list all existing video training.' -tags: [] +tags: ['documentation'] --- import table from '../../static/data/tables/charts-attributes-keywords-reference/XYPlots.json'; import JsonToTable from '@site/src/components/Table/JsonToTable'; diff --git a/visual-kpi-docs/docs/supporting-pages/troubleshooting.mdx b/visual-kpi-docs/docs/supporting-pages/troubleshooting.mdx index 0478b331..13d7bd5b 100644 --- a/visual-kpi-docs/docs/supporting-pages/troubleshooting.mdx +++ b/visual-kpi-docs/docs/supporting-pages/troubleshooting.mdx @@ -3,7 +3,7 @@ id: troubleshooting title: Troubleshooting slug: /troubleshooting description: 'Describes how to solve problems frequently faced by users' -tags: [] +tags: ['documentation'] --- :::unique diff --git a/visual-kpi-docs/docs/visual-kpi-approach.mdx b/visual-kpi-docs/docs/visual-kpi-approach.mdx index 38d1e2d7..0855570e 100644 --- a/visual-kpi-docs/docs/visual-kpi-approach.mdx +++ b/visual-kpi-docs/docs/visual-kpi-approach.mdx @@ -3,7 +3,7 @@ id: visual-kpi-approach title: The Visual KPI Approach slug: /visual-kpi-approach description: 'Learn how Transpara Visual KPI differs from the competitors and provides a unique approach to make KPI management easier and accessible everywhere.' -tags: [] +tags: ['documentation'] --- When dealing with KPI data visualization, Transpara's Visual KPI stands out as a game-changer compared to other software. Visual KPI takes a different approach, providing automatic data visualization despite the type and origin of your data. This unique way of addressing the KPI data visualization sets it apart from other solutions, such as PowerBI. diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/advanced.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/advanced.mdx new file mode 100644 index 00000000..e6e2b81c --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/authoring/advanced.mdx @@ -0,0 +1,78 @@ +--- +id: advanced +title: Advanced +slug: advanced +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Visual KPI comes with standard attributes out of the box. These attributes are defined by default, but you can define custom attributes in Visual KPI Designer using the Advanced Attributes feature. + +### Attributes + +Custom attributes are additional categories of information that will be associated with your data, allowing you to customize the definition of each object type. Clicking Settings, Advanced and Attributes you can configure up to 20 custom attributes sitewide using Visual KPI Designer. An attribute definition includes an Attribute Name, Description, and Default Values. The Default Values are presented as a list in a pull-down menu within your KPI data definitions, allowing you to select one of the default members. + + + +To add an attribute, first enter its Attribute Name and a Description if necessary. Then, in the Default Values column, enter the default members of the list, separated by semicolons. Default Values are displayed in a list form in the attribute's column in the KPI Data worksheets. Only in the Visual KPI Designer. The Reference Count is automatically updated each time you open the Attributes, indicating the number of selection queries that reference the attribute. + + +:::note Naming Attributes + +Use caution when naming your attributes. don't use the same name for multiple attributes. + +::: + +Click the Membership of Selected Attributes icon (add icon member) in the Attributes configuration toolbar to open a new worksheet that shows each attribute and all KPIs associated with the attribute. + + + +### Language + +Currently, Visual KPI has three language options: English, German, Spanish, Arabic and Simplified Chinese. You can use this worksheet to translate the User Interface into a language you choose. Use the Site Settings icon (add icon gear) to open Advanced and then Languages. + + + +It will open a list of every User Interface text that you'll find in your Visual KPI site that you can translate and edit. Once you've added a language in Visual KPI Designer, the new language will appear in Visual KPI Server Manager. You can then select the language you want to display in your Visual KPI sites. + +However, in some cases, you'll see variables [X] in Visual KPI strings. You don't want to translate the variable because it's a placeholder for text that's returned. + +:::unique Sharing is Caring + +If you want to share your translated strings with us, we would really appreciate it. We may incorporate them into a future release of Visual KPI. + +::: + +### KPI Nav Bar links + +There are many places you can add links in Visual KPI. And you can link to just about anything, whether it's to another object in Visual KPI, a Dashboard, or an external link. You can even add links to the Visual KPI Nav Bar, which are called Nav Bar Links. + + + +Use the Site Settings icon ( add icon gear ) to access Advanced/Nav Bar Links. Add the **Name**, a **Description** (optional), copy the **URL**, and use the pulldown menu to Show **TRUE**. You can change this attribute to FALSE if you don't want the link to display later. + + + +#### Best Practices + +These links will appear in the Nav Bar, sitewide, and can be viewed by every profile with access to the Visual KPI site. You should keep the Name of Nav Bar links to 10 characters or less, or your text may get truncated. Additionally, don't add too many Nav Bar links, or your users will have to scroll vertically to see all of the Nav Bar. You can also add links within objects (such as KPIs), in the Bookmark Bar, or as a Custom Dashboard widget. \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/authoring.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/authoring.mdx deleted file mode 100644 index 19fe10fa..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/authoring/authoring.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: authoring -title: Authoring -slug: /visual-kpi-design/authoring -description: 'A group of pages will be placed here. They will address topics related to the customization of resources such as time-frame, color, ...' -tags: [] ---- - -A group of pages will be placed here. They will address topics related to the customization of resources such as time-frame, color, ... diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/contacts-alerts.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/contacts-alerts.mdx new file mode 100644 index 00000000..d4db79be --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/authoring/contacts-alerts.mdx @@ -0,0 +1,65 @@ +--- +id: contacts-alerts +title: Contacts & Alerts +slug: contacts-alerts +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Visual KPI Designer enables you to configure contacts that can be referenced in your KPI data. This feature gives end-users quick access to the person responsible for a specific data set. Once you've created and saved a contact, it becomes available in the Contact pull-down lists within the Groups, KPIs, Charts, and Tables worksheets in Visual KPI Designer. + +While contacts provide a way for end-users to report problems or request help, Alert Templates automatically send out notifications to chosen contacts. In Visual KPI Designer, you can define the types of alerts to be sent using Alert Templates. You can decide what information the alert email should include and the time intervals to send the alerts. + +### Configure Contacts + +To add and configure new contacts, follow the steps: + +1. Click on the Site Settings icon (). +2. Select **Contacts & Alerts**. +3. Then, select **Contacts**. + + + +On the **Contacts** worksheet, you find all existing contacts. To add a new contact to the list, follow the steps: + +1. Add a **Name** on the first blank row below the column headers. +2. Add a **Description** if appropriate. +3. Enter one or multiple **Contact Names**, **Contact Emails** and **Contact Phones**. If you want to enter multiple names, emails or phones, just separate them with semicolons. +4. Place an **x** in the first column for the new contact. +5. Click the **Save** button () to write the changes to the database. + +:::info Saving Data + +To save your changes, place an **x** in the first column for each object you want to save. All Contacts marked with an **x** will be saved to the Visual KPI Server by clicking the **Save** button (). + +::: + +After adding a contact you can edit it by overwriting the values in the cells, placing an **x** in the first column for the contact you want to edit, and then clicking the **Save** button (). + +To remove the contact place an **x** first column for each contact you want to delete. Then click the Delete Selected Contacts button (). + +:::caution Deleting Contacts + Be careful when deleting contacts. All Contacts marked with an **x** will be deleted from the Visual KPI Server. Before deleting your contact data, it's recommended that you save a copy of the **VisualKPIDesigner.xlsx** file. If you change your mind later and wish to retrieve this data, you can open a copy of the **VisualKPIDesigner.xlsx** file and re-save it. +::: + +### Configure Alerts + +When working with KPIs, you can select the name of an alert template in a pull-down, appling all of the alert attributes assigned to that template. You can create as many Alert Templates as you want. Open the Alert Templates worksheet by clicking the sitewide Settings configuration icon (add icon) and select **Contacts & Alerts** and then **Alert Templates**. + + + +Click **New Alert Template** (add icon) for a new row with the default alert settings, but you can change the values in any cell. Click any of the header cells in the worksheet to get more information about each alert attribute. Click the **Membership of Selected Alert Templates** icon (add icon) to show each KPI that has an alert assigned, along with the name of the Alert Template assigned to it. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/default-settings.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/default-settings.mdx deleted file mode 100644 index 3e83d451..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/authoring/default-settings.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: default-settings -title: Default Settings -slug: /visual-kpi-design/default-settings -description: 'Covers the presentation of default setting and how to override them.' -tags: [] ---- - -Covers the presentation of default setting and how to override them. - -A group of pages covering: - -- Attributes -- Contacts -- KPI status -- Alert templates -- Profiles -- Dashboards -- Site-Wide Features -- Localization diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/features-config.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/features-config.mdx new file mode 100644 index 00000000..2f1d8c31 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/authoring/features-config.mdx @@ -0,0 +1,81 @@ +--- +id: features-config +title: Features & Configuration +slug: features-config +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Using Visual KPI Designer, you can configure KPI Status, setting the icons and colors for each status as it should appear in your Visual KPI site. You set the basic, default parameters in sitewide settings and then these when you configure KPI status parameters for individual KPIs. + + + +### Website + +Use the site settings icon (add icon gear) to access **Features & Config** and **Website** to define basic configuration information for Visual KPI sites. You can edit many items, such as Site Basics, System Services, Tab, Column, and Text Defaults, amongst many others. + + + +#### Light & Dark themes + +By default, Visual KPI sites have a white background, which is the light theme, but you can add a dark theme to cut down on-screen glare for use in environments where a black background would just make more sense. Into the Website configuration Worksheet, find the attribute for **Default Color Theme**. Under the column Value, use the pull-down menu to select the light or dark theme as default. + +For the attribute **Allow Users to Change Color Theme**, select TRUE to allow, and FALSE if you don't want to enable this option. If you enable TRUE, Visual KPI site users will see the option to toggle between light and dark themes under the Options icon + +#### Timestamp display + +Visual KPI shows your data in real-time. The timestamp display in the top bar of Visual KPI sites shows you the exact time, down to the second, that the currently viewed data was returned. You can choose to display the timestamp based on the server time or the client time, even if the server and Visual KPI client are in different time zones. You can set the default to Client Time or Server Time, and you decide whether or not users can change the timestamp display setting in the client. + +By default, the timestamp display in Visual KPI sites is set to Client Time, which is the time indicated by the device on which you are accessing the Visual KPI client. If the timestamp is set to Server Time and your server is, for instance, set to New York time, the timestamp in Visual KPI will show New York time. + +### KPI status + +Start by clicking the Site Settings icon (add icon gear) to access **Features & Config**, and then **KPI Status**. It will open a worksheet with the KPI Status toolbar and Status editor. Some defaults have already been defined for you, but you can change anything and everything. + +In the Status editor, use the Select Color icon (add icon drop light/dark) to select a custom color for light/dark themes, the Toggle Light and Dark Theme icon (add icon sun / moon) to preview icons, and the Reset to Default icon (add icon reset) to return to the Visual KPI defaults. Moreover, you can change the symbol of a status two way, either entering a Custom Icon ID in the cell in the worksheet or clicking the Select icon (add icon not found) in the Status editor. + + + +:::tip Reset Function + +If you click the Reset icon (add icon) in the KPI Status Configuration toolbar, all icons will revert to default. But the Reset icon in the editor reverts status individually. + +::: + +### Chart colors + +By default, Visual KPI adds color to charts. In Visual KPI Designer, you can simply create a chart and Visual KPI will add default colors or you can customize your charts by selecting default colors. But you can also add custom chart colors by selecting the Light or Dark Theme icon (add icon drop light/dark) next to the color you want to customize. You can also preview colors on each theme by clicking the sun () and moon () icons. + + + +When you add custom chart colors, these become the new default colors sitewide. They will override the original Visual KPI defaults. Your custom chart colors will appear in the pulldown menu next to all of your charts that have a color or pen option. For all existing charts, if default colors are selected, all chart colors will be updated immediately with your new custom colors. You can select a color for any chart by opening the appropriate chart worksheet in Visual KPI Designer, and using the pulldown menu to select a color from the defaults. + +### Features + +Use the Features configuration worksheet to enable or disable specific Visual KPI features sitewide. When disabled, they completely disappear from your Visual KPI site. By default, almost all Features are enabled, but you can change as you like by setting TRUE to enable, or FALSE to disable. + + + +Enable Site Roll-Ups allows you to include roll-ups of KPIs from across all websites, not just the one associated with this worksheet. You may want to enable this if you have certain executives who need to see roll-ups of all sites company-wide. You may not want to enable this for any site that's only for operators of this one site. + + diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/manage-objects.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/manage-objects.mdx deleted file mode 100644 index f16e41ef..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/authoring/manage-objects.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: manage-objects -title: Manage Objects -slug: /visual-kpi-design/manage-objects -description: 'Presents how the designer can manage objects.' -tags: [] ---- - -Presents how the designer can manage objects. - -A group of pages. Present the options available to open, save, find, edit, … objects. diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/overview.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/overview.mdx new file mode 100644 index 00000000..2ea751cb --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/authoring/overview.mdx @@ -0,0 +1,60 @@ +--- +title: Authoring +slug: overview +description: 'A group of pages will be placed here. They will address topics related to the customization of profiles, dashboards, contacts, alerts, and site settings in general.' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +The site settings feature within Visual KPI Designer empowers you to modify settings that impact your entire Visual KPI site. Any adjustments made here are applied sitewide. + +When you click on the Site Settings icon () another toolset will open, enabling you to configure all sorts things in your Visual KPI sites. Changes made are immediately reflected in the Visual KPI site you're connected to while editing these configurations. End-users accessing the site will observe these modifications upon data refresh. + + + +Site-wide settings are grouped for easy navigation. When you hover over each category, Visual KPI Designer reveals all available site settings, which are listed and described below. + +- [Profiles & Dashboards](/docs/visual-kpi-design/authoring/profiles-dashboards) + - **Profile Groups**: Enable or disable access, and lock down editing capabilities. + - **Profiles**: Define and manage Visual KPI Profiles directly within Visual KPI Designer. + - **Dashboard**: Configure default settings and associated profiles for Visual KPI Dashboards. +- Ranges & Dates + - **Chart Ranges**: Define time ranges for chart trends. + - **Chart Dates**: Specify chart names and their corresponding timeframes. + - **Default Ranges**: Set default trend ranges for Trends and Sparklines. + - **Event Ranges**: Customize time ranges for data retrieval queries, database time zones, and filter settings. +- [Contacts & Alerts](/docs/visual-kpi-design/authoring/contacts-alerts) + - **Contacts**: Create and configure contacts for reference within Visual KPI data. + - **Alert Templates**: Define alert types, email content, intervals, and other parameters. +- [Features & Configuration](/docs/visual-kpi-design/authoring/features-config) + - **Web Site**: Configure basic information for Visual KPI sites. + - **KPI Status**: Customize status symbols and colors for light and dark themes. + - **Chart Colors**: Define custom colors for charts, including light and dark theme variations. + - **Features**: Enable or disable specific Visual KPI features. +- [Advanced](/docs/visual-kpi-design/authoring/advanced) + - **Interfaces**: Specify locations and parameters of Visual KPI web services or database sources. + - **Attributes**: Define attributes within KPI data definitions and determine display orders. + - **Languages**: Translate everything in Visual KPI sites to your language. + - **Nav Bar Links**: Add custom links to the Visual KPI navigation bar. + - **Site Rollups**: Configure parameters for displaying site rollups within Visual KPI. + - **Comment Codes**: Define default comments available to end users in comment lists. + + +## What's next? + +Each of the available options are addressed individually on the documentation. Use the following links to access the content and learn how to configure your Visual KPI site: + +- [Profiles & Dashboards](/docs/visual-kpi-design/authoring/profiles-dashboards) +- [Ranges & Dates] +- [Contacts & Alerts](/docs/visual-kpi-design/authoring/contacts-alerts) +- [Features & Configuration](/docs/visual-kpi-design/authoring/features-config) +- [Advanced](/docs/visual-kpi-design/authoring/advanced) + + + diff --git a/visual-kpi-docs/docs/visual-kpi-design/authoring/profiles-dashboards.mdx b/visual-kpi-docs/docs/visual-kpi-design/authoring/profiles-dashboards.mdx new file mode 100644 index 00000000..b791ae5a --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/authoring/profiles-dashboards.mdx @@ -0,0 +1,112 @@ +--- +id: profiles-dashboards +title: Profiles & Dashboards +slug: profiles-dashboards +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +End users and Admins can configure custom profiles, profile groups, and dashboards. The end user executes the configuration through the Visual KPI site, while the Admin configures profiles and dashboards sitewide using Visual KPI Designer. However, only Admins can either lock down default profiles and dashboards or allow site users to customize both. + +When working with Visual KPI Designer, the Admin has three configuration layers to set profiles and dashboard settings: + +- **[Profiles](/docs/visual-kpi-design/authoring/profiles-dashboards#profiles)**: Collections of dashboards, Watchlists, and bookmark bars, associated with individuals, roles, sites, assets, etc. +- **[Profile Groups](/docs/visual-kpi-design/authoring/profiles-dashboards#profile-groups)**: Containers for profiles that allow you to manage and control multiple profiles at once in a centralized way. +- **[Dashboards](/docs/visual-kpi-design/authoring/profiles-dashboards#dashboards)**: Custom layouts of visualizations, KPIs, links, trends, tables, embedded content, and any other object supported by Visual KPI. Dashboards are always linked to one or more profiles. + + +You can configure several attributes for each of these layers, including the option to show or hide them on the Visual KPI site. + +{/*For each Profile Group, Profile or Dashboard, add a Name. The names you choose will appear in your Visual KPI site under the appropriate icon. Each has various attributes you can configure sitewide, including the option to show or hide on your Visual KPI site.*/} + +## Profiles + +You will use Profiles to define the dashboards each user has access to. When you create a new profile, you need to assign it to a profile group. In addition, you can: + +- Change the default behavior of the **Locked** feature to **TRUE** so it can not be deleted/edited. +- Define the new profile as the default. +- Choose to hide the profile using the **Show** property. + + + +After creating and saving the new profile, it immediately becomes available on the Visual KPI site. The following GIF illustrates the creation process and how an end user can instantly use the new profile in the application. + + + +:::tip + +Remember to use the toolbar buttons to speed up the creation process. However, if you prefer, you can type directly on the worksheet. + +::: + + +## Profile Groups + +When you create a Profile Group, it has the following default settings: + +- The profile is visible (**Show = TRUE**). +- Privacy is disabled (**Private = FALSE**). +- Editing restrictions are off (**Locked = FALSE**). + +You can adjust the privacy settings, making the group private and specifying designated users (domain/user) for access, making it hidden from all other users. In addition, you can lock a profile group, setting **Locked = TRUE**, preventing users from making customizations or edits. + + + +:::note Private Groups + +This field is auto populated when creating private profile groups in the web browser, so there is no need to modify these values in Visual KPI Designer. + +::: + +## Dashboards + +You can set the following behaviors when creating a dashboard: + +- Lock the dashboard to prevent end-users from customizing or deleting it. +- Set specific time ranges, or relative time functions, for all KPIs on the dashboard. By default, no configuration is defined (blank field), meaning each object can have its independent time range. If you leave it blank, users can choose their device preferences. +- Assign each dashboard to one or multiple profiles. To specify multiple profiles, enter them separated by semicolons in the **Profile** field. + +:::note Default dashboard + +If you want new users or devices accessing the site for the first time to be directed to a specific dashboard, set it as the default. + +You need to assign one dashboard for each profile. If you don't choose a default dashboard, new users will see an empty dashboard and have to choose one. + +::: + + + +### Copying Dashboards + +You have two methods for copying dashboards: + +- **Designer**: Copying and pasting rows within the worksheet. This approach allows you to adjust attribute adjustments while retaining the dashboard's contents. + +- **Browser**: In the dashboard selection dropdown, choose New Dashboard, and when creating the new dashboard, be sure to check the box labeled Copy Existing Dashboard. This approach creates a copy of the current dashboard, which you can edit in your device's browser. + +:::unique + +You can automatically add dashboards coming from SQL or other sources via the Visual KPI [Remote Context Service](/docs/setup-and-administration/automation/rcs). When you have hundreds of sites or assets, this is a good way to automatically generate dashboards following the same pattern, rather than creating them manually. + +If you would like to automate dashboards, [contact us](https://www.transpara.com/contact-us/). + +::: + +You must configure one profile for each site and profile group as default. If you list multiple profiles as default, the one that appears first in the list will always be considered the default. \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/best-practices.mdx b/visual-kpi-docs/docs/visual-kpi-design/best-practices.mdx index f5ef3ea6..9c4d24db 100644 --- a/visual-kpi-docs/docs/visual-kpi-design/best-practices.mdx +++ b/visual-kpi-docs/docs/visual-kpi-design/best-practices.mdx @@ -3,7 +3,7 @@ id: best-practices title: Best Practices slug: /visual-kpi-design/best-practices description: 'List and describe the best practices that the designer can follow.' -tags: [] +tags: ['documentation'] --- List and describe the best practices that the designer can follow. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/bar-chart.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/bar-chart.mdx new file mode 100644 index 00000000..2028e4fa --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/bar-chart.mdx @@ -0,0 +1,72 @@ +--- +id: bar-chart +title: Bar Chart +slug: bar-chart +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Bar charts can be used to show comparisons of data against targets and limits in either a vertical or horizontal chart. + +You can compare only one specific set of data, where each bar represents the data, or you can cluster sets of data so that each specific set of data has its own bar, but the related sets are clustered and compared against other clustered data. + + + +## Define Bar Chart Attributes + +After you have created and configured some basic attributes for a chart, you can begin to design the look of the chart. Here, we show you the basic attributes that you need to set in order design a basic bar chart. To see all of the possible attributes you can configure, see Charts Attributes & Keywords Reference Guide. + +1. **Bar chart name**: Name your chart. +2. **X and Y axes labels**: Name the X and Y axes, as these labels will appear on the chart to identify the data represented. +3. **Query Chart Type**: Decide how you want to cluster data, or not. +4. **Chart Orientation**: Select either vertical or horizontal orientation. +5. **Bar name and interface**: You can add up to 20 bars. o add data to your chart, you add a value, calculation and/or interface for each bar. Or you can also use queries and Connect Strings to connect to an SQL database. +6. **Info display format**: Use the pulldown menu to decide if the data information should be numbers, units of measure, or both. + + + +## Design Charts with Targets & Visualizations + +You have the option to add targets and baselines to your chart to add more meaning to the data. For example, if you create a chart to show yield for manufacturing plants, you may set a baseline of minimum acceptable yield and a target for expected yield. + +### Set a Target and/or Baseline + +Targets can be entered as values, or returned from an interface. To enter a value, use the Target column, otherwise use the Target Interface column to select a previously defined interface. + +You can add up to 5 additional lines to each chart. + +:::note Formulas in Charts + +Formulas and Functions can be used in the Target and Baseline attribute columns. + +::: + +### Give the Target a Name and Color + +The **Target Name**, if you decide to use one, displays as a tooltip when you hover over the line in the chart. + +**Target Color** adds color to the Target line. Use the pulldown menu to select a color. + +### Add Conditional Coloring + +**Conditional Coloring** allows you to change the color of the bar above and below the Target line based on the value comparison. + +**Above Target Color** and **Below Target Color** allow you to select those Conditional Colors, and you can name each in the **Above** and **Below Target Name**. + +For example, if you set targets for performance, you can set the color to green above the target line and use Pass as an Above Target Name. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/box-plots.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/box-plots.mdx new file mode 100644 index 00000000..20bffb45 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/box-plots.mdx @@ -0,0 +1,64 @@ +--- +id: box-plots +title: Box Plots +slug: box-plots +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Box Plots allow you to quickly compare distributions among groups of data or data sets. This article shows you how to configure Box Plots in Visual KPI Designer. Users can also configure Box Plots ad-hoc in Visual KPI sites. + +You can configure Box Plots to show the statistical distribution of data, and as always in Visual KPI, the data can be viewed over time. + + + +In Visual KPI sites, hover over Box Plots to see the distributed values. You can configure Box Plots based on time-series or non-time-series data. You can also configure Box Plots manually, or you can configure query-based Box Plots. + +There are four ways to render Box Plots in Visual KPI: + +- KPI-based Box Plots (created ad-hoc in Visual KPI sites) +- Managed Box Plots (defined Pens) +- Query-based Box Plots (pre-calculated stats) +- Query-based Box Plots (raw data) + +Managed and query-based Box Plots are configured in Visual KPI Designer. + +## Define Box Plots Attributes + +To configure Box Plots in Visual KPI Designer, create a new chart and then define attributes. Box Plots are found under Charts in Visual KPI Designer (see Create & Configure Charts). + +After you have created and configured some basic attributes for a Box Plot, such as the name, description and display order, you can begin to describe the data that will build the Box Plots. Here, we show you the basic attributes that you need to set in order design a basic Box Plot. To see all of the possible attributes you can configure, see Charts Attributes & Keywords Reference Guide. + +## Configure Box Plot Values and/or Interfaces + +To add data to your Box Plots, you add a value, calculation and/or interface for each box. You can also add Connect Strings. + +You can select the color for each box, or leave the attribute blank and Visual KPI will assign a default color. The bars may not have varied colors, but may be all the same color. Bar colors can also be read from a database. + +## Query-based Box Plots (pre-calculated stats) + +The query or stored procedure can either take in no date (static), a timestamp (point in time with scroll interval), or a start and end timestamp (range-based). + +The query must return the following fields (names are important): + +- Required: Min, Q1, Median, Q3 and Max +- Optional: Name and Color (hex). + +## Query-based Box Plots (raw data) + +The query or stored procedure can either take in no date (static), a timestamp (point in time with scroll interval) or a start and end timestamp (range-based). + +Note: If you have a lot of data, raw data query-based Box Plots will perform more slowly. It may be better to calculate the stats in your database and let Visual KPI read the stats. + +The query must return the following fields (names are important): + +- Required: Name, Value +- Optional: Color (hex). \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/charts.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/charts.mdx new file mode 100644 index 00000000..f82ddef0 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/charts.mdx @@ -0,0 +1,87 @@ +--- +id: charts +title: Charts +slug: charts +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Visual KPI Charts display data in relation to defined limits and targets. Color in charts indicates status, and other marks, such as lines, show targets and limits. When you create and configure Charts in Visual KPI Designer, the new chart data is uploaded immediately to the Visual KPI database and appears live on your site. + +Charts can be used to show plant downtime, metrics based on yield or profit, equipment performance over time, or almost anything. If you can chart it, you can visualize it in Visual KPI. + +- Bar Charts +- Embedded Content +- Gantt Charts +- Pareto Charts +- Pie Charts +- Managed Trends +- XY Plots + +## Creating Charts in Visual KPI + +Just like KPIs, charts can live in any group and can be added to groups dynamically based defined attributes and by building queries. + +Visual KPI Charts are not static visualizations. You can change the data displayed in a chart on your Visual KPI site based on time. For as much data is available, you can go back in time and forward, visualize one day of data, or 30. Learn more about Navigating Charts. + +You can define attributes for new Charts in Visual KPI Designer by entering data directly into the cells in the Chart worksheet or by copying and pasting an existing Chart row into a new Chart row. + +Using Visual KPI Designer, you can also return data for you Charts via connected interfaces. You can add functions and formulas, including relative time functions, that allow you to capture and display data in almost any way you can imagine. + +Learn more about the types of information and data limits of each field and all chart attributes. + + + +## Create a New Chart + +To create a new chart, follow the steps below: + +1. Click the Charts tab and use the pulldown menu to select the type of chart you want to create. +2. Click the New Chart icon ( add icon ). +3. Enter a name for the Chart. +4. Add the new Chart using one of the following options: + - Click **Apply** to add the new Chart and its default settings to the Charts worksheet and continue adding Charts. + - Click **OK** to add the new Chart and its default settings to the Charts worksheet and close the dialogue. + - Click **Cancel** to cancel the creation of the new Chart. Once you have clicked the Apply button, the Chart(s) already added to the Charts worksheet will not be removed. + +:::note Working with Charts + +If you have a worksheet with Charts open and want to remove all Charts from the current Chart worksheet, select the Replace worksheet contents checkbox (any unsaved changes are lost). This will also remove the existing Charts from your site. + +::: + +## Define Chart Attributes + +Use the attribute fields (columns) to define your Charts. We've included on this page some basic attributes that apply to all charts. To learn more about attributes for each type of chart, select one of the Chart Types above. + +See a full list of all possible Chart attributes in the Charts Attributes & Keyword Reference. + +### Define Display Order & Description + +In the Charts worksheet, enter the chart Display Order. This is the order in which the chart will be listed on the Charts screen on your Visual KPI site. + +The Description appears below the name of the chart. + +Note: KPIs with an assigned Display Order are listed at the top of the page in Display Order. KPIs that don't have an assigned Display Order are displayed in alphabetical order, following the KPIs with a Display Order. + +### Assign the Chart to a Group + +If the Chart should only be included in a single Group, select the Group Name from the pulldown menu of Groups already defined. If you prefer that Group assignments should be determined at run-time, it's best to build a query to create a Dynamic Group. The **Home group** is the Home page for Visual KPI. + +### Save Chart Attributes + +To save a Chart, place an **x** in the first column and click the Save icon ( add icon ) in the open Chart tab of the Objects Toolbar. it's important to note that ALL Charts with an **x** in the (x) column will be saved. You can remove the **x** for any Chart you don't want to save or update. + +:::note Save your information + +Don't forget to place an **x** in the first column to save your new Chart attribute settings. + +::: \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-chart.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/create-a-chart.mdx deleted file mode 100644 index 068737ec..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-chart.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: create-a-chart -title: Create a Chart -slug: /visual-kpi-design/create-a-chart -description: 'Shows the steps the designer must follows to create a chart.' -tags: [] ---- - -Shows the steps the designer must follows to create a chart. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-group.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/create-a-group.mdx deleted file mode 100644 index 5f4cf5f5..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-group.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: create-a-group -title: Create a Group -slug: /visual-kpi-design/create-a-group -description: 'Shows the steps the designer must follows to create a group.' -tags: [] ---- - -Shows the steps the designer must follows to create a group. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-kpi.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/create-a-kpi.mdx deleted file mode 100644 index 411417df..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-kpi.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: create-a-kpi -title: Create a KPI -slug: /visual-kpi-design/create-a-kpi -description: 'Shows the steps the designer must follows to create a KPI.' -tags: [] ---- - -Shows the steps the designer must follows to create a KPI. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-table.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/create-a-table.mdx deleted file mode 100644 index 9662f8ef..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-table.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: create-a-table -title: Create a Table -slug: /visual-kpi-design/create-a-table -description: 'Shows the steps the designer must follows to create a table.' -tags: [] ---- - -Shows the steps the designer must follows to create a table. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-trend.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/create-a-trend.mdx deleted file mode 100644 index 5c9879e9..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/create-a-trend.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: create-a-trend -title: Create a trend -slug: /visual-kpi-design/create-a-trend -description: 'Shows the steps the designer must follows to create a trend.' -tags: [] ---- - -Shows the steps the designer must follows to create a trend. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/create-an-spc.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/create-an-spc.mdx deleted file mode 100644 index 78244fd5..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/create-an-spc.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: create-an-spc -title: Create an SPC -slug: /visual-kpi-design/create-an-spc -description: 'Shows the steps the designer must follows to create an SPC.' -tags: [] ---- - -Shows the steps the designer must follows to create an SPC. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/create-navbar-links.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/create-navbar-links.mdx deleted file mode 100644 index a4be62b9..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/create-navbar-links.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: create-navbar-links -title: Create a KPI -slug: /visual-kpi-design/create-navbar-links -description: 'Shows the steps the designer must follows to create NavBar Links.' -tags: [] ---- - -Shows the steps the designer must follows to create an NavBar Links. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/design.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/design.mdx deleted file mode 100644 index e8769874..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/design.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: design -title: Design -slug: /visual-kpi-design/design -description: 'A group of pages will be placed here. creation of resources (kpi, tables, charts, ...).' -tags: [] ---- - -A group of pages will be placed here. creation of resources (KPI, tables, charts, ...). diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/gantt-chart.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/gantt-chart.mdx new file mode 100644 index 00000000..99661a29 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/gantt-chart.mdx @@ -0,0 +1,37 @@ +--- +id: gantt-chart +title: Gantt Chart +slug: gantt-chart +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Gantt charts are a good way to track projects in Visual KPI. A Gantt chart is a type of bar chart that can be used to show project schedules, dependencies and status. Configure Gantt charts using Visual KPI Designer. + +Using a Gantt chart, you can show all of the elements of a project along a timeline, when each element is scheduled to be completed, any dependencies and the status of each. Task or project elements are listed along the vertical axis of the Gantt chart and the horizontal axis displays time intervals. Gantt charts are particularly useful in Visual KPI because you can display status. + + + + + +## Define Gantt Chart Attributes + +After you have created and configured some basic attributes for a chart, you can begin to design the “look” of the Gantt chart. Here, we show you the basic attributes that you need to set in order design a basic Gantt chart. To see all of the possible attributes you can configure, see [Charts Attributes & Keywords Reference Guide](/docs/visual-kpi-design/reference-tables/charts-reference). + +You can also use queries and Connect Strings to connect to an SQL database. + +{/* https://www.transpara.com/knowledge-base/slug-interface-connect-strings/ +https://www.transpara.com/knowledge-base/connect-sql-databases/ */} + + diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/group-maps.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/group-maps.mdx new file mode 100644 index 00000000..67dc182d --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/group-maps.mdx @@ -0,0 +1,90 @@ +--- +id: group-maps +title: Group Maps +slug: group-maps +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +The Group Map view in Visual KPI is another powerful visualization that has several distinct benefits: + +- When enabled, It gives Groups a live status and color much like a KPI normally has. +- It shows up to 20 KPIs in each Group in a fixed position (e.g. the temperature can always live in the upper right) so users get used to their location regardless of screen size or device. +- Groups can be collapsed, either individually or all at once so you only need to open them when they need your attention + + + +In a Group Map, the group status–based on the status of the most recently changed KPI in the group, or the worst performing KPI in the group–is determined by your settings in Visual KPI Designer. The top bar, called the Group Map header, displays group status (color and icon, depending on settings). + +Use the Visual KPI Designer or Remote Context Server to configure Group Maps. Here are some of the settings you can (in some cases must) configure (using the Designer as the example): + +- [required] determine which KPIs and how many appear in a Group Map, including their Group Map Position +- Determine the Group Map cell count (how many KPIs will show in each group), as a site-wide setting or on an individual group basis +- Choose Group Map Header Priority, as a site-wide setting or on an individual group basis + +To display and configure Group Maps, you first need to set up Groups (the hierarchy). KPIs can live in groups dynamically or in a static state. Learn more about how to [Create & Configure Groups](/docs/visual-kpi-design/design/groups#create-a-new-group). + +## Customize Global Settings for Group Maps + +Visual KPI Designer has default site-wide settings for Group Maps. You can leave them alone and just select and position your KPIs, or you can change the global settings. + +To access global settings for Group Maps: + +1. In Visual KPI Designer, go to the Site **Settings** icon (add icon) in the Document Actions panel. +2. Select **Features & Config** > **Website** to open the worksheet. + +## Select and Position KPIs in Group Maps + +Once you configure Group Map settings, you need to choose KPIs and their positions for the Group Map. + +By default, Visual KPI shows 10 KPIs in each group for the Group Map view, but unless you give them a position none of them will show up. You could have 100 KPIs in a group, but if you identify a position for five of them, you'll only see five. The other positions will be empty. You can override the KPI cell count on an individual group; more on that later. + +1. Open a KPI worksheet from the **KPIs** tab (add icon). +2. Select the group level that contains the KPIs you want to position in the **Group Map**. (example: Plant 1). +3. Scroll right on the worksheet to find the **Group Map Position** attribute column. For each KPI you want to be included in the Group Map, set the position you want it to appear (left to right, top to bottom) within the Group Map. + +:::note Group Map Visualization + +If you don't select and position KPIs, your Group Map will not appear on your Visual KPI site. + +::: + + + +{/* review example + For instance, if your global KPI cell count is set to 8, you can select and position up to 8 KPIs. You may have 20 KPIs in the Group, but you only made space for 8 (as shown in the image below). You must set the position of those 8 KPIs (starting at 1, from left to right). If you skip one position (say position 2), you'll only see 7 KPIs, and you'll see a blank hole in the number 2 position. In the image below, the default cell count is set to 8, but only 7 KPI are positioned in Group AM2. Position 2 is empty. Group CE Bus has only 5 KPIs positioned, so 3 positions are empty. + +In the example image below, you can see in Visual KPI Designer that 13 KPIs belong to the group Plant 1, but only 6 KPIs will appear in the Group Map, because only 6 KPIs have a Group Map Position. + +For this example, you may want to set the Group Map Cell Count to 6. However, if you plan to show many groups in the Group Map and most groups have 10 KPIs, keep the setting at 10 so they are consistent. */} + +For instance, if a Group Map has 2 KPIs you can set the default cell count to 2, and then select and position two KPIs for each group. Regardless of the order in which the KPIs are listed in the KPI worksheet, you set the positions in the order that works best for your situation. + +## Override Default Group Map KPI Cell Count + +By default, Visual KPI will display 10 KPIs in a Group Map. You can change the setting globally in Site Settings, but you can also override the global setting for an individual group. + +1. Open the Groups worksheet from the Groups tab. +2. Select the group you want to override. +3. Find the name of the group in the worksheet, and then scroll across the page to find the override setting for Group Map KPI Cell Count in the attributes column headers. + +In the Group Map KPI Cell Count attribute column, change or add a number to indicate the number of KPIs you want to display in the Group Map for the group you've just selected. + +{/* review example +In the example in the image below, you could find E. Region, scroll right on the page, and once you find the Group Map KPI Cell Count column, add the number 15 in the cell for E. Region. In your Visual KPI site, the E. Region Group Map would show 15 KPIs. + +This means that you could leave your default cell count set to 10 and only override cell counts for specific groups where you want to show more or less than 10 KPIs in the Group Map. */} + + + diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/groups.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/groups.mdx new file mode 100644 index 00000000..75db61e2 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/groups.mdx @@ -0,0 +1,89 @@ +--- +id: groups +title: Groups +slug: groups +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Visual KPI Groups allow you to organize your data in a way that makes sense for your organization. Any Visual KPI object, such as a KPI, Chart, Table or embedded content can be organized in a Group. Let's say you create Groups based on regions. Each Group can contain data relevant to that region. You can have Groups within Groups, and objects can live within the Groups at any level. For example, you could add sub-groups to organize data for each plant within a region. + + + +## Create a new Group + +To create a new Group, follow these steps: + +1. Select the Groups tab and click the New Group icon ( add icon ) +2. Enter a name for the Group +3. Add the new Group + - Click **Apply** to add the new Group and its default settings to the Groups worksheet and continue adding Groups - Click **OK** to add the new Group and its default settings to the Groups worksheet and close the dialogue + - Click **Cancel** to cancel the creation of the new Group. Once you have clicked the Group button, the Group(s) already added to the Groups worksheet will not be removed. + +:::tip Groups pro Tip + +If you have a worksheet with Groups open and want to remove all KPIs from the current KPI worksheet, select the **Replace worksheet** contents checkbox (any unsaved changes are lost). This will also remove the existing Groups from your site. + +::: + +## Static vs. Dynamic Groups + +The data that's eventually visualized on your Visual KPI site can live in one or multiple Groups. + +A static Group means that objects live in only one assigned Group. Continuing with the regional Group example, you may assign all KPIs for the plants in that region to that one regional group. + +However, if you want to create another Group that visualizes data in a different way. Rather than displaying the data for one region, you want to also show an attribute of all plants across all regions. You can use Dynamic Groups to display relevant data. A Dynamic Group will show data based on attributes you select. For example, if you create a [custom attribute](docs/visual-kpi-design/authoring/advanced#attributes) called “Temp” for temperature, you can dynamically display all KPIs that have a “Temp” attribute. + +Dynamic Groups are especially useful for moving targets, such as assets that change geolocation. If you have transportation moving materials, you can create Dynamic Groups to track assets in time and according to location. For example, you could create a Dynamic Group that returns the data for all trains inbound to San Francisco. In this group, you could have KPIs based on the materials each is transporting. + + + +## Define Group attributes + +When you add a new Group to the Groups worksheet, it keeps the default settings and attributes. You can edit any of the default settings and configure additional attributes. After editting, remember to save by placing an **x** in the first column and click the Save icon (add icon) in the open Groups tab of the Objects Toolbar. it's important to note that ALL Groups with an **x** in the (x) column will be saved. You can remove the **x** for any Group you don't want to save or update. + +### Basic attributes + +There are many attributes that you can explore, you can learn about them all in our [Groups Attributes & Keywords Reference](/) page. Some of the basic attributes are presented below. + +#### Define Display Order + +Select a Display Order for the Group. A Display Order of 1 means the Group will appear at the top of the Groups list. Groups not assigned a Display Order will appear in alphabetical order, following any Groups assigned a Display Order. + +#### Add Text to Display on the Visual KPI Site + +The Description appears under the Group Name on the Visual KPI site. By default, the name of the Group displays. You can add text to the Description column if you want a different descriptor. For example, a Group called Region NE could have the Description NE Region Power Gen Sites. + +#### Define the Group Parent Name + +The tells Visual KPI whether this is a Home Group or sub-group. If you want the Group to appear on the Groups Home page, select Home. If you want the Group to be a sub-group of any other Group, select the Parent Name. Alternatively, you can use Group Selection Query to create a Dynamic Group. + +#### Define the Default Group View + +If you want the data on the Groups page to be displayed differently from the default Rollup visualization, define another default view. For example, you could select a List View or Geo Map view. You can also select the visualizations for the other objects in the group, such as KPI View, Chart View and Table View. + +If you select a Geo Map visualization, enter the latitude and longitude parameters, or select an interface that will return the latitude and longitude parameters. + +:::tip Group Query + +If you want to add KPIs, Charts or Tables to a Group dynamically, build a query in the respective columns: KPI Selection Query, Chart Selection Query, Table Selection Query. + +::: + + + +## What is next? + +See a full list of all possible Group attributes in the Group Attributes & Keyword Reference. + diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/kpis-sources.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/kpis-sources.mdx new file mode 100644 index 00000000..196663c8 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/kpis-sources.mdx @@ -0,0 +1,69 @@ +--- +id: kpis-sources +title: Using Values from Multiple Data Sources +slug: kpis-sources +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +The Parameters feature in the Visual KPI Designer enables you to: + +- Combine data from multiple data sources, including with calculation, into a single vale (e.g. actual, target, limits). +- Define more complex or nested functions to be performed on-the-fly (e.g. use the results of 3 different calculations from separate data sources in another calculation as your target). +- Get data from external sources for use in making other attributes dynamic (e.g. get the current grade of product running in this machine from a data source and make it the attribute for this KPI. Every time it changes in the data source, change the attribute in Visual KPI on the fly. + +### Add values and interfaces + +The usual way to return data from a source is to call the Interface and an associated tag or set of parameters. In the Visual KPI Designer, you select the Interface you want from a pull-down menu. Interfaces are added to the system in the Visual KPI Server Manager. + +For example, if you're setting up Actual and Target values for a KPI, you can return values from an interface. You can even perform a calculation on the returned value, and the final result is what users will see on your Visual KPI site. + +You have always been able to use multiple data sources in a KPI but you were limited to using only one data source per attribute/column (e.g. actual from 1 source; target from another, etc.). With parameters, this is no longer a limitation. + + + +### Using multiple data sources via parameters + +Using parameters, you can return values from multiple data sources. You can set up to 10 parameters for each KPI. For each parameter, enter a value (or function) and an Interface. For example, you could return the current temperature in San Francisco from one data source, and return the temperature in Oakland from a separate data source. Or you could call market prices from a variety of data sources. + + + +You can also perform calculations on parameters. For example, you could use a calculation to return the average temperature in San Francisco for 1 week. In the example above, you can see that Parameter 3 calls the same data source as Parameter 2 but instead of just returning the value from the source, it divides that value by 3. + +### Using parameters as inputs for other fields + +Parameters can be used in many other fields and in other calculations. Users of your Visual KPI site don't actually see the values returned as parameters. What they see are the values returned from other fields. You use parameters to return data from multiple data sources to come up with a value that you want to be displayed in a Visual KPI site. + +Once you've set up parameters (up to 10), you can then use the values returned from any of those parameters to populate an attribute field or in a calculation to return a new KPI value. In the temperature example, you could calculate the average of temperature in the San Francisco Bay area and set this as the Actual value in your Visual KPI site. + +Using the market price example, the Actual Price displayed in your Visual KPI site would be an average of the market prices from three data sources. The actual value returned is the result of multiple calculations or multiple steps. Parameters can be used in many ways, and can be as simple or complex as you want. You can use calculations in the parameters field and then use the final parameter value in another calculation as input for another KPI attribute. + + + +:::tip Using Calculation + +When you use a parameter calculation for a field, leave the Interface field empty. Because your final value is coming from the parameters, which could represent several data sources (and it will most likely fail). + +::: + +### Example + +As in many industries, sometimes we have products that run in batches at random times. In this oil refinery example, we have different types of petrol run in batches: unleaded and premium unleaded. + +If we wanted to do some comparisons of these batches, regardless of the time run, we could use offset time ranges to compare batches against like batches. We could use P1 to get the start time of batch 1, and P2 could be the start time of batch 2. Then we could use those P1 and P2 values in a calculation. + +Or let's say we want to use P1 as an attribute for a KPI to tell us what grade of oil is running currently in a unit. If P1 is set to retrieve the current grade from a data source in the example below, the attribute will change as the data in the source does, which serves to automate the system in many ways. For example, I might have a group of KPIs that's called **unleaded** and is set to only show KPIs where Unit Type = Unleaded. As this attribute changes, this KPI will dynamically move in and out of that group on the fly. \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/kpis-trends.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/kpis-trends.mdx new file mode 100644 index 00000000..805815d2 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/kpis-trends.mdx @@ -0,0 +1,56 @@ +--- +id: kpis-trends +title: KPI Trends +slug: kpis-trends +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Any KPI can be viewed as a trend. Use Visual KPI Designer to set the KPI trend default attributes. + +We say “default” attributes because trends can be customized by users on Visual KPI sites. For example, the Start and End times you set in Visual KPI Designer show as the default setting on your Visual KPI site. Users can select other time ranges to customize trends only in their view of the Visual KPI site. + + + +## Set Trend Start/End Times & Interface + +If you want to specify the Start and End times for this KPI's Trends, enter the Start time in the Trend Start Time column and the End time in the Trend End Time column. If these values are left blank, the Trend graphs will use the Default Trend Range defined in the Default Ranges. + +You can also use an interface with the start and end times. The start and end times will return data for the selected interface only for the start and end times selected. + +## Select Trend Type + +Select the type of trend to be used as the line type for each of the pens on the KPI trend: Actual, Target and Limit. You can select from Interpolated, Step, Symbol, Interpolated + Symbol, or Step + Symbol. If you leave this blank, the trend type will default to Interpolated. + +From the Trend Scale drop-down list, select the type of trend to be used for the KPI. You can select either Single Scale or Multi-Scale. In Single Scale mode, only the Target line indicator will be displayed. In Multi-Scale mode, all status indicator lines will appear in the trend. + +## Set Minimum and Maximum Values + +In the Trend Y Axis, select TRUE if you want the Min and Max values to be ignored; the Y Axis will scale based on the values in the trend. Select FALSE to enforce the use of the Min and Max values for the Y Axis scaling. + +## Override Default Trend Lines Display + +You can set a default behavior for showing (or not) the Target, Limits, and Average indicator lines within the trend. If you select Default for an individual KPI, the trend will display whatever you selected in sitewide settings as default behavior for the entire site. If you want to override the default behavior for a KPI, select TRUE or FALSE from the drop-down menu. Whatever you choose as default, users on your KPI site will still have the option to show or hide trend lines. + +## Show Status Background + +We added a feature in Visual KPI sites that “colors” the background of a trend based on status. This allows you to quickly see the trend status over time without having to study the data points and where they fall on the target and limits axis. + +In Visual KPI Designer, you can configure the status background to show by default, or not. Either way, users can toggle the status background on and off. + +Set the default site behavior for status background in sitewide settings (Features and Config/Website/Show Status Background). + +To override the default sitewide setting for an individual KPI, select TRUE or FALSE for Show Status Background. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/kpis.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/kpis.mdx new file mode 100644 index 00000000..56bc279e --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/kpis.mdx @@ -0,0 +1,55 @@ +--- +id: kpis +title: KPIs +slug: kpis +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +When you create and configure KPIs in Visual KPI Designer, the new KPI data is uploaded immediately to the KPI database and appears live on your site. You can define attributes for new KPIs by entering data directly into the cells in the KPI worksheet or by copying and pasting an existing KPI row into a new KPI row. You can also return data for you KPIs via connected interfaces and add functions and formulas, including relative time functions, that allow you to capture and display data in almost any way you can imagine. + + + +## Create a new KPI + +To create a new KPI, select the KPIs tab and click the New KPI icon ( add icon ) and enter a name for the KPI. Then, you can click **Apply** to add the new KPI and its default settings to the KPIs worksheet and continue adding KPIs, **OK** to add the new KPI and its default settings to the KPIs worksheet and close the dialogue or **Cancel** to cancel the creation of the new KPI. Once you have clicked the Apply button, the KPI(s) already added to the KPIs worksheet will not be removed. + +:::note + +If you have a worksheet with KPIs open and want to remove all KPIs from the current KPI worksheet, select the **Replace worksheet** contents checkbox (any unsaved changes are lost). This will also remove the existing KPIs from your site. + +::: + +## Define KPI attributes + +Use the attribute fields (columns) on the KPI Worksheet to define your KPI. To save, place an **x** in the first column and click the Save icon ( add icon ) in the open KPI tab of the Objects Toolbar. it's important to note that ALL KPIs with an “x” in the (x) column will be saved. You can remove the **x** for any KPI you don't want to save or update. See a full list of all possible KPI attributes in the [KPI Attributes & Keyword Reference](/). + +### Basic attributes + +There are many attributes that you can explore, you can learn about them all in our [KPIs Attributes & Keywords Reference](/) page. Some of the basic attributes are presented below. + +#### KPI visualization on the Visual KPI Site + +Define the order in which the KPI will be listed on the KPIs screen on your Visual KPI site with the **Display Order** attribute. Also, using the **Description** column, you can define what will display on the KPI page on your Visual KPI site. It can be a description of the KPI, a URL to any Web page, a tag name used to retrieve data from an external system, or an attribute formula or function. + +If you want a KPI to be displayed on the Visual KPI site, select TRUE from the **Show** column list, otherwise, select FALSE. However, if you want Visual KPI to determine at run-time if the KPI should be displayed, use a tag name or an attribute calculation instead of True/False. If you use a tag name for the Show attribute, you must specify the interface in the Show Interface column. Any non-zero value for Show indicates the KPI will be displayed on your Visual KPI site. + +To add a KPI to a single Group, select the Group Name from the list of Groups already defined. If you prefer that KPIs in Groups should be determined at run-time, it's best to build a query to create a Dynamic Group. The **Home** group is the Home page for Visual KPI. + +:::tip Value from External System + +To retrieve the value from an external system, specify a tag name in the **Actual** column, and specify the interface name in the **Actual Interface** column. + +::: + +## What is next? + +Learn more about adding [Attributes Formulas & Functions](/) to KPIs. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/overview.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/overview.mdx new file mode 100644 index 00000000..5a88e064 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/overview.mdx @@ -0,0 +1,21 @@ +--- +title: Design +slug: overview +description: 'A group of pages will be placed here. Creation and configuration of objects such as Groups, KPIs, Charts and Tables' +tags: ['documentation'] +--- + +Visual KPI Designer runs inside Microsoft Excel as an addin and its tools are separated into sections that allow you to take several types of actions. You'll notice the object types in the Visual KPI Designer correlate to the tabs in the Visual KPI site navigation bar: + +- [Groups](/docs/visual-kpi-design/design/groups) +- [KPIs](/docs/visual-kpi-design/design/kpis) +- [Charts](/docs/visual-kpi-design/design/charts) +- [Tables](/docs/visual-kpi-design/design/tables) + +These are called objects in Visual KPI. You'll use these object types in the Visual KPI Designer to configure data for each of those objects as they appear in your Visual KPI sites. + +As you click each object type in the Visual KPI Designer, the object toolbar below interacts with only the selected object. Use the object types and object toolbar to configure your Visual KPI sites. + +Each object type opens a new worksheet in the Visual KPI Designer. For example, if you are on a KPI worksheet and click Charts to add a new chart, a new worksheet opens called Charts. As you select the object types, the object toolbar changes, depending on what tools you need to configure that object. + +In this section, you will learn how to configure each one of those objects, so you can build your own Visual KPI site. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/pareto-chart.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/pareto-chart.mdx new file mode 100644 index 00000000..39a16f20 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/pareto-chart.mdx @@ -0,0 +1,46 @@ +--- +id: pareto-chart +title: Pareto Chart +slug: pareto-chart +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Pareto charts can help you quickly see which of your assets are most critical and know where you need to focus. You could configure Pareto charts for quality control, showing where most of the problems are coming from. For example, if you create a Pareto chart for Plant Yield, you could quickly see which plant is causing your overall numbers to fall. + +Pareto charts show assets and values in the bars and use a line to show cumulative effect. + + + +## Define Pareto Chart Attributes + +After you have created and configured some basic attributes for a Pareto chart, such as the name, description and display order, you can begin to describe the data that will build the chart. Here, we show you the basic attributes that you need to set in order design a basic Pareto chart. To see all of the possible attributes you can configure, see [Charts Attributes & Keywords Reference Guide](/docs/visual-kpi-design/reference-tables/charts-reference). + +### Name X and Y Axes + +Name the X and Y axis, as these labels will appear on the chart to identify the data represented. + +### Create & Name Bars + +You can add up to 20 bars to your Pareto chart. Give a label to each bar. + +### Enter Values and/or Interface + +To add data to your chart, you add a value, calculation and/or interface for each bar. You can also add Connect Strings. + +### Select Bar Colors + +You can select the color for each bar, or leave the attribute blank and Visual KPI will select default colors. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/pie-chart.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/pie-chart.mdx new file mode 100644 index 00000000..cc138483 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/pie-chart.mdx @@ -0,0 +1,38 @@ +--- +id: pie-chart +title: Pie Chart +slug: pie-chart +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Want to display your Visual KPI data as a pie chart? It's easy to configure pie charts in Visual KPI Designer when you want a simple graphic that shows the relative proportions of your compared assets. + + + +## Define Bar Chart Attributes + +After you have created and configured some basic attributes for a chart, such as the chart name, description, groups and display order, you can begin to design the “look” of the chart. Here, we show you the basic attributes that you need to set in order design a basic pie chart. To see all of the possible attributes you can configure, see [Charts Attributes & Keywords Reference Guide](/docs/visual-kpi-design/reference-tables/charts-reference). + +### Label & Color Pie Chart Slices + +Start by naming each of the slices in your pie chart. You can have up to 20 slices of pie. + +If you leave the slice color blank, Visual KPI will select colors, or you can customize the color of each slice of pie. + +### Enter Values and/or Interface + +To add data to your chart, you add a value, calculation and/or interface for each bar. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/query-based-chart.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/query-based-chart.mdx new file mode 100644 index 00000000..5a826c27 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/query-based-chart.mdx @@ -0,0 +1,285 @@ +--- +id: query-based-chart +title: Query Based Chart +slug: query-based-chart +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +There are two ways to create charts (Bar Charts, Pareto Charts, Pie Charts, for example) in Visual KPI: create charts via an Interface or create query-based charts. + +## Create charts via an Interface + +Using Visual KPI Designer, you can enter a set of lookup/interface pairs. (These lookups can also come via Remote Context Server). For example: + + + +This creates a chart (bar chart in this example) that shows the values of the resulting data returned for Bar 1 and Bar 2 at a moment in time. This chart can be scrolled back and forward in time but will always show values at the particular point in time selected by the end user on your Visual KPI site. The same method can be used for Bar Charts, Pareto Charts and Pie Charts (or new chart types we might add from time to time). This is a quick way of showing data with very little configuration effort. + +## Create query-based charts + +Another method for creating charts is to use SQL queries. We refer to these as Query-Based Charts. + +You may choose to use query-based charts is for simplicity. If the data needed for a chart already exists in a database, you may spend more time (more work) setting up an interface to extract a time/value pair per bar, and in some cases this method may not perform so well. + +Data historians such a OSIsoft's PI System, Aspentech, GE, Aveva/Wonderware, and others lend themselves really well to the lookup/interface pair as there is often no schematic correlation of data points. However, in relational database systems, such as SQL Server or Oracle, these relationships are often explicitly defined in the data itself, which makes it more convenient to use the query-based charts approach. + +Also, query-based charts must be used if you want to do any of the following: + +### Create Ranged-based charts + +Instead of a bar or pie slice representing a value at a single point in time, each bar or slice would represent data over a range of time. This is useful for charts that are meant to show things like outages over a week, production totals per day, or incidents per month. The idea is to write a query (more information on schema below) that aggregates data over a time range (defined at design-time and overridable at run time). + +### Create Stacked or Clustered Bar charts + +Create a series of values, such as production totals per day per factory, or incidents per month per region. Stacked and Clustered bar charts can either be range-based or time-based, but either case will require a query-based approach. + +## An example scenario using query-based charts + +Let's take a look at the following sample data. In this example, we are manufacturing widgets. They come in three sizes (small, medium and large) and are made from one of six different materials (straw, sticks, bricks, glass, steel and carbon fiber). We have four factories (Factory A, Factory B, Factory C, and Factory D), and each factory produces a number of widgets each hour of a certain size and material. The hourly output of these factories is recorded in a table (tableWidgetProduction). + +This table has the following fields: Timestamp (datetime), Factory (nvarchar), Material (nvarchar), Size (nvarchar) and HourlyCount (int). The results of a simple select * query are shown below (Note: this is just a select top N result as the table itself has much more data). + + + +## Query-based charts: types +Visual KPI Chart queries come in 2 types: basic and series-based. Basic queries can be used in Bar Charts, Pareto Charts and Pie Charts, while series-based queries can only be used in Bar Charts (set to Clustered or Stacked). + +## Query-based charts: parameters +Visual KPI Chart queries can optionally use a TIMESTAMP parameter, STARTDATE and ENDDATE parameters or no parameters at all. These date-based parameter keywords will have dates substituted at runtime to allow for time-based (user selected) charts. + +Here's an example query: + +{/* [code lang=”sql”] +select sum(HourlyCount) as Value + +from tableWidgetProduction + +where Timestamp between {STARTDATE} and {ENDDATE} + +and [Timestamp] <= getdate() — prevent future data + +group by Material + +order by Material[/code] + +At Runtime, the {STARTDATE} and {ENDDATE} placeholders will be replaced by valid datetime strings and will result in a query that looks like this: + +[code lang=”sql”] +select sum(HourlyCount) as Value + +from tableWidgetProduction + +where Timestamp between ‘2019-04-01 01:15:00’ and ‘2019-04-07 15:22:11’ + +and [Timestamp] <= getdate() — prevent future data + +group by Material + +order by Material +[/code] */} + +## Basic queries + +At its most basic, Visual KPI is looking for a column called Value that should hold the data for each bar (Bar Chart and Pareto Chart) or each slice (Pie Chart). + +- Given the query above, the resulting dataset and chart would look like this: + + + + + +In order to give the chart bars names, the query needs to also return a Name field: + + {/* [code lang=”sql”] + select sum(HourlyCount) as Value, + + Material as Name + + from tableWidgetProduction + + where Timestamp between {STARTDATE} and {ENDDATE} + + and [Timestamp] <= getdate() — prevent future data + + group by Material + + order by Material + [/code] */} + +- Here's the result of this query and the corresponding chart: + + + + + +- Finally, you can add some color to this chart by adding a Color field to the query: + + {/* [code lang=”sql”] + select sum(HourlyCount) as Value, + + Material as Name, + + case when (Material = ‘Straw’) then ‘#DFE26E’ + + when (Material = ‘Sticks’) then ‘#CA6F1E’ + + when (Material = ‘Bricks’) then ‘#E74C3C’ + + when (Material = ‘Glass’) then ‘#85C1E9’ + + when (Material = ‘Steel’) then ‘#BDC3C7’ + + else ‘#2C3E50’ + + end as Color + + from tableWidgetProduction + + where Timestamp between {STARTDATE} and {ENDDATE} + + and [Timestamp] <= getdate() — prevent future data + + group by Material + + order by Material + [/code] */} + +- Which results in the following data and chart (as bar, pareto and pie charts): + + + + + + + + + +## Series-based queries + +To create a series-based Bar Chart (Clustered or Stacked), you need to return a SeriesName, Name and Value column: + + {/* [code lang=”sql”] + select Factory as SeriesName, + + Material as Name, + + sum(HourlyCount) as Value + + from tableWidgetProduction + + where Material is not null + + and Timestamp between {STARTDATE} and {ENDDATE} + + and [Timestamp] <= getdate() — prevent future data + + group by Material, Factory + [/code] */} + +- This results in the following data and chart (Note: the Bar Chart is set to Stacked in Visual KPI Designer, but the exact same query would work if the Bar Chart were set to Clustered): + + + + + +- To control the series colors, simply add a column called SeriesColor to the results as follows: + + {/* [code lang=”sql”] + select Factory as SeriesName, + + case + + when Factory = ‘Factory A’ then ‘#ED1556’ + + when Factory = ‘Factory B’ then ‘#669900’ + + when Factory = ‘Factory C’ then ‘#0066ff’ + + when Factory = ‘Factory D’ then ‘#66ff66’ + + else null + + end as SeriesColor, + + Material as Name, + + sum(HourlyCount) as Value + + from tableWidgetProduction + + where Material is not null + + and Timestamp between {STARTDATE} and {ENDDATE} + + and [Timestamp] <= getdate() — prevent future data + + group by Material, Factory + [/code] */} + +- This results in the following data and chart: + + + + + +- To change the chart to Clustered, use Visual KPI Designer to set the Query Chart Type to Clustered: + + + + + +With these 2 approaches to chart creation, you can create many interesting visualizations. Please don't hesitate to reach our to support team at support@transpara.com if you have any questions. We would love to help! diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/query-builder.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/query-builder.mdx new file mode 100644 index 00000000..bb735c50 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/query-builder.mdx @@ -0,0 +1,62 @@ +--- +id: query-builder +title: Query Builder +slug: query-builder +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +The Visual KPI Designer Query Builder allows you to add data objects to Groups using queries. In this way, you can add data dynamically to Groups in addition to selecting fixed objects that will always display in Groups. + +The Visual KPI Designer Query Builder uses Attributes and Values to return data at runtime. To build a query, you select an Attribute and an associated Value. + +## Using Query Builder to Add Objects to Groups + +If you have several Groups based on region, but you want to add another Group that displays data based on an attribute other than region. The data may live across regions, but by building a query, you pull in all data with a specific Value based on a selected Attribute. + +### Example + +You've grouped your KPIs, Charts and Tables according to region and the energy plants within each region. You want another Group that returns KPIs from all plants in all regions that are producing solar power. + +1. Create a [custom attribute](docs/visual-kpi-design/authoring/advanced#attributes) called **Unit Type** with the following default values: Biomass;Coal;Fuel Processing;Gas;Geothermal;Hydro;Nuclear;Solar;Waste Coal. +2. In the Groups worksheet, create a New Group called **Solar Performance**. +3. Select the associated cell under the column **KPI Selection Query**. +4. Using the query builder in the task pane, select the Attribute **Unit Type**, the Operator is equal to (=), and the Value **Solar**. +5. When you are adding Groups and KPIs, you'll want to make sure you associate this Unit Type **Solar** with any relevant KPIs. +6. When the query runs, all KPIs related to solar power will display in the **Solar** group, regardless of geographic location. + + + +{/* Review. didn't work. +### Example 2 + +You want to group all KPIs with an alert status of High High High. Obviously, alert status changes over time, so you can't select KPIs for this group. You must build a query that returns the attribute Status with a value that equals High High High. Visual KPI will display all KPIs that have the selected status at runtime. + +1. Create a [custom attribute](docs/visual-kpi-design/authoring/advanced#attributes) called Status with the possible Values to include: High High High. +2. In the worksheet, create a New Group, and give it a name and description. +3. Select the associated cell under the column KPI Selection Query. +4. Build a query using Status as the Attribute, equals (=) a Value of High High High. + +:::note Attributes assigned to Groups + +You can also use Group Selection Query to add sub-groups using attributes and values assigned to Groups. Use Chart and Table Selection Query to add these objects to Groups based on a query. + +::: */} + +## Using Query Builder to Search and Open Objects + +You can also use the Query Builder to search for and open Groups, KPIs, Charts and Tables. + +1. Select the object tab, such as **KPIs**. +2. Click the **Open KPIs** folder icon (add icon), or New Group, New Chart, New Table. +3. Click **Advanced** in the search dialogue panel that opens. +4. Select an **Attribute** and **Value** to open only those KPIs (or other objects) in the worksheet. + diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/spc-kpis.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/spc-kpis.mdx new file mode 100644 index 00000000..3bf3deac --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/spc-kpis.mdx @@ -0,0 +1,151 @@ +--- +id: spc-kpis +title: SPC KPI Configuration +slug: spc-kpis +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +SPC rules allow you to view, trend and alert on data to determine how in or out of control it's based on rules. For example, you have lab samples that need to be charted so you can see when something needs attention because it violates the acceptable control limit(s). + +Visual KPI allows you to display SPC charts based quickly and easily using the four most popular Western Electric rules without having to invest in complicated SPC software. While Visual KPI doesn't cover every possible function of SPC, it does allow you to set up your KPIs using SPC rules in just minutes, and you don't need extensive training or knowledge to apply the four most commonly used SPC rules to your KPIs. + +:::note Using SPC Rules + +Click the label of any of the four rules in Visual KPI Designer to open the link above to see the Western Electric rules, learn more about SPC, and see a description of each of the four most common rules. + +::: + +## What is SPC? + +[Statistical Process Control (SPC)](https://en.wikipedia.org/wiki/Statistical_process_control) is a method for monitoring, controlling and improving processes based on statistical analysis. it's a measure of whether processes are within control limits. + +You can use SPC rules to measure quality and productivity. Data is plotted on control charts over a time range using standard deviations and other statistics so you can quickly visualize and analyze the data and quickly see when a process is out of control and needs attention. + +SPC contains a very useful set of rules you can use to define control limits in cases where values in time don't correlate. An example would be data collected from lab samples or tracking blood sugar results in diabetes patients. + +By charting the data over time, and using statistical decision rules, you can determine whether your process or data is stable, or if it has variations that denote instability. You can see where improvements need to be made or take action in real time with processes that are outside of control limits. + +When you apply SPC rules, a KPI may be charted with a Center Line (control value or xBar) or at 1, 2 or 3 standard deviations. + + + +{/* add video: https://www.youtube.com/watch?v=6ZKCMS2j1sk&t=2s */} + +## How do SPC rules work in Visual KPI? + +In Visual KPI, SPC is a type of trend, but its limits are set according to SPC rules. You have the option to use Western Electric rules and to enter data manually or use an interface to collect data and calculate and chart a KPI based on these rules. In Visual KPI Designer you can configure KPIs using the four most common [SPC rules](https://en.wikipedia.org/wiki/Statistical_process_control). + +When enabled for a KPI, users on your Visual KPI site will visualize the KPI as a line chart (trend) with a center line (control value) and upper and lower limits values that represent violations. In other words, the chart can be used to see data is not within control limits so someone can take action. + +To use SPC rules in Visual KPI, all of the limits must be symmetric. Visual KPI does not manage asymmetrical control limits. Visual KPI is not a full SPC implementation system. It's useful to help you implement controls on uncorrelated systems in those rare cases you may need to do so. + +:::tip Don't overuse SPC rules + +Only enable this on KPIs that require SPC because the calculations add load to the system and will increase your cache time unnecessarily. + +::: + +## Determining control limits in Visual KPI + +Using the Visual KPI Designer, you control how to define SPC KPIs. You can go as simple or as complex as you want. + +The Visual KPI Designer offers you three options for how control limits will be determined. + +- Let Visual KPI calculate control limits +- Define start and end time +- Define control limits + +### Define SPC control limits in Visual KPI + +SPC is a feature that's bound to a KPI. In other words, you need a KPI first. + +You can simply define a KPI with a name and actual value and Visual KPI will do the rest. Normally, a KPI automatically enables a trend view, where you have time on the X-axis and value on the Y-axis. Limits can be defined via dynamic reference to an Interface, via a static value or to nothing, where there is no limit. + +To define control limits for a KPI using SPC rules, open Visual KPI Designer and find the SPC section of the KPI configuration worksheet. Here you can define SPC rules for any KPI. + +First, set TRUE or FALSE for Is SPC. + +This tells Visual KPI whether this KPI will be displayed based on SPC rules or not. If yes, you'll set Is SPC to TRUE. When the actual value you set for a KPI is used as an SPC, it will be treated according to the rules you define. + +:::note SPC KPIs Configuration + +If you want, SPC KPIs can have both standard KPI limits and a target, in addition to the automatically calculated SPC limits. Users have the ability to toggle each of these on or off when viewing the trend. + +::: + +### Define a sample size + +The sample size is the only setting that's required for defining control limits via SPC in Visual KPI. + +The number you add to the Sample Count column represents the number of data points or samples you want to include to make the determination of status (whether or not the group of uncorrelated samples is in control, or not). + +By default, the Status Calc Sample Count is set to 9, because for SPC rule 4 (WE4) by definition you need at least 9 samples. The larger your sample size, the slower the calculation will return a status; but a larger sample size also means a more reliable status. + +Next, decide which option is best for determining control limits for your KPI. + + + +### Let Visual KPI calculate control limits + +To let Visual KPI calculate limits for you, leave Start and End time blank and leave the LCL, Centre Line and UCL blank. Visual KPI will use the screen time range on the displayed chart to calculate control limits. + +For example, if a user opens a one-week trend in the Visual KPI site, we'll use one week of data to calculate the lower and upper limits and the center line. + +### Define start and end time + +To define control limits based on a time range, enter Start and End times. Ideally, when setting Start and End times, you want to use a time range when the process was in good control. This time range will be used as a basis for control limits. + +Start and End times in SPC work similar to a normal KPI Start and End time. You have two options: + +- Add a fixed date and time. + + + +- Add a dynamic time using an Interface. + + + +### Define control limits + +You can set control limits manually or return a control limit based on an Interface that returns values that are calculated outside of Visual KPI. + +After you've entered a Sample Count, define an SPC variable for a KPI. + +Select one or more rules to apply. For each of the four available rules, you can choose to ignore it or select which limit or status the rule will correspond to when the rule is violated. + +Select a limit as the state to display, or choose a custom status. (Link to defining custom status) + +The columns in Visual KPI Designer you use to set limits are: + +- LCL: Lower control limit +- Centre line (this is the control value that determines when data is not in violation) +- UCL: Upper control limit + +To manually enter control limits, you can enter known values into the LCL, Centre Line and UCL columns for each KPI. + +To use an Interface to return values calculated in another system, select an Interface and enter the reference. The LCL, Centre Line and UCL will be populated automatically on your Visual KPI site based on the calculation returned by the Interface. + +:::unique Need help? + +If you need help setting up SPC rules for Visual KPI, [contact us](https://www.transpara.com/contact-us/). + +::: + diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/tables.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/tables.mdx new file mode 100644 index 00000000..d830d96c --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/tables.mdx @@ -0,0 +1,89 @@ +--- +id: tables +title: Tables +slug: tables +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Use the Tables Object Tools in the Visual KPI Designer to create and edit tables for your Visual KPI sites. Tables can be viewed in Visual KPI sites from the Tables tab in the main navigation menu. + + + +You can visualize data in a table, such as a maintenance log, shift report, or a log of truck materials and delivery times. You can create and configure tables using static values or return data from an interface. + +Use Visual KPI Designer to return data from any table that lives in an SQL-based data source (SQL Server, Oracle, MySQL, Excel, Access, and more). Tables can have links to relevant data, including trends. You can add geolocation to tables when, for example, you want to show location of listed assets. Using connected interfaces, you can even show geolocation of moving assets. + +While tables have some limitations, you can add functions and formulas, including relative time functions, that allow you to capture and display data in almost any way you can imagine. + +{/* Learn more about the types of information and data limits of each field. */} + + + +## Create a new table + +To create a new table, follow the steps below: + +1. Select the Tables tab and click the New Table icon ( add icon ). +2. Enter a name for the Table. +3. Add the new Table using one of the following options: + - Click **Apply** to add the new Table and its default settings to the Tables worksheet and continue adding Tables. + - Click **OK** to add the new Table and its default settings to the Tables worksheet and close the dialogue. + - Click **Cancel** to cancel the creation of the new Table. Once you have clicked the Apply button, the Table(s) already added to the Tables worksheet will not be removed. + +:::note Working with Tables + +If you have a worksheet with Tables open and want to remove all Tables from the current Table worksheet, select the Replace worksheet contents checkbox (any unsaved changes are lost). This will also remove the existing Tables from your site. + +::: + +## Define table attributes + +Use the attribute fields (columns) to configure your Tables. + +To save a Table, place an **x** in the first column and click the Save icon ( add icon ) in the open Tables tab of the Objects Toolbar. it's important to note that ALL Tables with an **x** in the (x) column will be saved. You can remove the **x** for any Table you don't want to save or update. + +See a full list of all possible Table attributes in the Tables Attributes & Keyword Reference. + +### Define display order + +In the Tables worksheet, enter the Table's Display Order. This is the order in which the Table will be listed on the Tables menu on your Visual KPI site. + +Tables with an assigned Display Order are listed at the top of the page, in Display Order. Tables that don't have an assigned Display Order, are displayed in alphabetical order, following the Tables with a Display Order. + +### Add a table description + +Tables display a Description column, allowing you to add a simple description or other information users may need. + +### Add table to a group + +If the Table should only be included in a single Group, select the Group Name from the list of Groups already defined. If you prefer that the Tables displayed in Groups should be determined at run-time, it's best to build a query to create a Dynamic Group. The **Home group** is the Home page for Visual KPI. + +### Link to related information + +Using the **Info attribute** column, you can add a link to a Trend, another table, a KPI or even external content. The Info column appears on the list of Tables in the main menu of your Visual KPI site. + + + +### Set the display format of table data + +Using the pulldown menu in the **Info Display Format** column, select how data should be rendered in the table. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/target-and-limit-generator.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/target-and-limit-generator.mdx deleted file mode 100644 index 23b8a1c0..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/design/target-and-limit-generator.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: target-and-limit-generator -title: Target and Limit Generator -slug: /visual-kpi-design/target-and-limit-generator -description: 'Shows the steps the designer must follows to configure the Target and Limit Generator solution.' -tags: [] ---- - -Shows the steps the designer must follows to configure the Target and Limit Generator solution. diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/trends.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/trends.mdx new file mode 100644 index 00000000..fc6efa35 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/trends.mdx @@ -0,0 +1,81 @@ +--- +id: trends +title: Trends +slug: trends +description: Shows the steps the designer must follows to create a trend. + +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +While it's true that a Trend is really a line chart, trends are one of the most powerful features of Visual KPI because they are so highly configurable. KPIs automatically have trends, users can create trends on the fly (Ad-hoc trends), or you can configure managed trends in Visual KPI Designer. + +While KPI trends are configured around a single actual value plus targets and limits, a managed trend is a separate type of object that can contain up to 20 pens (from one or many data sources). Like any other object in Visual KPI, managed trends can have attributes, be members of groups, are customizable, and more. + + + +## Configure Managed Trends Attributes + +After you have created and configured some basic attributes for a trend, such as the name, description, display order and group to which it belongs, you can begin to configure managed trends by defining data to be trended. Here, we show you the basic attributes that you need to set to configure managed trends. To see all of the possible attributes you can configure, see Charts Attributes & Keywords Reference Guide. + +Visual KPI uses Pens to define each data set in a trend. You'll define attributes for each pen you create. You can have up to 20 pens in a trend, meaning you can trend 20 data sets in one chart. + +### Define Pen Value and/or Interface + +Define a value, calculation and/or interface for each pen. When you pair an interface with a value, you get a dynamic value. + +### Name and Color Pens + +The name and color of pens help you identify the data on display. Together, the name and color attributes build the legend that appears below the trend. + +Defining a color is optional. If you leave the colors blank, Visual KPI will generate a different color for each pen. You can also use a HEX color value in the Pen Color field. + +If you want to change the default colors that you can choose from, you can define your own colors in Site Settings. + +### Configure Trend Type + +When you configure managed trends, you can change the default Trend Type by using the pulldown menu. Interpolated is the default. + +Interpolated draws a line from one value to the next. Good for flowing data like temperature changes. + +A Step trend draws a line from one data set to the next data set. A Step trend is good for showing slower moving data, such as average leave time per employee, measured in days, and not updated often. Another good example for a Step trend would be to show a trend of how many employees clocked in today. It's a flat value. But if you trended that value for two years, you may want to see an Interpolated trend. + +Another good example of when to use a Step trend would be when you want to display whether a machine is ON or OFF. The trend steps between on or off; there is no data in between. + +The Symbol Trend Type drops a point where the data actually exists along the trend line. + + + +### Set Trend Scale + +You can select a Single-Scale or Multi-Scale trend as you configure managed trends. A Single-Scale trend has a single Y axis, and a single X axis, whereas a Multi-Scale trend can have as many Y axes as you have pens. (The X axis is based on time and remains the same in both Single-Scale and Multi-Scale.) + +A Multi-Scale trend is good for displaying very different values, such as the price of oil compared to oil production. A Multi-Scale trend shows how values with different scales correlate. + +Each Y axis is displayed in the legend that appears beneath the trend, and the scale changes as you click an item in the legend. + +### Set Trend Y Axis + +Select how you want to display the range of data in the managed trend. + +Auto-Scale, which is the default, displays the Y axis based on the data that's in the trend. The Y axis will change ranges to show the minimum and maximum ranges. + +The Pen Min and Max Y Axis attribute uses the individual settings that you define for each pen. + +Trend Min and Max Y Axis sets the Y axis for the entire trend based on the Min and Max Y axes that you set in Visual KPI Designer. It's a fixed Y axis (vertical range) for the entire trend. + +So, if you use either of the attributes other than Auto-Scale, you need to also define the pen and trend min and max for the Y axis. + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/design/xy-plots.mdx b/visual-kpi-docs/docs/visual-kpi-design/design/xy-plots.mdx new file mode 100644 index 00000000..f68abecb --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/design/xy-plots.mdx @@ -0,0 +1,76 @@ +--- +id: xy-plots +title: XY Plots +slug: xy-plots +description: '' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +Create and configure XY Plots, or scatter charts, to show the relationships between two sets of data. For example, you could show the temperature outside related to how many ice creams were sold. A better example for Visual KPI may be measuring wind speed against power. + +XY plots can be based on time or not. + + + +## Define Bar Chart Attributes + +After you have created and configured some basic attributes for a chart, you can begin to add data to the chart. Here, we show you the basic attributes that you need to set in order design a basic XY plot. To see all of the possible attributes you can configure, see Charts Attributes & Keywords Reference Guide. + +### Name X and Y Axes + +Name the X and Y axes, as these labels will appear on the chart to identify the data represented. For example, the Non Time Series chart above shows Power and Wind Speed as the X and Y axes. + +### Enter Values and/or Interface + +Visual KPI uses Pens to display the points on the plot. To add data to your chart, you add a value, calculation and/or interface for each pen and for each X and Y point. + +You can have up to 20 pens for each chart. + + + +### Name and Color Pens + +For each pen on the XY plot, you can select a color using the pull-down menu. Otherwise, Visual KPI will define default pen colors. + +Then you can assign a name to each pen to show as a label in Visual KPI. The pen name displays when you hover over it in your Visual KPI chart. + +### Select Time Series or Not + +Time series determines how the XY data correlates on the plot. If time series is set to TRUE, then X values are interpolated to match the X value; otherwise, if set to FALSE, X and Y pairs are determined based on the order in which they are returned by the interface. Set Time Series to TRUE or FALSE for each pen on the XY plot. + + + +### Add Fit Line to Plot Contents + +If you want your XY plot to show linear regression, you can plot a fit line and select which data the line should follow. A fit line can help you see whether two sets of data correlate and can be used to help identify trends within the data. + +In the Non Time Series XY plot at the top of this page, the fit line is set to plot the Y data. In Visual KPI Designer, use the Plot Contents attribute to set the Fit Line for each pen. + +### Select Default Start/End Times and Interface + +For each XY plot, you can choose to return data from an interface and select the default start and end times you want to initially show to users on your Visual KPI site. + +Remember, you can use the Time Range picker in Visual KPI sites to change the time ranges shown on a chart. The time range can be changed to show data as far back as it exists. + + + + + + diff --git a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/basic-setup.mdx b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/basic-setup.mdx new file mode 100644 index 00000000..92c3ab32 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/basic-setup.mdx @@ -0,0 +1,92 @@ +--- +title: Basic Setup +slug: basic-setup +description: 'Explore how to start configuring your Visual KPI website using Visual KPI Designer.' +tags: ['Visual KPI Designer', 'basic configuration'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +When you start, visual KPI Designer is already set up with basic configuration. However, setting the branding and details for your site takes only a few minutes. In addition, you can quickly add a few KPIs and have your website ready. + +Of course, there are many configurations you can control using the Visual KPI Designer. However, this page will help you make the basic configurations and explain available features. + +## Contextual help + +In the Visual KPI Designer, each worksheet includes headers that indicate the data to be entered in a cell. Click in any header cell to see a tooltip with an explanation of the data in that column. + + + +In addition, some configuration worksheets have **Description** columns to add context to the current parameter. It tells you exactly what that item means and helps you know what kind of value to enter. For example, in the **Website Configuration** worksheet, the description for Site Title tells you that whatever you enter here will show up in the title bar on the website. + + + +## Website worksheet + +On the Visual KPI Designer toolbar, you have access to site settings. To configure you site, select site settings () → **Features & Config** → **Website** to open the **Website Configuration worksheet**. You can choose to keep any of the default settings, but here we will present some basics configurations you may want to set up immediately: + +### Site title + +The default Value is Transpara Visual KPI. Change this to reflect your website's name as displayed in the title bar. + +1. In the Site Title row of the worksheet, click the Value column. +2. Enter your site's title. +3. Click the Save icon () in the Visual KPI Designer toolbar. + +### Admin information + +Choose the contact for your Visual KPI site. This will appear in some System Configuration pages on your site. It will also be used for cache server error notifications. + +1. In the **Site Administrator Contact** row, select the Value cell. +2. Use the pulldown menu to select the appropriate contact. + + + +### Cache warning + +To receive notifications of issues relating to cache errors, follow the instructions below: + +1. Use the pulldown menu to select a notification method in the **Cache Alert Notification Protocol** field. When set to None, notifications won't be sent out. +2. Enter a value in the **Cache Alert Reminder Interval** (minutes) field indicating the frequency to be used for sending out cache alert reminders. When the value is 0, the Cache Alert Reminders won't be sent. +3. Enter a value in the **Cache Warning Interval** (minutes) field. When the value is 0, the Cache Warning is disabled. + + + +### Site logo + +The default logo is from Transpara Visual KPI, but you can easily change it following the steps bellow: + +1. On the Visual KPI Designer toolbar, click the Upload Logo icon () in the Web Site Configuration toolbar. +2. Browse and select an image file (JPG or PNG) of your logo. Click Open. +3. Click the Save icon (add icon) in the Web Site configuration toolbar. + + + +:::note Dark mode + +You can add different logos for light and dark modes. + +::: + +:::note Logo size + +If the logo file doesn't match the required size (140 x 40 pixels), the image will be forced into the specified size, causing some distortion in the image's appearance. + +::: \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/connecting.mdx b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/connecting.mdx new file mode 100644 index 00000000..fbeb8202 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/connecting.mdx @@ -0,0 +1,56 @@ +--- +title: Connecting Visual KPI Designer +slug: connecting +description: Explore how to connect the VIsual KPI Designer to your application. +tags: ['connecting','Visual KPI Designer'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + + +The Visual KPI Designer allows you to configure your Visual KPI site. You can manipulate and prepare the data presentation without directly interacting with the end-user interface of the Visual KPI website. But first, you need to connect to your site. + +## Connecting + +To connect the Visual KPI Designer to your site, you must open it in Excel. After, you can follow the steps below to configure the Designer connection to your site: + +1. Open Excel. +2. Click on the **Instance Connections** icon (add icon) to open the dialog settings. + +:::note First configuration + +If it's the first time you open Excel after installing the **Visual KPI Designer**, Excel will automatically present the **Instance Connections** dialog. + +::: + +3. Click **New** to add a new connection. +4. Provide a **Name** to reference the new connection. +5. Specify the **WebService URL**. + +:::info Using the test application. + +If you're testing the Visual KPI Designer for the first time, you can connect to the [Transpara's Demo](https://demo.transpara.com/powergen) page. In this case, for **WebService URL** use https://demo.transpara.com/powergen/webservice/kpiws.asmx. + +::: + +6. If your system administrator has set up authentication, select the correct **Authentication** mode and provide the **User Name** and **Password**. Otherwise, choose Anonymous for the **Authentication** field. +7. Click **Test Connection**. If the server is running and accessible, you should see the **Connection successful** message. +8. Click **OK**. + + + +The View Site icon () allows you to open the Visual KPI site to which you are currently connected, and you'll see your server connection just to the right of the View Site icon. + +## Connecting additional Visual KPI sites + +Using the Visual KPI Designer allows you to manage multiple Visual KPI site connections, which is helpful if you oversee several projects or environments. + +To add another site to the Visual KPI Design, follow the steps described above. You will create a new connection, providing a unique name and the specific URL of each additional site. You can also delete sites to clean up your workspace using the **Remove** button in the Instance Connections dialog. + +## What's next? + +Now that you have connected your instance, it's time to learn more about the available functionalities. Access the [Visual KPI Designer UI Tour](/docs/visual-kpi-design/installation-and-setup/ui-tour) to see all available options. diff --git a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/installation.mdx b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/installation.mdx index 299b86dc..012e23cc 100644 --- a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/installation.mdx +++ b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/installation.mdx @@ -1,11 +1,147 @@ --- -id: installation -title: Designer Installation -slug: /visual-kpi-design/installation -description: 'Presents the steps to install the designer on the customer machine.' -tags: [] +title: Installation +slug: instalation +description: Presents the steps to install the designer on the customer machine. +tags: ['instalation','Visual KPI Designer'] --- -Presents the steps to install the designer on the customer machine. +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; + +To install the Visual KPI Designer, the first thing to do is to ensure your system meets the requirements. In addition, it's essential to consider the following conditions before proceeding with the installation: + +- Confirm that Microsoft Excel is installed on your computer, preferably a recent version, for optimal compatibility. +- Verify that you possess local administrator rights on the machine. If uncertain, consult with your IT administrator. +- Close Microsoft Excel to facilitate the installation process. + +## System Requirements + +The system requirements to install the Visual KPI designer are described in the table below. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Bare MinimumProduction Minimum
Operating System
(English 32 or 64 bit)
Windows XP SP2 or Newer, Windows Server 2008 R2 or Newer.Windows 7 or Newer, Windows Server 2012 or Newer.
Memory2 GB RAM4 GB RAM
Hard Disk4 GB Available10 GB Available
Microsoft OfficeMicrosoft Excel 2007 or newer.Microsoft Excel 2013 or newer preferred.
+ +## Software Prerequisites + +The Software requirements to install the Visual KPI designer are described in the table below. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CategoryRequirements
OS VersionMicrosoft Windows XP or Newer; Windows Server 2003 or Newer
User RightsLocal Admin
.NET Framework4.7.2 or newer (added during Visual KPI Designer installation)
Microsoft ExcelMicrosoft Excel 2007 or Newer (32/64 bit ok on client OS; 64 bit if installing the Designer on a Windows Server OS)
Office Integration + + Note: These are already installed by Windows or will be during the Visual KPI Designer installation: +
    +
  • Visual Studio 2010 Tools for Office Runtime (added during Visual KPI Designer installation).
  • +
  • Office 2010 Primary Interop Assemblies (added during Visual KPI Designer installation).
  • +
+
+ +## Installation steps + +Installing Visual KPI Designer, from start to finish, takes only three steps, and you can do it in about 5 minutes. + +:::note Close Microsoft Excel + +The installation should work just fine with Excel open, but Transpara recommends closing it first to reduce errors. + +::: + +To install the Visual KPI Designer, follow the steps below: + +1. Access the [download page](https://www.transpara.com/software-downloads/) to get the latest Visual KPI Designer version. If you have a Transpara account, log in. Otherwise, create an account to access the download page. + +:::info Older versions + +If you're running an older version of Visual KPI Server, you need to find the corresponding Visual KPI Designer version. Access the [Release Archive](https://www.transpara.com/download-archive/) to have an complete list of all available Visual KPI Designer version. + +::: + +2. Click **Visual KPI Designer (.exe)** button to download the installer. + + + +3. Run the **Visual-KPI-Designer-Setup.exe** installer when the download is complete. The file name may vary depending on the current software version. +4. Agree to the terms and conditions, and click **Install**. +5. When the installation is complete, click **Finish**. + +Excel will open automatically after the installation process is completed. Visual KPI Designer should now appear on the right side. + +:::note Updating the Visual KPI Designer + +If you're updating the Visual KPI Designer to a newer version, the steps are the same as the installation. As the new installation replaces the older version automatically, you don't need to uninstall it before updating. + +::: + +:::tip When should you update the Designer? + +The Visual KPI Designer should match your version of the Visual KPI Server. Therefore, you should update the Designer version when you update the Server software. + +::: + +## What's next? + +After installing Visual KPI Designer, it's time for you to connect it to your site. Access the [Connecting Visual KPI Designer](/docs/visual-kpi-design/installation-and-setup/connecting) to follow all necessary steps. + +You can also check the Visual KPI Designer [UI tour](docs/visual-kpi-design/installation-and-setup/ui-tour) to learn more about the options available or see how to [starting configuring your Visual KPI site](docs/visual-kpi-design/installation-and-setup/basic-setup). + + + -The pages can be categorized into pages related to the creation of resources (KPI, tables, charts, ...) or related to the customization of resources (time-frame, colors, ...). diff --git a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/overview.mdx b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/overview.mdx new file mode 100644 index 00000000..16304fcc --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/overview.mdx @@ -0,0 +1,21 @@ +--- +title: Installation and Setup +slug: overview +description: Presents the main steps to install and configure the Visual KPI Designer. +tags: ['instalation','Visual KPI Designer'] +--- + +import LinkCards from '@site/src/components/Cards/LinkCards'; + +This guide provides a comprehensive overview of the installation process for Visual KPI Designer, a powerful tool managing Visual KPI websites. This guide offers a thorough walkthrough to seamlessly install and configure Visual KPI Designer on your machine. + +1. [Check system requirements and installation](/docs/visual-kpi-design/installation-and-setup/instalation): Before proceeding, ensure that your system meets the necessary requirements. Then, proceed to install Visual KPI Designer. +2. [Connect to the server](/docs/visual-kpi-design/installation-and-setup/connecting): After the installation, connect your local installation to the server. This step allows to access and manage your Visual KPI websites. +3. [Take a UI tour](/docs/visual-kpi-design/installation-and-setup/ui-tour): Familiarize yourself with the basics of Visual KPI Designer by taking a guided tour. This will help you navigate through the tool's features and functionalities. +4. [Perform basic configuration](/docs/visual-kpi-design/installation-and-setup/basic-setup): Customize Visual KPI Designer to reflect your brand and specific requirements. + +:::training + +Refer to the [Installation, Setup & Connecting](https://www.transpara.com/lesson/installation-setup-connecting/) to follow the training video covering this content. + +::: diff --git a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/ui-tour.mdx b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/ui-tour.mdx new file mode 100644 index 00000000..b937adf0 --- /dev/null +++ b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/ui-tour.mdx @@ -0,0 +1,97 @@ +--- +title: UI Tour +slug: ui-tour +description: 'Presents the Visual KPI Designer UI functionalities.' +tags: ['worksheet','Visual KPI Designer', 'Excel', 'UI'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; +import PngFont from '@site/src/components/PngFont/PngFont'; + +Once installed and connected, Visual KPI Designer appears as an extra set of tools within Excel, tailored for creating and managing KPIs, charts, and tables for your Visual KPI website. While the [Visual KPI Designer toolbar](/docs/visual-kpi-design/installation-and-setup/ui-tour#visual-kpi-designer-toolbar) makes the tools and actions available, you will configure the system by working on the [worksheets](/docs/visual-kpi-design/installation-and-setup/ui-tour#visual-kpi-designer-worksheets). + +## Using Excel features + +It's important to understand that Visual KPI Designer is installed as an add-in to Excel. Most interactions with the Designer happen through the add-in, although basic Excel functions like sorting, filtering, and deleting rows are still available. + +:::caution Saving spreadsheets + +When working with Visual KPI Designer, you won't use the Excel save button to store your work because it only saves the current spreadsheet. Instead, to save your work within Visual KPI Designer, you'll use the **Save** () button from the Visual KPI Designer panel. + +::: + +When you open Visual KPI Designer in Excel, you're not just working on a spreadsheet. Instead, the Visual KPI Designer fetches data from the Visual KPI Server and presents it in a spreadsheet-like format. You can manipulate this data, make changes, and create new elements within the Designer interface. When you save your work using the Visual KPI add-in, it packages the changes and sends them back to the server for runtime use. Excel is only involved during the design phase. + +## Visual KPI Designer toolbar + +When you open Excel after installing the Visual KPI Designer, you'll notice a new section or toolbar dedicated to Visual KPI functions, indicating that it's ready to use. The worksheet toolbar in Visual KPI Designer provides specific controls to manage data within your Excel sheets, which will affect the active worksheet or all open worksheets: + +:::note Selected rows in a worksheet + +An **x** placed in the first column of a row means that the row is selected. The column **(x)** specifies whether an entry should be affected by various actions, such as Save, Delete, or Preview. By default, all entries are selected when you open a worksheet. + +::: + +1. **Select all** (): Places an **x** in the column **(x)** for each populated row in the active worksheet. +2. **Unselect all** (): Removes all **x** from the column **(x)** for each populated row in the active worksheet. +3. **Close worksheet** (): Closes the active worksheet. Before closing the worksheet, you may see a warning asking if you want to close the worksheet. Unsaved data will be lost. +4. **Close all worksheets but this** (): Closes all open worksheets except the active worksheet. Before closing other worksheets, a warning displays asking if you want to close all other worksheets. Unsaved data will be lost. +5. **Close all worksheets** (): Closes all open worksheets (except the default Visual KPI Designer worksheet). +6. **Refresh metadata** (): Refreshes the contents of the drop-down lists in the opened worksheets. +7. **Toggle basic and advanced modes** (): Hides or shows advanced columns. When working in Basic Mode, you see fewer columns. +8. **Toggle context help** (): Hides or shows the tooltips that appear when you click on cells. You can show tooltips only for header cells or for all cells. +9. **Site settings** (): Access the sitewide settings menu to access Profiles & Dashboards/Website. +10. **Session record**: Displays a list of all activities that have occurred between the KPI Designer and the server since the Visual KPI Designer was last opened. + + + +In the Visual KPI Designer, you'll work with different object types, such as Groups, KPIs, Charts, and Tables. Each of these represents a different aspect of your Visual KPI website. For example, if you want to create or edit a KPI, you'll select the KPI object type, opening a new worksheet customized for KPIs. + +The Object Toolbar in the Visual KPI Designer changes depending on which type of data or object you're working with. For instance, when dealing with KPIs, the toolbar will show options relevant to KPIs. You may see any of these icons for a given worksheet: + +1. **Create a new object** (): Opens a new worksheet for each object (Groups, KPIs, Charts, Tables). +2. **Open a object** (): Opens an existing object. +3. **Save all selected objects in a worksheet** (): In the Visual KPI Designer, you don't save an Excel spreadsheet. **You save using this icon.** It will save any object rows marked with an x. This writes the data to the server. +4. **Preview updates** (): Shows a preview for saving all changes of the selected objects. This can take a long time if many items are marked on the worksheet. +5. **Membership of selected objects** (): Adds a new worksheet called Membership, which displays all of the selected items and the Groups to which they belong. This can be a lengthy process if many items are selected in the worksheet. +6. **Load/Refresh selected objects** (): Updates data spreadsheet to reflect current data saved on the Visual KPI site. +7. **Delete selected objects** (): The delete icon will erase all selected objects from the spreadsheet and the server. + +:::caution Deleting objects + +Make sure you select only the desired objects before using the Delete option. Be sure not to use the Select All options before deleting because you'll erase all selected objects from the spreadsheet and the server. + +::: + + + +## Visual KPI Designer worksheets + +Worksheets are all spreadsheets you use to configure your Visual KPI site. + +If you are using a new installation of Visual KPI Designer, you'll notice that much of the setup has already been added for you. You can just start adding KPIs, which will show up immediately on your Visual KPI website. + +When working with worksheets, you'll see tabs at the bottom of Excel showing any open worksheets. You always have a Visual KPI Designer worksheet open. If you just opened Excel, a blank spreadsheet will be available, which allows you to start entering KPI data immediately. Or you can open existing data using the Visual KPI Tab Tools. + + + + +When entering data, you can enter text like in any Excel worksheet. You simply type the data into a cell. + +Rows in Excel represent Visual KPI items or objects. Each column represents an attribute. You enter a new KPI, for example, on a row. As you scroll along the columns, you set its attributes. This concept applies to every type of worksheet in the Visual KPI Designer. For example, if you are working on profiles, each row is a profile, and each column represents an attribute for that profile. + +Depending on the attribute, you can select data from a list. When you select a cell, if it supports a selection list, it shows a drop-down arrow indicating you can choose from a list. Click the drop-down arrow to display the contents of the list. Make a selection from the list to place the text in the cell. + +## What's next? + +After understanding more about the disposition of Visual KPI Designer parts, you can start configuring the basics information for your site by accessing [Basic Setup](/docs/visual-kpi-design/installation-and-setup/basic-setup). \ No newline at end of file diff --git a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/visual-kpi-designer-ui.mdx b/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/visual-kpi-designer-ui.mdx deleted file mode 100644 index c7974869..00000000 --- a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/visual-kpi-designer-ui.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: visual-kpi-designer-ui -title: Visual KPI Designer UI -slug: /designer/visual-kpi-designer-ui -description: 'Presents the UI the designer will find when start using the designer tool.' -tags: [] ---- - -Presents the UI the designer will find when start using the designer tool. diff --git a/visual-kpi-docs/docs/visual-kpi-design/overview.mdx b/visual-kpi-docs/docs/visual-kpi-design/overview.mdx index b6ef0097..6aeeec9e 100644 --- a/visual-kpi-docs/docs/visual-kpi-design/overview.mdx +++ b/visual-kpi-docs/docs/visual-kpi-design/overview.mdx @@ -1,9 +1,42 @@ --- id: overview title: Overview -slug: /visual-kpi-design/overview +slug: overview description: 'Presents the overview of designer user and the Visual KPI design toll.' -tags: [] +tags: ['documentation'] --- -Presents the overview of designer user and the available options. +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; +import selection from '@site/static/font/selection.json'; +import positions from '@site/static/data/icons/iconsPosition.json'; +import SvgFont from '@site/src/components/SvgFont/SvgFont'; + +The Visual KPI Designer is a tool for creators and administrators responsible for setting up, configuring, and managing the Visual KPI website's back end. The Visual KPI Designer is a configuration hub to link data sources, define KPIs, and organize the data hierarchical structure. + +Using the Visual KPI Designer, you can manipulate and prepare the data presentation without directly interacting with the end-user interface of the Visual KPI website. On the other hand, the Visual KPI site is the front-end interface accessed by end users, displaying the data visualizations configured in the Visual KPI Designer. + +## How to use the Visual KPI Designer + +The Visual KPI Designer is an add-on tool for Microsoft Excel. You use the traditional Excel interface to set up and manage Visual KPI websites. The Visual KPI Designer is compatible with Excel versions from 2007, though it works best with versions 2013 or 2016. + + + +The Visual KPI website doesn't immediately update changes or input data users make in Excel on the Designer. Instead, the data is saved within Excel and manually uploaded to the Visual KPI server when the user is ready. This approach ensures that any in-progress changes don't disrupt the ongoing operations of the Visual KPI site, allowing for uninterrupted access and analysis of real-time data. + +At its core, the Visual KPI Designer doesn't create or store the operational data itself. It's more about organizing and presenting the data. Users can set up how they want their data to be displayed on their Visual KPI site, like showing sales figures in a specific format or for a particular time frame. + +## What's Next? + +Start your journey to become a pro in Visual KPI Designer from the first step by [installing it](/docs/visual-kpi-design/installation-and-setup/overview). + +You can also explore the [Authoring](/docs/visual-kpi-design/authoring/overview) and [Design](/docs/visual-kpi-design/design/overview) contents. + +:::training Let's get it started + +If you want to improve further, enroll in our [Designer Training Course](https://www.transpara.com/course/visual-kpi-designer/) and dive deep into it. + +::: + diff --git a/visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/setup-and-connection.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/advanced-reference.mdx similarity index 100% rename from visual-kpi-docs/docs/visual-kpi-design/installation-and-setup/setup-and-connection.mdx rename to visual-kpi-docs/docs/visual-kpi-design/reference-tables/advanced-reference.mdx diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/charts-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/charts-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/contacts-alerts-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/contacts-alerts-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/features-configuration-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/features-configuration-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/functions-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/functions-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/groups-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/groups-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/kpis-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/kpis-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/profiles-dashboards-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/profiles-dashboards-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/ranges-dates-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/ranges-dates-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/reference-tables.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/reference-tables.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/tables-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/tables-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/visual-kpi-design/reference-tables/website-reference.mdx b/visual-kpi-docs/docs/visual-kpi-design/reference-tables/website-reference.mdx new file mode 100644 index 00000000..e69de29b diff --git a/visual-kpi-docs/docs/what-is-visual-kpi.mdx b/visual-kpi-docs/docs/what-is-visual-kpi.mdx index f47c1400..5752fbbb 100644 --- a/visual-kpi-docs/docs/what-is-visual-kpi.mdx +++ b/visual-kpi-docs/docs/what-is-visual-kpi.mdx @@ -3,7 +3,7 @@ id: what-is-visual-kpi title: What is Visual KPI? slug: / description: 'Discover Transpara Visual KPI solution and learn more about its solution and capabilities using Visual KPI documentation.' -tags: [] +tags: ['documentation'] --- Transpara's Visual KPI is an innovative software solution that simplifies real-time operations management and performance tracking for businesses into one easy-to-use solution. Visual KPI is designed to meet the critical needs of companies by providing an integrated approach to monitoring, analysis, and operations optimization. diff --git a/visual-kpi-docs/docusaurus.config.js b/visual-kpi-docs/docusaurus.config.js index 2d6d33ab..42503d8c 100644 --- a/visual-kpi-docs/docusaurus.config.js +++ b/visual-kpi-docs/docusaurus.config.js @@ -42,7 +42,7 @@ const config = { // Set the production url of your site here url: 'https://your-docusaurus-test-site.com', // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' + // For GitHub pages deployment, it's often '//' baseUrl: '/', // GitHub pages deployment config. diff --git a/visual-kpi-docs/src/components/Cards/CardList.jsx b/visual-kpi-docs/src/components/Cards/CardList.jsx index a61e1b71..976633b8 100644 --- a/visual-kpi-docs/src/components/Cards/CardList.jsx +++ b/visual-kpi-docs/src/components/Cards/CardList.jsx @@ -1,8 +1,24 @@ import React from 'react'; -const CardList = ({ data, Card, className }) => { +const CardList = ({ data, Card, className, numColumns }) => { + + + const setGridColumns = (numColumns) => { + if (numColumns) { + // Create a string of column widths + const columnWidths = Array(numColumns).fill('minmax(200px, 1fr)').join(' '); + return columnWidths; + } else { + // Default to auto-fill with a minimum width of 200px + return 'repeat(auto-fill, minmax(200px, 1fr))'; + } + }; + + // Use the function to set the grid-template-columns style + const gridTemplateColumns = setGridColumns(numColumns); + return ( -
+
{data.map((item, index) => ( ))} diff --git a/visual-kpi-docs/src/components/Cards/LinkCards.jsx b/visual-kpi-docs/src/components/Cards/LinkCards.jsx index 9a7d5613..e57be135 100644 --- a/visual-kpi-docs/src/components/Cards/LinkCards.jsx +++ b/visual-kpi-docs/src/components/Cards/LinkCards.jsx @@ -10,8 +10,8 @@ const Card = ({ logo, name, linkTo }) => { ); }; -const LinkCards = ({ data }) => { - return ; +const LinkCards = ({ data, numColumns }) => { + return ; }; export default LinkCards; diff --git a/visual-kpi-docs/src/components/PngFont/PngFont.jsx b/visual-kpi-docs/src/components/PngFont/PngFont.jsx new file mode 100644 index 00000000..c57c4500 --- /dev/null +++ b/visual-kpi-docs/src/components/PngFont/PngFont.jsx @@ -0,0 +1,11 @@ +import React from 'react'; +import useBaseUrl from '@docusaurus/useBaseUrl'; + +export default function PngFont({name}) { + console.log(name); + return ( + + {`${name} + + ); +} \ No newline at end of file diff --git a/visual-kpi-docs/src/components/StylizedImage/StylizedImage.jsx b/visual-kpi-docs/src/components/StylizedImage/StylizedImage.jsx index c3a6fe30..ed1080c8 100644 --- a/visual-kpi-docs/src/components/StylizedImage/StylizedImage.jsx +++ b/visual-kpi-docs/src/components/StylizedImage/StylizedImage.jsx @@ -8,7 +8,7 @@ export default function StylizedImage({ imgURL, wSize, alt }) { src={useBaseUrl(imgURL)} alt={alt} style={{ - width: wSize, + maxWidth: wSize, margin: '0 0 var(--ifm-paragraph-margin-bottom)', borderRadius: '7px', boxShadow: '0px 0px 4px rgba(0, 0, 0, 0.2)', diff --git a/visual-kpi-docs/src/components/Table/JsonToTable.jsx b/visual-kpi-docs/src/components/Table/JsonToTable.jsx index af5aaaea..abf12be0 100644 --- a/visual-kpi-docs/src/components/Table/JsonToTable.jsx +++ b/visual-kpi-docs/src/components/Table/JsonToTable.jsx @@ -45,9 +45,7 @@ const JsonToTable = ({ jsonData }) => { }, [filteredData, sortColumn, sortOrder]); const generateArray = (length) => { - let result = [5, 10, 25, 50, 100]; - - result = result.reduce((acc, curr) => { + const result = [5, 10, 25, 50, 100].reduce((acc, curr) => { if (curr < length) { acc.push(curr); } @@ -64,28 +62,75 @@ const JsonToTable = ({ jsonData }) => { const startIndex = (currentPage - 1) * rowsToShow; const endIndex = startIndex + rowsToShow; - // Table rows - const rows = sortedData.slice(startIndex, endIndex).map((row, index) => ( - - {Object.values(row).map((value, colIndex) => ( - {value} - ))} - - )); - // Table header for sorting const headers = Object.keys(jsonData[0]).map((key) => ( - handleSort(key)} style={{ width: `${100 / Object.keys(jsonData[0]).length}%` }}> + handleSort(key)} style={{ width: `${105 / Object.keys(jsonData[0]).length}%` }}> {key} {sortColumn === key && ( - {sortOrder === 'asc' ? ' 🠽' : ' 🠿'} + {sortOrder === 'asc' ? '▴' : '▾'} )} )); + const processedData = useMemo(() => { + let data = jsonData.filter((row) => + Object.values(row).some((value) => + String(value).toLowerCase().includes(filter.toLowerCase()) + ) + ); + + if (!data.length) { + const naRow = Object.keys(jsonData[0]).reduce((acc, key) => { + acc[key] = '-'; + return acc; + }, {}); + data = [naRow]; + } + + if (sortColumn) { + data.sort((a, b) => { + const aValue = a[sortColumn]; + const bValue = b[sortColumn]; + return sortOrder === 'asc' ? aValue.localeCompare(bValue) : bValue.localeCompare(aValue); + }); + } + + // Grouping data for rowspan + const groupedData = []; + data.forEach(row => { + const lastGroup = groupedData[groupedData.length - 1]; + if (lastGroup && lastGroup[0][Object.keys(row)[0]] === row[Object.keys(row)[0]] && lastGroup[0][Object.keys(row)[0]] !== '') { + lastGroup.push(row); + } else { + groupedData.push([row]); + } + }); + + return groupedData; + }, [jsonData, filter, sortColumn, sortOrder]); + + // Table rows + const rows = processedData.slice(startIndex, endIndex).map((group, groupIndex) => ( + group.map((row, rowIndex) => ( + + {Object.keys(row).map((key, colIndex) => { + if (colIndex === 0 && rowIndex === 0) { + return {row[key]}; + } else if (colIndex !== 0) { + return {row[key]}; + } + return null; + })} + + )) + )); + const handleSort = (column) => { - if (sortColumn === column) { - setSortOrder(sortOrder === 'asc' ? 'desc' : 'asc'); + if (sortColumn === column && sortOrder === 'desc') { + setSortColumn(null); + setSortOrder(''); + } else if (sortColumn === column) { + setSortOrder(sortOrder === 'asc' ? 'desc' : sortOrder === 'desc' ? '' : 'asc'); } else { setSortColumn(column); setSortOrder('asc'); @@ -141,12 +186,14 @@ const JsonToTable = ({ jsonData }) => {
- - - {headers} - - {rows} -
+
+ + + {headers} + + {rows} +
+
Showing {startIndex + 1} to {Math.min(endIndex, sortedData.length)} of {sortedData.length} entries diff --git a/visual-kpi-docs/src/css/HomePage.css b/visual-kpi-docs/src/css/HomePage.css index 39bbb3e1..6a82e2f5 100644 --- a/visual-kpi-docs/src/css/HomePage.css +++ b/visual-kpi-docs/src/css/HomePage.css @@ -165,6 +165,10 @@ background-image: url('../../static/img/homepage/card5.png'); } +.cards_container .card .image6 { + background-image: url('../../static/img/homepage/card6.png'); +} + /* .cards_container .card_text { padding-top: 16px; } */ diff --git a/visual-kpi-docs/src/css/custom.css b/visual-kpi-docs/src/css/custom.css index 7f262727..f4f1eee1 100644 --- a/visual-kpi-docs/src/css/custom.css +++ b/visual-kpi-docs/src/css/custom.css @@ -108,7 +108,7 @@ .pagination-nav__link { display: flex; flex-direction: column; - justify-content: center; + /* justify-content: center; */ flex-shrink: 0; border-radius: 13px; border: 1px solid #acacac; @@ -148,21 +148,28 @@ color: #fff !important; } +.pagination-nav__link--next .pagination-nav__label { + text-align: start; +} + +.pagination-nav__link--prev .pagination-nav__label { + text-align: end; +} + .pagination-nav__link--next .pagination-nav__label:after { content: '🡢' !important; position: absolute; right: 16px; - top: 35%; + top: 12px; } .pagination-nav__link--prev .pagination-nav__label:before { content: '🡠' !important; position: absolute; left: 16px; - top: 35%; + top: 12px; } -/* pagination-nav__link--next */ /*-------------------------------- Markdown Header sizes ------------------------------ */ .markdown h1 { @@ -185,39 +192,3 @@ .python-interface-logo { cursor: pointer !important; } - -/*-------------------------------- Tables configuration ------------------------------ */ - -table { - width: fit-content; - margin: auto; - margin-bottom: var(--ifm-spacing-vertical); -} - -table thead th { - background-color: #ddd7e9; - border: none; - text-align: left; -} - -table tr { - width: 100%; -} - -table tr td { - background-color: #ffffff; - border: none; -} - -table thead, -table tbody { - border: 1px solid #ddd7e9; -} - -table thead tr { - border: 0 !important; -} - -table { - font-size: small; -} diff --git a/visual-kpi-docs/src/css/linkCards.css b/visual-kpi-docs/src/css/linkCards.css index 3dafa6e3..b43e7c91 100644 --- a/visual-kpi-docs/src/css/linkCards.css +++ b/visual-kpi-docs/src/css/linkCards.css @@ -1,6 +1,6 @@ .link_cards_container { display: grid; - grid-template-columns: repeat(auto-fill, minmax(200px, 1fr)); + /* grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));*/ gap: 10px; margin-bottom: 25px; } @@ -15,6 +15,7 @@ text-align: center; gap: 5px; transition: all 0.3s ease; + min-height: 67px; } .link_cards_container .link_card:hover { diff --git a/visual-kpi-docs/src/css/table.css b/visual-kpi-docs/src/css/table.css index 5abf6403..6a257120 100644 --- a/visual-kpi-docs/src/css/table.css +++ b/visual-kpi-docs/src/css/table.css @@ -27,6 +27,7 @@ font-style: normal; font-weight: 700; margin: 0 3px; + min-width: 50px; } .filters_container #rowsToShow:hover { @@ -101,21 +102,26 @@ cursor: pointer; } +.table_container { + overflow-y: auto; + max-height: 600px; + position: relative; +} + table { width: 100% !important; margin-bottom: var(--ifm-spacing-vertical); - border-radius: 7px 7px 0 0; - table-layout: fixed; + border-radius: 7px !important; + display: table; } -table thead, table tbody { - width: auto !important; - border: 1px solid #ddd7e9; - padding: 0 auto; +table thead, +table tbody { + width: 100% !important; } table thead th { - border: none; + border: 1px solid #690; text-align: left; background: #690 !important; color: #fff; @@ -125,17 +131,14 @@ table thead th { font-style: normal; font-weight: 700; line-height: 18px; - width: 50%; -} - -table tr { - width: 100%; - align-items: flex-start; + /* width: 50%; */ + position: sticky; + top: 0; + /* z-index: 1; */ } table tr td { background-color: #ffffff; - border: 1px solid #e7eaee; color: #8e8e8e; font-feature-settings: 'clig' off, 'liga' off; font-family: Raleway; diff --git a/visual-kpi-docs/src/pages/index.jsx b/visual-kpi-docs/src/pages/index.jsx index a6028fb3..79444be0 100644 --- a/visual-kpi-docs/src/pages/index.jsx +++ b/visual-kpi-docs/src/pages/index.jsx @@ -191,6 +191,12 @@ const cardsContent = [ route: "https://www.transpara.com/training/", imageClass: "image5", }, + { + title: "FAQ", + content: "Access Transpara Visual KPI to find answers for your questions.", + route: "/docs/faqs/", + imageClass: "image6", + }, ] export default function Home() { diff --git a/visual-kpi-docs/static/data/glossary/glossary.json b/visual-kpi-docs/static/data/glossary/glossary.json index 948a54b9..5912ac8e 100644 --- a/visual-kpi-docs/static/data/glossary/glossary.json +++ b/visual-kpi-docs/static/data/glossary/glossary.json @@ -102,7 +102,7 @@ }, { "name": "ODBC", - "description": "Open Database Connectivity. It is a standard programming interface for accessing and managing databases. ODBC allows applications to interact with various database management systems (DBMS) using a common method, regardless of the specific DBMS being used. " + "description": "Open Database Connectivity. it's a standard programming interface for accessing and managing databases. ODBC allows applications to interact with various database management systems (DBMS) using a common method, regardless of the specific DBMS being used. " } ] } \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/advanced-site-settings-reference/Interfaces.json b/visual-kpi-docs/static/data/tables/advanced-site-settings-reference/Interfaces.json index 2d23e878..f111842b 100644 --- a/visual-kpi-docs/static/data/tables/advanced-site-settings-reference/Interfaces.json +++ b/visual-kpi-docs/static/data/tables/advanced-site-settings-reference/Interfaces.json @@ -9,7 +9,7 @@ }, { "Attribute": "URL", - "Description": "The server URL used to invoke the Interface methods (these URLs do not need to be accessed outside the server)." + "Description": "The server URL used to invoke the Interface methods (these URLs don't need to be accessed outside the server)." }, { "Attribute": "Authentication Method", @@ -55,4 +55,4 @@ "Attribute": "Interface ID", "Description": "Read-only system level identifier." } -] +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/contacts-alerts-site-settings-reference/AlertTemplates.json b/visual-kpi-docs/static/data/tables/contacts-alerts-site-settings-reference/Alerts.json similarity index 100% rename from visual-kpi-docs/static/data/tables/contacts-alerts-site-settings-reference/AlertTemplates.json rename to visual-kpi-docs/static/data/tables/contacts-alerts-site-settings-reference/Alerts.json diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/Constants.json b/visual-kpi-docs/static/data/tables/functions/inputs/Constants.json new file mode 100644 index 00000000..24d4c386 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/Constants.json @@ -0,0 +1,18 @@ +[ + { + "Constant": "PI", + "Value": "3.141592654" + }, + { + "Constant": "E", + "Value": "2.718281828" + }, + { + "Constant": "TRUE", + "Value": "1" + }, + { + "Constant": "FALSE", + "Value": "0" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/DateInterval.json b/visual-kpi-docs/static/data/tables/functions/inputs/DateInterval.json new file mode 100644 index 00000000..71405021 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/DateInterval.json @@ -0,0 +1,52 @@ +[ + { + "Constant": "dtYear", + "Numeric Value": "0", + "String Expression": "yyyy" + }, + { + "Constant": "dtQuarter", + "Numeric Value": "1", + "String Expression": "q" + }, + { + "Constant": "dtMonth", + "Numeric Value": "2", + "String Expression": "m" + }, + { + "Constant": "dtDayOfYear", + "Numeric Value": "3", + "String Expression": "y" + }, + { + "Constant": "dtDay", + "Numeric Value": "4", + "String Expression": "d" + }, + { + "Constant": "dtWeekOfYear", + "Numeric Value": "5", + "String Expression": "ww" + }, + { + "Constant": "dtWeekday", + "Numeric Value": "6", + "String Expression": "w" + }, + { + "Constant": "dtHour", + "Numeric Value": "7", + "String Expression": "h" + }, + { + "Constant": "dtMinute", + "Numeric Value": "8", + "String Expression": "n" + }, + { + "Constant": "dtSecond", + "Numeric Value": "9", + "String Expression": "s" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/FirstDayOfWeek.json b/visual-kpi-docs/static/data/tables/functions/inputs/FirstDayOfWeek.json new file mode 100644 index 00000000..e448f7cc --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/FirstDayOfWeek.json @@ -0,0 +1,34 @@ +[ + { + "Constant": "dtSystem", + "Numeric Value": "0" + }, + { + "Constant": "dtSunday", + "Numeric Value": "1" + }, + { + "Constant": "dtMonday", + "Numeric Value": "2" + }, + { + "Constant": "dtTuesday", + "Numeric Value": "3" + }, + { + "Constant": "dtWednesday", + "Numeric Value": "4" + }, + { + "Constant": "dtThursday", + "Numeric Value": "5" + }, + { + "Constant": "dtFriday", + "Numeric Value": "6" + }, + { + "Constant": "dtSaturday", + "Numeric Value": "7" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/FirstWeekOfYear.json b/visual-kpi-docs/static/data/tables/functions/inputs/FirstWeekOfYear.json new file mode 100644 index 00000000..5a3e79a7 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/FirstWeekOfYear.json @@ -0,0 +1,18 @@ +[ + { + "Constant": "dtSystem", + "Numeric Value": "0" + }, + { + "Constant": "dtJan1", + "Numeric Value": "1" + }, + { + "Constant": "dtFirstFourDays", + "Numeric Value": "2" + }, + { + "Constant": "dtFirstFullWeek", + "Numeric Value": "3" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/operators/ArithmeticOperators.json b/visual-kpi-docs/static/data/tables/functions/inputs/operators/ArithmeticOperators.json new file mode 100644 index 00000000..4c1be93a --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/operators/ArithmeticOperators.json @@ -0,0 +1,50 @@ +[ + { + "Operator": "plus(+)", + "Num": "yes", + "Date": "", + "Str": "yes", + "Bool": "", + "Description": "Positive sign or arithmetic addition" + }, + { + "Operator": "\u2013", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Negative sign or arithmetic subtraction" + }, + { + "Operator": "*", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Multiplication" + }, + { + "Operator": "/", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Division" + }, + { + "Operator": "%", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Remainder (modulus) obtained by dividing one numeric expression into another" + }, + { + "Operator": "^", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Power" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/operators/BitwiseOperators.json b/visual-kpi-docs/static/data/tables/functions/inputs/operators/BitwiseOperators.json new file mode 100644 index 00000000..3785dd4e --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/operators/BitwiseOperators.json @@ -0,0 +1,34 @@ +[ + { + "Operator": "&", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Bitwise AND operator." + }, + { + "Operator": "|", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Bitwise OR operator." + }, + { + "Operator": "!&", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Bitwise exclusive-OR operator." + }, + { + "Operator": "~", + "Num": "yes", + "Date": "", + "Str": "", + "Bool": "", + "Description": "Bitwise complement operator." + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/operators/ComparisonOperators.json b/visual-kpi-docs/static/data/tables/functions/inputs/operators/ComparisonOperators.json new file mode 100644 index 00000000..f7dec1ca --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/operators/ComparisonOperators.json @@ -0,0 +1,50 @@ +[ + { + "Operator": "<", + "Num": "yes", + "Date": "yes", + "Str": "yes", + "Bool": "", + "Description": "Less than" + }, + { + "Operator": ">", + "Num": "yes", + "Date": "yes", + "Str": "yes", + "Bool": "", + "Description": "Greater than" + }, + { + "Operator": "<=", + "Num": "yes", + "Date": "yes", + "Str": "yes", + "Bool": "", + "Description": "Less than or equal" + }, + { + "Operator": ">=", + "Num": "yes", + "Date": "yes", + "Str": "yes", + "Bool": "", + "Description": "Greater than or equal" + }, + { + "Operator": "equals (== or =)", + "Num": "yes", + "Date": "yes", + "Str": "yes", + "Bool": "yes", + "Description": "Equality" + }, + { + "Operator": "!= or <>", + "Num": "yes", + "Date": "yes", + "Str": "yes", + "Bool": "yes", + "Description": "Inequality" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/inputs/operators/LogicalOperators.json b/visual-kpi-docs/static/data/tables/functions/inputs/operators/LogicalOperators.json new file mode 100644 index 00000000..a971f063 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/inputs/operators/LogicalOperators.json @@ -0,0 +1,26 @@ +[ + { + "Operator": "AND &&", + "Num": "", + "Date": "", + "Str": "", + "Bool": "yes", + "Description": "Logical AND" + }, + { + "Operator": "OR ||", + "Num": "", + "Date": "", + "Str": "", + "Bool": "yes", + "Description": "Logical OR" + }, + { + "Operator": "NOT !", + "Num": "", + "Date": "", + "Str": "", + "Bool": "yes", + "Description": "Logical Negation" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/methods/DateAndTime.json b/visual-kpi-docs/static/data/tables/functions/methods/DateAndTime.json new file mode 100644 index 00000000..2de14c0e --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/methods/DateAndTime.json @@ -0,0 +1,146 @@ +[ + { + "Method": "NOW()", + "Return Type": "DateTime", + "Description": "Current date and time according to the setting of your computer\u00e2\u20ac\u2122s system date and time.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "TODAY()", + "Return Type": "DateTime", + "Description": "Current date. Time part of the day is zero (midnight).", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "YEAR(date)", + "Return Type": "int", + "Description": "Number representing the year.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "MONTH(date)", + "Return Type": "int", + "Description": "Number between 1 and 12, inclusive, representing the month of the year.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "DAY(date)", + "Return Type": "int", + "Description": "Number between 1 and 31, inclusive, representing the day of the month.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "WEEKDAY(date)", + "Return Type": "DayOfWeek enumeration", + "Description": "Number representing the day of the week.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "HOUR(date)", + "Return Type": "int", + "Description": "Number between 0 and 23, inclusive, representing the hour of the day.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "MINUTE(date)", + "Return Type": "int", + "Description": "Number between 0 and 59, inclusive, representing the minute of the hour.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "SECOND(date)", + "Return Type": "int", + "Description": "Number between 0 and 59, inclusive, representing the second of the minute.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "DATEADD(interval, double number, DateTime date)", + "Return Type": "DateTime", + "Description": "Number between 0 and 59, inclusive, representing the minute of the hour.", + "Parameters": "interval: DateInterval enumeration value or string expression representing the time interval you want to add. The intervalargument can have one of the settings listed here.
number: The number of intervals you want to add. It can be positive (to get dates in the future) or negative (to get dates in the past). Any fractional part of number is ignored.
date: date to which the interval is added.", + "Remarks": "", + "Example": "The following expressions are equivalent:
DateAdd(dtMonth, 1, #2005-12-31#) DateAdd(“m”, 1, #2005-12-31#) DateAdd(2, 1, #2005-12-31#)In this example, DateAdd returns #2006-01-31#.", + "Return Value": "" + }, + { + "Method": "DATEDIFF(interval, DateTime date1, DateTime date2 [, firstdayofweek\n [,firstweekofyear]])", + "Return Type": "System.Int64", + "Description": "Returns the number of intervals between two dates.", + "Parameters": "interval: DateInterval enumeration value or string expression representing the time interval\n you want to use as the unit of difference between date1 and date2. The interval argument can have one of the\n settings listed here. date1, date2: Date expressions. Two dates you want to use in the calculation.\n firstdayofweek: Optional. A value chosen from the FirstDayOfWeek enumeration that specifies the day of the week.\n If not specified, Sunday is assumed. firstweekofyear: Optional. A value chosen from the FirstWeekOfYear\n enumeration that specifies the first week of the year. If not specified, the first week is assumed to be the\n week in which January 1 occurs.", + "Remarks": "If Date1 represents a later date and time than Date2, DATEDIFF returns a negative number.
If Interval is set to DateInterval.Year, DateInterval.Quarter, or DateInterval.Month the return value is the number of date and time boundaries crossed between Date1 and Date2.
Note When comparing December 31 to January 1 of the following year, DATEDIFF returns 1 for DateInterval.Year, DateInterval.Quarter, or DateInterval.Month, even though only one day has elapsed.", + "Example": "The following expressions are equivalent:
DateDiff(dtYear, #2005-12-31#, #1995-12-31#) DateDiff(“yyyy”, #2005-12-31#, #1995-12-31#) DateDiff(0, #2005-12-31#, #1995-12-31#)In this example, DateDiff returns -10.", + "Return Value": "" + }, + { + "Method": "DATEPART(interval, DateTime date [, firstdayofweek [,firstweekofyear]])", + "Return Type": "System.Int32", + "Description": "Returns an Integer value containing the specified component of a given Date value.", + "Parameters": "interval: DateInterval enumeration value or string expression representing the part of the\n date/time value you want to return. The interval argument can have one of the settings listed here. date:\n Date expression you want to evaluate. firstdayofweek: Optional. A value chosen from the FirstDayOfWeek\n enumeration that specifies the day of the week. If not specified, Sunday is assumed. firstweekofyear:\n Optional. A value chosen from the FirstWeekOfYear enumeration that specifies the first week of the year. If not\n specified, the first week is assumed to be the week in which January 1 occurs.", + "Remarks": "", + "Example": "The following expressions are equivalent:
DatePart(dtQuarter, #2005-12-31#) DatePart(“q”, #2005-12-31#) DatePart(1, #2005-12-31#)In this example, DatePart returns 4.", + "Return Value": "" + }, + { + "Method": "DATE(int year, int month, int day [, int hour, int minute, int second])", + "Return Type": "DateTime", + "Description": "A Date value representing a specified year, month, day, hour, minute, and second.", + "Parameters": "year: The year (1 through 9999). month: The month (1 through 12). day: The day (1\n through the number of days in month). hour: Optional. The hours (0 through 23). minute: Optional. The\n minutes (0 through 59). second: Optional. The seconds (0 through 59).", + "Remarks": "", + "Example": "", + "Return Value": "A Date value representing a specified year, month, day, hour, minute, and second." + }, + { + "Method": "MIN(DateTime date1, DateTime date2, \u00e2\u20ac\u00a6) MIN(DateTime[ ] date)", + "Return Type": "DateTime", + "Description": "Returns the smallest date in a set of date values.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "MAX(DateTime date1, DateTime date2, \u00e2\u20ac\u00a6) MAX(DateTime[ ] date)", + "Return Type": "DateTime", + "Description": "Returns the largest date in a set of date values.", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + }, + { + "Method": "FORMAT(DateTime, string style)", + "Return Type": "string", + "Description": "Returns a string expression formatted according to instructions contained in a format string\n expression. For information on how to create the style argument, see the appropriate topic at MSDN:\n Predefined Date Formats User-Defined Date Formats", + "Parameters": "", + "Remarks": "", + "Example": "", + "Return Value": "" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/methods/Logical.json b/visual-kpi-docs/static/data/tables/functions/methods/Logical.json new file mode 100644 index 00000000..b8e6cc2b --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/methods/Logical.json @@ -0,0 +1,47 @@ +[ + { + "Method": "IIF(bool condition, expression1, expression2) IF(bool condition, expression1,\n expression2)", + "Return Type": "any", + "Description": "If condition evaluates to TRUE, expression1 is returned. If conditionevaluates to FALSE,\n expression2 is returned. This function accepts any type for its second and third parameters as long as they\n are both of the same type." + }, + { + "Method": "AND(boolean, boolean, \u00e2\u20ac\u00a6)", + "Return Type": "boolean", + "Description": "Returns true if all its arguments are true; returns false if any argument is false" + }, + { + "Method": "OR(boolean, boolean, \u00e2\u20ac\u00a6)", + "Return Type": "boolean", + "Description": "Returns true if any argument is true; returns false if all arguments are false" + }, + { + "Method": "IsNull(object) IsDBNull(object)", + "Return Type": "boolean", + "Description": "Determines whether or not a given expression is a DBNull value" + }, + { + "Method": "IsNumeric(object)", + "Return Type": "boolean", + "Description": "Determines whether or not a given expression is a Numeric Numeric value" + }, + { + "Method": "IsBetween(object,low,high)", + "Return Type": "boolean", + "Description": "Determines whether or not a given NUMERIC expression is between a low and high value" + }, + { + "Method": "IsEqualTo(object, value)", + "Return Type": "boolean", + "Description": "Determines whether or not a given NUMERIC expression is equal to a value" + }, + { + "Method": "IsGreaterThan(object, value)", + "Return Type": "boolean", + "Description": "Determines whether or not a given NUMERIC expression is greater than a value" + }, + { + "Method": "IsLessThan(object, value)", + "Return Type": "boolean", + "Description": "Determines whether or not a given NUMERIC expression is less than a value" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/methods/Lookup.json b/visual-kpi-docs/static/data/tables/functions/methods/Lookup.json new file mode 100644 index 00000000..6cfa0057 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/methods/Lookup.json @@ -0,0 +1,7 @@ +[ + { + "Method": "IN(string ItemToFind, string ListItem1, string ListItem2, \u00e2\u20ac\u00a6) IN(string\n ItemToFind,\n string[] ListItem)", + "Return Type": "boolean", + "Description": "Looks for ItemToFind in the specified list of items. Returns true if item is found in the\n list, false otherwise." + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/methods/MathStat.json b/visual-kpi-docs/static/data/tables/functions/methods/MathStat.json new file mode 100644 index 00000000..b16c5991 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/methods/MathStat.json @@ -0,0 +1,290 @@ +[ + { + "Method": "ABS(double)", + "Return Type": "double", + "Description": "Absolute value", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "ACOS(double)", + "Return Type": "double", + "Description": "Arccosine", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "ACOT(double)", + "Return Type": "double", + "Description": "Arccotangent", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "ACSC(double)", + "Return Type": "double", + "Description": "Arccosecant", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "ASEC(double)", + "Return Type": "double", + "Description": "Arcsecant", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "ASIN(double)", + "Return Type": "double", + "Description": "Arcsine", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "ATAN(double)", + "Return Type": "double", + "Description": "Arctangent", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "AVERAGE(double, double, ...)", + "Return Type": "double", + "Description": "Returns the average (arithmetic mean) of the arguments.", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "CEIL(double)", + "Return Type": "double", + "Description": "The smallest integer greater than or equal to the specified number.", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "COS(double)", + "Return Type": "double", + "Description": "The cosine of the given angle (in radians).", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "COSH(double)", + "Return Type": "double", + "Description": "Hyperbolic cosine", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "COT(double)", + "Return Type": "double", + "Description": "Cotangent", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "COTH(double)", + "Return Type": "double", + "Description": "Hyperbolic cotangent", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "COUNT(double, double, ...) COUNT(double[ ])", + "Return Type": "double", + "Description": "Total count of parameters passed", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "CSC(double)", + "Return Type": "double", + "Description": "Cosecant", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "CSCH(double)", + "Return Type": "double", + "Description": "Hyperbolic cosecant", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "EXP(double)", + "Return Type": "double", + "Description": "E (the base of natural logarithms) raised to the specified power", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "FLOOR(double) INT(double)", + "Return Type": "double", + "Description": "The greatest integer less than or equal to the specified number", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "FORMAT(double, string style)", + "Return Type": "String", + "Description": "Returns a string expression formatted according to instructions contained in a format string\n expression. For information on how to create the style argument, see the appropriate topic at MSDN:\n Predefined Numeric Formats User-Defined Numeric Formats", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "LN(double)", + "Return Type": "double", + "Description": "Natural logarithm", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "LOG(double, double base)", + "Return Type": "double", + "Description": "Logarithm to the specified base", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "LOG10(double)", + "Return Type": "double", + "Description": "Logarithm to base 10", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "MAX(double, double, ...) MAX(double[ ])", + "Return Type": "double", + "Description": "Maximum", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "MIN(double, double, ...) MIN(double[ ])", + "Return Type": "double", + "Description": "Minimum", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "NEG(double)", + "Return Type": "double", + "Description": "Negation", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "POWER(double, double power)", + "Return Type": "double", + "Description": "The specified number raised to the specified power", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "RAND([double max])", + "Return Type": "double", + "Description": "Random number between 0 and max. If max is undefined then RAND() returns random number\n between 0 and 1.", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "ROUND(double d, [int decimals])", + "Return Type": "double", + "Description": "Returns the number with the specified precision nearest the specified value.", + "Parameters": "d: A number to be rounded. decimals: The number of significant fractional digits\n (precision) in the return value. Ranges from 0 to 28.", + "Return Value": "The number nearest d with precision equal to decimals. If d is halfway between two numbers,\n one of which is even and the other odd, then the even number is returned. If the precision of d is less than\n decimals, then d is returned unchanged.", + "Remarks": "The decimals parameter specifies the number of significant fractional digits in the return\n value and ranges from 0 to 28. If decimals is zero, then a whole number is returned. This kind of rounding is\n sometimes called rounding to nearest, or banker's rounding." + }, + { + "Method": "SEC(double)", + "Return Type": "double", + "Description": "Secant", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "SECH(double)", + "Return Type": "double", + "Description": "Hyperbolic secant", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "SIN(double)", + "Return Type": "double", + "Description": "The sine of the given angle (in radians).", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "SINH(double)", + "Return Type": "double", + "Description": "Hyperbolic sine", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "SQRT(double)", + "Return Type": "double", + "Description": "Square root", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "SUM(double, double, ...) SUM(double[ ]) ", + "Return Type": "double", + "Description": "Sum of the specified numbers", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "TAN(double)", + "Return Type": "double", + "Description": "Tangent", + "Parameters": "", + "Return Value": "", + "Remarks": "" + }, + { + "Method": "TANH(double)", + "Return Type": "double", + "Description": "Hyperbolic tangent", + "Parameters": "", + "Return Value": "", + "Remarks": "" + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/functions/methods/Text.json b/visual-kpi-docs/static/data/tables/functions/methods/Text.json new file mode 100644 index 00000000..125be6b7 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/functions/methods/Text.json @@ -0,0 +1,52 @@ +[ + { + "Method": "Concat(object1, object2, \u00e2\u20ac\u00a6 objectN)", + "Return Type": "string", + "Description": "Returns a single concatenated string from a list of strings. doubles, ints, booleans." + }, + { + "Method": "ConcatSep(object1, object2, \u00e2\u20ac\u00a6 objectN, string delimiter)", + "Return Type": "string", + "Description": "Returns a single concatenated and delimited string from a list of strings. doubles, ints,\n booleans" + }, + { + "Method": "Find(string textToFind, string textToSearch, int startIndex)", + "Return Type": "int", + "Description": "Returns the zero-based index of the first occurrence of a textToFind, within a textToSearch\n string. The search starts at a specified character position (zero-based)." + }, + { + "Method": "Left(string, int nCount)", + "Return Type": "string", + "Description": "Returns the first (leftmost) nCount characters from a string." + }, + { + "Method": "Len(string)", + "Return Type": "int", + "Description": "Returns the number of characters in a string" + }, + { + "Method": "Lower(string)", + "Return Type": "string", + "Description": "Converts all uppercase letters in a text string to lowercase." + }, + { + "Method": "Mid(string, int nFirst, int nCount)", + "Return Type": "string", + "Description": "Returns a substring of length nCount characters from a string, starting at position nFirst\n (zero-based)." + }, + { + "Method": "Substitute(string text, string oldText, string newText)", + "Return Type": "string", + "Description": "Substitutes newText for oldText in a text string." + }, + { + "Method": "Trim(string)", + "Return Type": "string", + "Description": "Removes all occurrences of white space characters from the beginning and end of a string.\n " + }, + { + "Method": "Upper(string)", + "Return Type": "string", + "Description": "Converts all lowercase letters in a text string to uppercase." + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/groups-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json b/visual-kpi-docs/static/data/tables/groups-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json index 3809f707..c80956de 100644 --- a/visual-kpi-docs/static/data/tables/groups-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json +++ b/visual-kpi-docs/static/data/tables/groups-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json @@ -33,7 +33,7 @@ }, { "Visual KPI Attribute": "Group Selection Query", - "Description": "Determines what child Groups will appear in this Group based on their attributes (e.g., all Groups where 'Region' = 'Region NE'). For Groups with only 1 parent, it is best to use the Parent Name field on the child Groups.", + "Description": "Determines what child Groups will appear in this Group based on their attributes (e.g., all Groups where 'Region' = 'Region NE'). For Groups with only 1 parent, it's best to use the Parent Name field on the child Groups.", "Value": "", "AF": "no", "SQL": "yes", @@ -41,7 +41,7 @@ }, { "Visual KPI Attribute": "KPI Selection Query", - "Description": "Determines what KPIs will appear in this Group based on their attributes (e.g., all KPIs where 'Region' = 'Region NE'). For KPIs with only 1 parent, it is best to use the Group Name field on the KPIs.", + "Description": "Determines what KPIs will appear in this Group based on their attributes (e.g., all KPIs where 'Region' = 'Region NE'). For KPIs with only 1 parent, it's best to use the Group Name field on the KPIs.", "Value": "", "AF": "no", "SQL": "yes", @@ -49,7 +49,7 @@ }, { "Visual KPI Attribute": "Chart Selection Query", - "Description": "Determines what Charts (Trends, Pareto Charts, XY Plots, etc.) will appear in this Group based on their attributes (e.g., all Charts where 'Region' = 'Region NE'). For Charts with only 1 parent, it is best to use the Group Name field on the Charts.", + "Description": "Determines what Charts (Trends, Pareto Charts, XY Plots, etc.) will appear in this Group based on their attributes (e.g., all Charts where 'Region' = 'Region NE'). For Charts with only 1 parent, it's best to use the Group Name field on the Charts.", "Value": "", "AF": "no", "SQL": "yes", @@ -57,7 +57,7 @@ }, { "Visual KPI Attribute": "Table Selection Query", - "Description": "Determines what Tables will appear in this Group based on their attributes (e.g., all Tables where 'Region' = 'Region NE'). For Tables with only 1 parent, it is best to use the Group Name field on the Tables.", + "Description": "Determines what Tables will appear in this Group based on their attributes (e.g., all Tables where 'Region' = 'Region NE'). For Tables with only 1 parent, it's best to use the Group Name field on the Tables.", "Value": "", "AF": "no", "SQL": "yes", diff --git a/visual-kpi-docs/static/data/tables/kpi-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json b/visual-kpi-docs/static/data/tables/kpi-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json index 32b273be..c51de7bf 100644 --- a/visual-kpi-docs/static/data/tables/kpi-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json +++ b/visual-kpi-docs/static/data/tables/kpi-attributes-keywords-reference/VisualKPIDesignerAFSQLAndInmationAttributes.json @@ -593,7 +593,7 @@ }, { "Visual KPI Attribute": "Limit Calc Start Time", - "Description": "The Start Time that is used to calculate the limits and mean for the SPC KPI (Note: Start Time must be < End Time and the value can be an actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value.", + "Description": "The Start Time that's used to calculate the limits and mean for the SPC KPI (Note: Start Time must be < End Time and the value can be an actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value.", "Value": "", "AF": "yes", "SQL": "yes", @@ -609,7 +609,7 @@ }, { "Visual KPI Attribute": "Limit Calc End Time", - "Description": "The End Time that is used to calculate the limits and mean for the SPC KPI (Note: End Time must be > Start Time and the value can be actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value.", + "Description": "The End Time that's used to calculate the limits and mean for the SPC KPI (Note: End Time must be > Start Time and the value can be actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value.", "Value": "", "AF": "yes", "SQL": "yes", diff --git a/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/Dashboards.json b/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/Dashboards.json new file mode 100644 index 00000000..385fbaff --- /dev/null +++ b/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/Dashboards.json @@ -0,0 +1,50 @@ +[ + { + "Attribute": "Name", + "Description": "The name of the Dashboard that will appear to your users. Longer names may be truncated on small devices, so consider short names." + }, + { + "Attribute": "Display Order", + "Description": "The numeric value that overrides the default alphanumeric order of Dashboards. Dashboards with blanks will be sorted alphanumerically and displayed below Dashboards with numbers." + }, + { + "Attribute": "Description", + "Description": "The description of the Dashboard that will appear to your users. User longer descriptions in conjunction with shorter names to accommodate small screen formats." + }, + { + "Attribute": "Profile(s)", + "Description": "The name of the Profile(s) that this Dashboard belongs to. You can add the same Dashboard to many profiles by using a semicolon (;) delimited list (Profile1; Profile2)." + }, + { + "Attribute": "Locked", + "Description": "Controls whether users can modify this Dashboard. A locked Dashboard is considered read-only and cannot be modified." + }, + { + "Attribute": "Show", + "Description": "Boolean value to set the Show (visibility) of the Dashboard. A setting of False will suppress the display of the Dashboard to users." + }, + { + "Attribute": "Is Default", + "Description": "Boolean value to get whether or not the Dashboard is the default Dashboard. You can have only 1 default Dashboard per Profile, which will be the Dashboard displayed to a user who has not selected a Dashboard." + }, + { + "Attribute": "Start Time", + "Description": "Start of the time range for the Dashboard. Widgets on the Dashboard will all initially use this range if entered (Note: The Start Time must be < the End Time, and the value can be an actual or relative date. e.g., 6/12/2019 or *-7Days). Can be paired with a Start Time Interface." + }, + { + "Attribute": "Start Time Interface", + "Description": "The interface used to retrieve the Start Time value. If this field is blank, the Start Time field is treated as a constant value." + }, + { + "Attribute": "End Time", + "Description": "End time range for the Dashboard. Widgets on the Dashboard will all initially use this range if entered. (Note: The End Time must be > the Start Time, and the value can be an actual or relative date. e.g., 6/12/2019 or *-7Days). Can be paired with an End Time Interface." + }, + { + "Attribute": "End Time Interface", + "Description": "The interface used to retrieve the End Time value. If this field is blank, the End Time field is treated as a constant value." + }, + { + "Attribute": "Dashboard ID", + "Description": "Read-only system level identifier." + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/ProfileGroups.json b/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/ProfileGroups.json new file mode 100644 index 00000000..50d9f8d5 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/ProfileGroups.json @@ -0,0 +1,34 @@ +[ + { + "Attribute": "Name", + "Description": "The name of the Profile Group that will appear to your users. Longer names may be truncated on small devices, so consider short names." + }, + { + "Attribute": "Display Order", + "Description": "The numeric value that overrides the default alphanumeric order of Profile Groups. Profile Groups with blanks will be sorted alphanumerically and displayed below Profile Groups with numbers." + }, + { + "Attribute": "Description", + "Description": "The description of the Profile Group that will appear to your users. Use longer descriptions in conjunction with shorter names to accommodate small screen formats." + }, + { + "Attribute": "Private", + "Description": "Controls if this Profile Group is accessible to the user in the Private User column or if it's a Public Profile Group (accessible by all). Only applicable if ISS security is enabled on the site." + }, + { + "Attribute": "Private User", + "Description": "Active Directory or Local User associated with the Profile Group. Only applicable if the Profile Group is marked as Private and if IIS security is enabled on the site." + }, + { + "Attribute": "Locked", + "Description": "Controls if users can add Profiles to this Profile Group. A locked Profile Group is considered read-only and cannot be modified." + }, + { + "Attribute": "Show", + "Description": "A boolean value used to specify the Profile Group's 'Show' setting (visibility). 'False' will suppress the display of the Profile Group to users." + }, + { + "Attribute": "Profile Group ID", + "Description": "Read-only system level identifier." + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/Profiles.json b/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/Profiles.json new file mode 100644 index 00000000..5a28d791 --- /dev/null +++ b/visual-kpi-docs/static/data/tables/profiles-dashboards-site-settings-reference/Profiles.json @@ -0,0 +1,38 @@ +[ + { + "Attributes": "Name", + "Descriptions": "The name of the Profile that will appear to your users. Longer names may be truncated on small devices, so consider short names." + }, + { + "Attributes": "Display Order", + "Descriptions": "The numeric value that overrides the default alphanumeric order of Profile Groups. Profile Groups with blanks will be sorted alphanumerically and displayed below Profile Groups with numbers." + }, + { + "Attributes": "Description", + "Descriptions": "The description of the Profile that will appear to your users. User longer descriptions in conjunction with shorter names to accommodate small screen formats." + }, + { + "Attributes": "Profile Group", + "Descriptions": "The name of the Profile Group that this Profile belongs to." + }, + { + "Attributes": "Locked", + "Descriptions": "Controls whether users can modify this Profile. A locked Profile is considered read-only and cannot be modified." + }, + { + "Attributes": "Show", + "Descriptions": "Boolean value to set the Show (visibility) of the Profile. A setting of False will suppress the display of the Profile to users." + }, + { + "Attributes": "Is Default", + "Descriptions": "Boolean value to get whether or not the Profile is the default Profile. You can have only 1 default Profile, which will be displayed to a user who has not selected a Profile." + }, + { + "Attributes": "Access Group List", + "Descriptions": "List of Active Directory or local groups (semicolon separated) defining access rights to the object. Only applies if Object Level Security is enabled and the site is secured." + }, + { + "Attributes": "Profile ID", + "Descriptions": "Read-only system level identifier." + } +] diff --git a/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/kpi.json b/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/kpi.json index adace993..402c41f4 100644 --- a/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/kpi.json +++ b/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/kpi.json @@ -290,7 +290,7 @@ { "AF Attribute Name": "URL Descriptor, URLDescriptor, URL Description, URLDescription, URL Name, URLName", "Data Type": "String", - "Valid Values": "Any\n* URL and URL Descriptor can be semi-colon (;) delimited lists. It is best if you match these up (i.e. 3 urls and 3 descriptors)", + "Valid Values": "Any\n* URL and URL Descriptor can be semi-colon (;) delimited lists. it's best if you match these up (i.e. 3 urls and 3 descriptors)", "Visual KPI Designer Value": "" }, { diff --git a/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/value.json b/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/value.json index b9cda106..044bd57c 100644 --- a/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/value.json +++ b/visual-kpi-docs/static/data/tables/setup-adm/automation/keywords/value.json @@ -27,7 +27,7 @@ { "AF Attribute Name": "URL Descriptor, URLDescriptor, URL Description, URLDescription, URL Name, URLName", "Data Type": "String", - "Valid Values": "Any\n* URL and URL Descriptor can be semi-colon (;) delimited lists. It is best if you match these up (i.e. 3 urls and 3 descriptors)" + "Valid Values": "Any\n* URL and URL Descriptor can be semi-colon (;) delimited lists. it's best if you match these up (i.e. 3 urls and 3 descriptors)" }, { "AF Attribute Name": "Numeric Format, NumericFormat", diff --git a/visual-kpi-docs/static/data/tables/website-settings-reference/WebsiteSettings.json b/visual-kpi-docs/static/data/tables/website-settings-reference/WebsiteSettings.json new file mode 100644 index 00000000..5023505d --- /dev/null +++ b/visual-kpi-docs/static/data/tables/website-settings-reference/WebsiteSettings.json @@ -0,0 +1,507 @@ +[ + { + "Category": "Site Basics", + "Attribute": "Site Title", + "Description": "Website title displayed in the browser title bar." + }, + { + "Category": "Site Basics", + "Attribute": "Default Attribute Grouping", + "Description": "Default setting for attribute grouping of KPIs, Charts and Tables." + }, + { + "Category": "Site Basics", + "Attribute": "Site Administrator Contact", + "Description": "Visual KPI site administrator contact (also be used for cache server error notifications)." + }, + { + "Category": "Site Basics", + "Attribute": "Site Logo Link", + "Description": "Default link action when clicking site logos." + }, + { + "Category": "Site Basics", + "Attribute": "Screen Data Update Interval", + "Description": "Controls screen data update interval (in seconds) for Web pages. Set 0 to turn off page data refresh. (Note: This should not be faster than your cache cycle as the cache time determines how often data is refreshed on the server)." + }, + { + "Category": "Site Basics", + "Attribute": "Default Color Theme", + "Description": "Controls the default color theme (light or dark) for the site. Users can override this setting on each site if allowed." + }, + { + "Category": "Site Basics", + "Attribute": "Allow Users to Change Color Theme", + "Description": "Determines whether or not site users can select between Dark and Light themes." + }, + { + "Category": "Site Basics", + "Attribute": "Default Client Display Time", + "Description": "Controls the default display time (client time or server time) for all rendered timestamps. Site users can override this setting on each site if allowed." + }, + { + "Category": "Site Basics", + "Attribute": "Allow Users to Change Client Display Time", + "Description": "Determines whether or not site users will be able to select between client and server times for all rendered timestamps." + }, + { + "Category": "Site Basics", + "Attribute": "Garbage Collection Interval", + "Description": "Controls the interval (in minutes) for a full page refresh. This helps clear memory leaks--unfortunately common and not entirely unavoidable (yet) in Web applications. (Note: User actions will reset the interval. 0 = turn off this refresh)." + }, + { + "Category": "Cache and Alert Server", + "Attribute": "Cache Alert Notification Protocol", + "Description": "Cache server error notification delivery mechanism." + }, + { + "Category": "Cache and Alert Server", + "Attribute": "Cache Alert Reminder Interval", + "Description": "Controls how often (in minutes) cache server error alerts are sent to the site administrator." + }, + { + "Category": "Cache and Alert Server", + "Attribute": "Cache Warning Interval", + "Description": "Determines the time (in minutes) that should elapse before displaying a site level cache failure warning (0 = always hide this warning)." + }, + { + "Category": "Cache and Alert Server", + "Attribute": "Cache Status History Duration", + "Description": "Determines the time (in days) a KPI status history should be stored (Forever = keep all history). Note: A large number of Forever settings causes the size of the Visual KPI database to grow." + }, + { + "Category": "Cache and Alert Server", + "Attribute": "Alert Warning Interval", + "Description": "Determines time (in minutes) that should elapse before displaying a site level alert failure warning (0 = always hide this warning)." + }, + { + "Category": "Cache and Alert Server", + "Attribute": "KPI Status History Storage Duration", + "Description": "Determines time (in days) a KPI status history is stored." + }, + { + "Category": "Tab Defaults", + "Attribute": "Default Tab", + "Description": "Determines the default tab for each group. 'System' automatically displays the first non-empty tab in this series (Groups, KPIs, Charts, Tables)." + }, + { + "Category": "Tab Defaults", + "Attribute": "Default Group View", + "Description": "Determines the default view for Groups on the home page." + }, + { + "Category": "Tab Defaults", + "Attribute": "Default KPI View", + "Description": "Determines the default view for KPIs." + }, + { + "Category": "Tab Defaults", + "Attribute": "Default Chart View", + "Description": "Determines the default view for Charts." + }, + { + "Category": "Tab Defaults", + "Attribute": "Default Table View", + "Description": "Determines the default view for Tables." + }, + { + "Category": "Column Defaults", + "Attribute": "Default Info Column Display Name", + "Description": "Default name used to display the info column in Groups, KPIs, Charts and Tables." + }, + { + "Category": "Column Defaults", + "Attribute": "Default KPI Actual Column Display Name", + "Description": "Default name used to display the actual column in KPIs." + }, + { + "Category": "Column Defaults", + "Attribute": "Default KPI Target Column Display Name", + "Description": "Default name used to display the target column in KPIs." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Default Numerical Format", + "Description": "Default numeric format string for KPIs and Info. Leave blank for system defaults." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Use KPI Name as Top Text", + "Description": "Determines whether or not the KPI name is used by default as the KPI Map top text if no other top text has been entered." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Use KPI Actual as Bottom Text", + "Description": "Determines whether or not the KPI actual value is used by default as the KPI Map bottom text if no other bottom text has been entered." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Use KPI Description as Additional Text", + "Description": "Determines whether or not the KPI description is used by default as the KPI Map additional text if no other additional text has been entered." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Lookup Text Length", + "Description": "Maximum length of lookup text displayed on chart cursors (0 = No lookup text displayed)." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Maximum Group Count", + "Description": "Maximum number of Groups displayed. Additional Groups can be shown by clicking 'Show More' (100 max)." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Maximum Object Count", + "Description": "Maximum number of KPIs, Charts and Tables initially displayed. Additional KPIs, Charts and Tables can be shown by clicking 'Show More' (100 max)." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Maximum KPI Map Cell Count", + "Description": "Maximum number of KPIs initially displayed as a KPI Map. Additional KPIs can be shown by clicking 'Show More' (500 max)." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Maximum Group Map Count", + "Description": "Maximum number of Groups initially displayed as a Group Map. Additional Groups can be shown by clicking 'Show More' (200 max)." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Maximum Pareto Chart Bar Count", + "Description": "Maximum number of bars displayed for dynamic Pareto Charts given a large enough display (5 min and 50 max)." + }, + { + "Category": "Text, Number and Size Defaults", + "Attribute": "Profile Most Recently Used Count", + "Description": "Maximum number of recently used Profiles shown in profile list (3 min and 10 max)." + }, + { + "Category": "Geo Map and Near Me Settings", + "Attribute": "Default Near Me Distance Unit", + "Description": "Default unit of measure for Near Me distance." + }, + { + "Category": "Geo Map and Near Me Settings", + "Attribute": "Default Group Geo Map Label Format", + "Description": "Default format of Group Geo Map labels." + }, + { + "Category": "Geo Map and Near Me Settings", + "Attribute": "Default KPI Geo Map Label Format", + "Description": "Default format of KPI Geo Map labels." + }, + { + "Category": "Geo Map and Near Me Settings", + "Attribute": "Show Geo Map Info Window On Large Screens", + "Description": "Controls whether or not to display the pop-up Geo Map info panels on screens with a horizontal resolution of 768 pixels or more." + }, + { + "Category": "Geo Map and Near Me Settings", + "Attribute": "Show Geo Map Info Window On Small Screens", + "Description": "Controls whether or not to display the pop-up Geo Map info panel on screens with a horizontal resolution of 768 pixels or less." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Enable Trend Auto Play", + "Description": "Controls whether or not Trends will dynamically update." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Maximum Large Screen Chart Cursors", + "Description": "Controls how many lockable cursors (10 max) are allowed on Charts displayed on screens with a horizontal resolution of 768 pixels or more." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Maximum Small Screen Chart Cursors", + "Description": "Controls how many lockable cursors (10 max) are allowed on Charts displayed on screens with a horizontal resolution of 768 pixels or less." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Calculations in Chart Cursors", + "Description": "Controls whether or calculations (equations) are displayed in Chart cursors." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Limits on KPI Trends", + "Description": "Controls whether or not to initially display limits on KPI Trends (can toggle ON/OFF)." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Target on KPI Trends", + "Description": "Controls whether or not to initially display target on KPI Trends (can toggle ON/OFF)." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Status Background on KPI Trends", + "Description": "Controls whether or not to initially display status bars on the background of KPI Trends (can toggle ON/OFF--requires KPI Status History Storage Duration > 0)." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Gridlines on Trends", + "Description": "Controls whether or not gridlines are visible on Trends." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Gridlines on Pareto Charts", + "Description": "Controls whether or not gridlines are visible on Pareto Charts." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Gridlines on Bar Charts", + "Description": "Controls whether or not gridlines are visible on Bar Charts." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Show Gridlines on XY Plots", + "Description": "Controls whether or not gridlines are visible on XY Plots." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Scroll Increment", + "Description": "Length of time that timestamp-based Charts and Tables can be scrolled." + }, + { + "Category": "Chart & Table Settings", + "Attribute": "Scroll Increment Unit", + "Description": "Unit of time that timestamp-based Charts and Tables can be scrolled." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Sticky Header", + "Description": "Controls whether or not the page header will scroll as the page is scrolled." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Legend", + "Description": "Controls whether or not page legends are displayed." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Site Information", + "Description": "Controls whether or not the site information page is available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Group Detail", + "Description": "Controls whether or not Group detail pages are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show KPI Detail", + "Description": "Controls whether or not KPI detail pages are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Chart Detail", + "Description": "Controls whether or not Chart detail pages are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Table Detail", + "Description": "Controls whether or not Table detail pages are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Site Rollup Links", + "Description": "Controls whether or not links on Site Rollups are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Group Links", + "Description": "Controls whether or not links on Groups are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show KPI Links", + "Description": "Controls whether or not links on KPIs are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Chart Links", + "Description": "Controls whether or not links on Charts are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Table Links", + "Description": "Controls whether or not links on Tables are available." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Target on KPI Sparkline", + "Description": "Controls whether or not KPI sparklines show Target pen." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Empty Groups", + "Description": "Controls whether or not Groups with no data are displayed (Note: Empty Groups will always be hidden if Object Level Security is enabled)." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show KPI Roll-Ups", + "Description": "Controls whether or not Group KPI Roll-Up bars are displayed." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Name Tooltip", + "Description": "Controls whether or not an object's name displays a tooltip on mouse-over." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Unused Fields in Detail Pages", + "Description": "Detail pages will show 'N/A' for all empty or unused fields if this setting is TRUE." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Display Alert History on KPI Detail Page", + "Description": "Controls whether or not alert history appears on KPI detail pages." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show KPI Override Indicator", + "Description": "Controls whether or not the KPI override indicator (*) is shown on KPIs with a status override." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Recently Changed Time Limit", + "Description": "Controls time (in minutes) the system considers a KPI status change to be 'recent'." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Recently Changed \"Flash\" Duration", + "Description": "Controls time (in seconds) the KPI will 'flash' after screen load for a recently changed KPI. (Off = Never, Max = Until no longer 'recent', or any numeric value)." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Group Description in Rollup Page", + "Description": "Controls whether or not Group descriptions appear in column next to Rollups." + }, + { + "Category": "Page and Information Visibility Settings", + "Attribute": "Show Child Objects With Groups", + "Description": "Controls whether or not child objects (KPIs, Charts and Tables) are shown on the same page as Groups in List View." + }, + { + "Category": "Group Map Settings", + "Attribute": "Default Group Map KPI Cell Count", + "Description": "Number of KPI cells displayed on each Group Map (1 minimum and 20 max)." + }, + { + "Category": "Group Map Settings", + "Attribute": "Default Group Map Header Priority", + "Description": "Controls Group Map header cell behavior. Sets the header color and icon based on status: 'Recently Changed' = color of most recently changed KPI and icon to overall KPI status. 'Overall' = color of most severe KPI status and icon to most recently changed status. 'Custom Colors' = color to either the custom recently changed or not recently changed colors and no icons." + }, + { + "Category": "Group Map Settings", + "Attribute": "Recently Changed Color", + "Description": "Group Map header color if one or more KPIs in the Group has recently changed (applies only if Custom Colors is selected for Header Priority)." + }, + { + "Category": "Group Map Settings", + "Attribute": "Not Recently Changed Color", + "Description": "Group Map header color if no KPIs in the Group have recently changed (applies only if Custom Colors is selected for Header Priority)." + }, + { + "Category": "Group Map Settings", + "Attribute": "Group Map Force Fit", + "Description": "Controls whether or not the Group Map will display on a single screen (no scrolling). This can cause large Group Maps to render with very small cells that are difficult to read. If the cell size gets too small text will be removed." + }, + { + "Category": "Group Map Settings", + "Attribute": "Default Group Map Expansion Setting", + "Description": "Controls whether or not the Group Map is expanded or collapsed (header only) by default." + }, + { + "Category": "Group Map Settings", + "Attribute": "Group Map Header Severity", + "Description": "Controls how the system calculates severity of status for use in header colors and icons. (Note: Not In Service always overrides other statuses)." + }, + { + "Category": "KPI Block (Widget) Settings", + "Attribute": "Simplify KPI Blocks with Missing Data", + "Description": "Simplify KPI block widget if a valid sparkline and Bullet Chart cannot be rendered. (TRUE = remove sparkline, Bullet Chart, actions, statistics and contact)." + }, + { + "Category": "KPI Block (Widget) Settings", + "Attribute": "Show Sparkline on KPI Blocks", + "Description": "Display a sparkline (trend) on KPI Blocks (Note: Can override setting on each block)." + }, + { + "Category": "KPI Block (Widget) Settings", + "Attribute": "Show Bullet Chart on KPI Blocks", + "Description": "Display a Bullet Chart on KPI Blocks (Note: Can override setting on each block)." + }, + { + "Category": "KPI Block (Widget) Settings", + "Attribute": "Show Status History Chart on KPI Blocks", + "Description": "Display a Status History Chart on KPI Blocks (Note: Can override setting on each block)." + }, + { + "Category": "KPI Block (Widget) Settings", + "Attribute": "Show Statistics on KPI Blocks", + "Description": "Display statistics on KPI Blocks (Note: Can override setting on each block)." + }, + { + "Category": "KPI Block (Widget) Settings", + "Attribute": "Show Actions on KPI Blocks", + "Description": "Display actions on KPI Blocks (Note: Can override setting on each block)." + }, + { + "Category": "KPI Block (Widget) Settings", + "Attribute": "Show Contact on KPI Blocks", + "Description": "Display KPI contact on KPI Blocks (Note: Can override setting on each block)." + }, + { + "Category": "Time Range and Event Range Settings", + "Attribute": "Show Time Ranges", + "Description": "Controls whether or not the predefined list of time ranges displays on range pickers (Note: The predefined list of ranges must also be configured)." + }, + { + "Category": "Time Range and Event Range Settings", + "Attribute": "Show Event Ranges", + "Description": "Controls whether or not query based event ranges displays on range pickers (Note: Event Range connectstring and query must also be defined)." + }, + { + "Category": "Time Range and Event Range Settings", + "Attribute": "Default Expanded Range Section", + "Description": "Controls which range selection section is expanded by default (Note: This will only apply if both event and time ranges have been configured and set to SHOW)." + }, + { + "Category": "Calculation Settings", + "Attribute": "Calculation Type", + "Description": "Controls how non numeric values in calculations are handled." + }, + { + "Category": "Calculation Settings", + "Attribute": "Numeric Substitution Value", + "Description": "Substitution value for string results in numeric calculations. This is useful when dealing with exception data (e.g. BadValue) returned from data sources used in a calculation." + }, + { + "Category": "Calculation Settings", + "Attribute": "Status Calculation", + "Description": "Used to determine KPI status change calculation behavior. 'Exceeds Only' = Actual is less than < a low limit or greater than > a high limit. 'Meets or Exceeds' (default) = Actual is less than < or equal to = a low limit or greater than > or equal to = a high limit." + }, + { + "Category": "Watchlist Settings", + "Attribute": "Default Watchlist View", + "Description": "Determines the default view for Watchlist KPIs." + }, + { + "Category": "Watchlist Settings", + "Attribute": "Default Watchlist Attribute Grouping", + "Description": "Default setting for attribute grouping of Watchlist KPIs." + }, + { + "Category": "Security Settings", + "Attribute": "Windows Security All Access Group", + "Description": "Windows Security Group that grants user(s) access to all objects. (Used when Object Level Security is enabled)." + }, + { + "Category": "Security Settings", + "Attribute": "Visual KPI Admin Group", + "Description": "Windows Security Group that grants user(s) admin rights to objects via the website. (Used for Trend Comments and Profile management)." + }, + { + "Category": "Security Settings", + "Attribute": "Enable Outbound Requests", + "Description": "Controls whether or not outbound links (e.g. URLs, Fonts, Google APIs) are enabled (Note: Must enable to use Geo Maps)." + } +] \ No newline at end of file diff --git a/visual-kpi-docs/static/img/designer/barchart-enduser.png b/visual-kpi-docs/static/img/designer/barchart-enduser.png new file mode 100644 index 00000000..d9f4abd3 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/barchart-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-attributes.png b/visual-kpi-docs/static/img/designer/charts-attributes.png new file mode 100644 index 00000000..a5d7d176 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-attributes.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-boxplot-enduser.png b/visual-kpi-docs/static/img/designer/charts-boxplot-enduser.png new file mode 100644 index 00000000..a2507868 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-boxplot-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-coloring.png b/visual-kpi-docs/static/img/designer/charts-coloring.png new file mode 100644 index 00000000..8c5ac172 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-coloring.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-gantt-enduser.png b/visual-kpi-docs/static/img/designer/charts-gantt-enduser.png new file mode 100644 index 00000000..d630cf35 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-gantt-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-ganttchart.png b/visual-kpi-docs/static/img/designer/charts-ganttchart.png new file mode 100644 index 00000000..b23c4394 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-ganttchart.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-ganttstatus.png b/visual-kpi-docs/static/img/designer/charts-ganttstatus.png new file mode 100644 index 00000000..dc4a82c7 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-ganttstatus.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-pareto-worksheet.png b/visual-kpi-docs/static/img/designer/charts-pareto-worksheet.png new file mode 100644 index 00000000..ad5c76ce Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-pareto-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-pie-enduser.png b/visual-kpi-docs/static/img/designer/charts-pie-enduser.png new file mode 100644 index 00000000..f646f173 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-pie-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-pie-worksheet.png b/visual-kpi-docs/static/img/designer/charts-pie-worksheet.png new file mode 100644 index 00000000..d776558d Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-pie-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-worksheet.png b/visual-kpi-docs/static/img/designer/charts-worksheet.png new file mode 100644 index 00000000..2e760ab3 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-xyplot-enduser.png b/visual-kpi-docs/static/img/designer/charts-xyplot-enduser.png new file mode 100644 index 00000000..f8692a41 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-xyplot-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-xyplot-series-enduser.png b/visual-kpi-docs/static/img/designer/charts-xyplot-series-enduser.png new file mode 100644 index 00000000..49ef4554 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-xyplot-series-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/charts-xyplot-worksheet.png b/visual-kpi-docs/static/img/designer/charts-xyplot-worksheet.png new file mode 100644 index 00000000..df32bcb0 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/charts-xyplot-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/group-search.png b/visual-kpi-docs/static/img/designer/group-search.png new file mode 100644 index 00000000..719874f4 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/group-search.png differ diff --git a/visual-kpi-docs/static/img/designer/groups-enduser.png b/visual-kpi-docs/static/img/designer/groups-enduser.png new file mode 100644 index 00000000..06bc4606 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/groups-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/groups-query-example1.png b/visual-kpi-docs/static/img/designer/groups-query-example1.png new file mode 100644 index 00000000..fcfc0b84 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/groups-query-example1.png differ diff --git a/visual-kpi-docs/static/img/designer/groups-worksheet.png b/visual-kpi-docs/static/img/designer/groups-worksheet.png new file mode 100644 index 00000000..a0a178ef Binary files /dev/null and b/visual-kpi-docs/static/img/designer/groups-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/kpi-externalsource.png b/visual-kpi-docs/static/img/designer/kpi-externalsource.png new file mode 100644 index 00000000..16548aea Binary files /dev/null and b/visual-kpi-docs/static/img/designer/kpi-externalsource.png differ diff --git a/visual-kpi-docs/static/img/designer/kpi-parameters-example1.png b/visual-kpi-docs/static/img/designer/kpi-parameters-example1.png new file mode 100644 index 00000000..56dd79ab Binary files /dev/null and b/visual-kpi-docs/static/img/designer/kpi-parameters-example1.png differ diff --git a/visual-kpi-docs/static/img/designer/kpi-parameters.png b/visual-kpi-docs/static/img/designer/kpi-parameters.png new file mode 100644 index 00000000..900bd243 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/kpi-parameters.png differ diff --git a/visual-kpi-docs/static/img/designer/kpi-trends-enduser.png b/visual-kpi-docs/static/img/designer/kpi-trends-enduser.png new file mode 100644 index 00000000..05592465 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/kpi-trends-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/kpi-trends-worksheet.png b/visual-kpi-docs/static/img/designer/kpi-trends-worksheet.png new file mode 100644 index 00000000..69261b14 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/kpi-trends-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/kpis-spc.png b/visual-kpi-docs/static/img/designer/kpis-spc.png new file mode 100644 index 00000000..2bbc343b Binary files /dev/null and b/visual-kpi-docs/static/img/designer/kpis-spc.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-attributes.png b/visual-kpi-docs/static/img/designer/query-chart-example-attributes.png new file mode 100644 index 00000000..3a83ee86 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-attributes.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-data.png b/visual-kpi-docs/static/img/designer/query-chart-example-data.png new file mode 100644 index 00000000..8f43a477 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-data.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result1-enduser.png b/visual-kpi-docs/static/img/designer/query-chart-example-result1-enduser.png new file mode 100644 index 00000000..c7e76e11 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result1-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result1.png b/visual-kpi-docs/static/img/designer/query-chart-example-result1.png new file mode 100644 index 00000000..d3ea22b0 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result1.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result2-enduser.png b/visual-kpi-docs/static/img/designer/query-chart-example-result2-enduser.png new file mode 100644 index 00000000..52b52204 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result2-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result2.png b/visual-kpi-docs/static/img/designer/query-chart-example-result2.png new file mode 100644 index 00000000..7a6ecf4f Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result2.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser-pareto.png b/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser-pareto.png new file mode 100644 index 00000000..cf29ed99 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser-pareto.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser-pie.png b/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser-pie.png new file mode 100644 index 00000000..29b08976 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser-pie.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser.png b/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser.png new file mode 100644 index 00000000..cd5794c7 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result3-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-example-result3.png b/visual-kpi-docs/static/img/designer/query-chart-example-result3.png new file mode 100644 index 00000000..1701b703 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-example-result3.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-series- example-chart1.png b/visual-kpi-docs/static/img/designer/query-chart-series- example-chart1.png new file mode 100644 index 00000000..070ca2ae Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-series- example-chart1.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-series- example-chart2.png b/visual-kpi-docs/static/img/designer/query-chart-series- example-chart2.png new file mode 100644 index 00000000..7f07f9de Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-series- example-chart2.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-series- example-chart3.png b/visual-kpi-docs/static/img/designer/query-chart-series- example-chart3.png new file mode 100644 index 00000000..8e805c2c Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-series- example-chart3.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-series- example-data2.png b/visual-kpi-docs/static/img/designer/query-chart-series- example-data2.png new file mode 100644 index 00000000..117d3609 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-series- example-data2.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-series- example-data3.png b/visual-kpi-docs/static/img/designer/query-chart-series- example-data3.png new file mode 100644 index 00000000..e19c54e6 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-series- example-data3.png differ diff --git a/visual-kpi-docs/static/img/designer/query-chart-series-example-data1.png b/visual-kpi-docs/static/img/designer/query-chart-series-example-data1.png new file mode 100644 index 00000000..f1334bd6 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/query-chart-series-example-data1.png differ diff --git a/visual-kpi-docs/static/img/designer/spc-dynamictime.png b/visual-kpi-docs/static/img/designer/spc-dynamictime.png new file mode 100644 index 00000000..49a35652 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/spc-dynamictime.png differ diff --git a/visual-kpi-docs/static/img/designer/spc-fixedtime.png b/visual-kpi-docs/static/img/designer/spc-fixedtime.png new file mode 100644 index 00000000..0f0c24d7 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/spc-fixedtime.png differ diff --git a/visual-kpi-docs/static/img/designer/spc-limits.png b/visual-kpi-docs/static/img/designer/spc-limits.png new file mode 100644 index 00000000..f3a54e5f Binary files /dev/null and b/visual-kpi-docs/static/img/designer/spc-limits.png differ diff --git a/visual-kpi-docs/static/img/designer/spc-selection.png b/visual-kpi-docs/static/img/designer/spc-selection.png new file mode 100644 index 00000000..fbecc319 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/spc-selection.png differ diff --git a/visual-kpi-docs/static/img/designer/tables-enduser.png b/visual-kpi-docs/static/img/designer/tables-enduser.png new file mode 100644 index 00000000..789f430d Binary files /dev/null and b/visual-kpi-docs/static/img/designer/tables-enduser.png differ diff --git a/visual-kpi-docs/static/img/designer/tables-format.png b/visual-kpi-docs/static/img/designer/tables-format.png new file mode 100644 index 00000000..e8687623 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/tables-format.png differ diff --git a/visual-kpi-docs/static/img/designer/tables-link.png b/visual-kpi-docs/static/img/designer/tables-link.png new file mode 100644 index 00000000..fc8a227c Binary files /dev/null and b/visual-kpi-docs/static/img/designer/tables-link.png differ diff --git a/visual-kpi-docs/static/img/designer/tables-worksheet.png b/visual-kpi-docs/static/img/designer/tables-worksheet.png new file mode 100644 index 00000000..4c08b987 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/tables-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/trends-worksheet.png b/visual-kpi-docs/static/img/designer/trends-worksheet.png new file mode 100644 index 00000000..372ac772 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/trends-worksheet.png differ diff --git a/visual-kpi-docs/static/img/designer/trends-worksheet2.png b/visual-kpi-docs/static/img/designer/trends-worksheet2.png new file mode 100644 index 00000000..13297f65 Binary files /dev/null and b/visual-kpi-docs/static/img/designer/trends-worksheet2.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/basic-icons-designer.png b/visual-kpi-docs/static/img/docs/designer/getting-started/basic-icons-designer.png new file mode 100644 index 00000000..56a54282 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/basic-icons-designer.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/cache-alert.png b/visual-kpi-docs/static/img/docs/designer/getting-started/cache-alert.png new file mode 100644 index 00000000..e4d7d6b9 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/cache-alert.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/connecting-visualdesigner.png b/visual-kpi-docs/static/img/docs/designer/getting-started/connecting-visualdesigner.png new file mode 100644 index 00000000..ac7e24d2 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/connecting-visualdesigner.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/contextual-helper.png b/visual-kpi-docs/static/img/docs/designer/getting-started/contextual-helper.png new file mode 100644 index 00000000..1ef96ac4 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/contextual-helper.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/installation-downloadbutton.png b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-downloadbutton.png new file mode 100644 index 00000000..582690f2 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-downloadbutton.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/installation-executefile.png b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-executefile.png new file mode 100644 index 00000000..4fc317c4 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-executefile.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/installation-successful.png b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-successful.png new file mode 100644 index 00000000..26d4efe1 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-successful.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/installation-terms-accept.png b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-terms-accept.png new file mode 100644 index 00000000..35d512c4 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/installation-terms-accept.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/logo-selection.png b/visual-kpi-docs/static/img/docs/designer/getting-started/logo-selection.png new file mode 100644 index 00000000..f38751ca Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/logo-selection.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/object-icons-designer.png b/visual-kpi-docs/static/img/docs/designer/getting-started/object-icons-designer.png new file mode 100644 index 00000000..48cd2498 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/object-icons-designer.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/overview-visualdesigner.png b/visual-kpi-docs/static/img/docs/designer/getting-started/overview-visualdesigner.png new file mode 100644 index 00000000..93f94fed Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/overview-visualdesigner.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/site-administrator-contact.png b/visual-kpi-docs/static/img/docs/designer/getting-started/site-administrator-contact.png new file mode 100644 index 00000000..bdf846da Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/site-administrator-contact.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/site-title-configuration.png b/visual-kpi-docs/static/img/docs/designer/getting-started/site-title-configuration.png new file mode 100644 index 00000000..f2dcfd51 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/site-title-configuration.png differ diff --git a/visual-kpi-docs/static/img/docs/designer/getting-started/worksheet.png b/visual-kpi-docs/static/img/docs/designer/getting-started/worksheet.png new file mode 100644 index 00000000..36205d37 Binary files /dev/null and b/visual-kpi-docs/static/img/docs/designer/getting-started/worksheet.png differ diff --git a/visual-kpi-docs/static/img/homepage/card6.png b/visual-kpi-docs/static/img/homepage/card6.png new file mode 100644 index 00000000..73e40ba6 Binary files /dev/null and b/visual-kpi-docs/static/img/homepage/card6.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/Rabbit28.png b/visual-kpi-docs/static/img/icons/designer/Rabbit28.png new file mode 100644 index 00000000..db28b8d8 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/Rabbit28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/StatusHistoryRefresh28.png b/visual-kpi-docs/static/img/icons/designer/StatusHistoryRefresh28.png new file mode 100644 index 00000000..d43fe4ac Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/StatusHistoryRefresh28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/Tools28.png b/visual-kpi-docs/static/img/icons/designer/Tools28.png new file mode 100644 index 00000000..095b576b Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/Tools28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/Transpara Logo.png b/visual-kpi-docs/static/img/icons/designer/Transpara Logo.png new file mode 100644 index 00000000..92853e1b Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/Transpara Logo.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/VisualKPILogo.png b/visual-kpi-docs/static/img/icons/designer/VisualKPILogo.png new file mode 100644 index 00000000..572219c7 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/VisualKPILogo.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/advancedmode28gray.png b/visual-kpi-docs/static/img/icons/designer/advancedmode28gray.png new file mode 100644 index 00000000..3f38d4fd Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/advancedmode28gray.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/advancedmode28green.png b/visual-kpi-docs/static/img/icons/designer/advancedmode28green.png new file mode 100644 index 00000000..3f900078 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/advancedmode28green.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/advancedmodereddot28gray.png b/visual-kpi-docs/static/img/icons/designer/advancedmodereddot28gray.png new file mode 100644 index 00000000..ecd7216e Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/advancedmodereddot28gray.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/apply28.fw.png b/visual-kpi-docs/static/img/icons/designer/apply28.fw.png new file mode 100644 index 00000000..224473cb Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/apply28.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/apply28.png b/visual-kpi-docs/static/img/icons/designer/apply28.png new file mode 100644 index 00000000..d6d4aad5 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/apply28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/book16.png b/visual-kpi-docs/static/img/icons/designer/book16.png new file mode 100644 index 00000000..322f6e8e Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/book16.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/clear28.png b/visual-kpi-docs/static/img/icons/designer/clear28.png new file mode 100644 index 00000000..67958252 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/clear28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/clear28a.png b/visual-kpi-docs/static/img/icons/designer/clear28a.png new file mode 100644 index 00000000..68a3b23e Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/clear28a.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/closeallbutthis28.fw.png b/visual-kpi-docs/static/img/icons/designer/closeallbutthis28.fw.png new file mode 100644 index 00000000..95f4f949 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/closeallbutthis28.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/closeallworksheets28.fw.png b/visual-kpi-docs/static/img/icons/designer/closeallworksheets28.fw.png new file mode 100644 index 00000000..6d283e25 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/closeallworksheets28.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/closeworksheet28.png b/visual-kpi-docs/static/img/icons/designer/closeworksheet28.png new file mode 100644 index 00000000..790e59ed Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/closeworksheet28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/colorpicker28.png b/visual-kpi-docs/static/img/icons/designer/colorpicker28.png new file mode 100644 index 00000000..cf2f4008 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/colorpicker28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/deleteselected28.png b/visual-kpi-docs/static/img/icons/designer/deleteselected28.png new file mode 100644 index 00000000..790e59ed Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/deleteselected28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/helpcircle16.png b/visual-kpi-docs/static/img/icons/designer/helpcircle16.png new file mode 100644 index 00000000..d3eaeb73 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/helpcircle16.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/infocircle16.png b/visual-kpi-docs/static/img/icons/designer/infocircle16.png new file mode 100644 index 00000000..7ca194a9 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/infocircle16.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/instanceconnections28a.fw.png b/visual-kpi-docs/static/img/icons/designer/instanceconnections28a.fw.png new file mode 100644 index 00000000..cbc70295 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/instanceconnections28a.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/instanceconnections28a.png b/visual-kpi-docs/static/img/icons/designer/instanceconnections28a.png new file mode 100644 index 00000000..cbc70295 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/instanceconnections28a.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/membership28.png b/visual-kpi-docs/static/img/icons/designer/membership28.png new file mode 100644 index 00000000..83ed9fbc Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/membership28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/new28.png b/visual-kpi-docs/static/img/icons/designer/new28.png new file mode 100644 index 00000000..b7056905 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/new28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/open28.png b/visual-kpi-docs/static/img/icons/designer/open28.png new file mode 100644 index 00000000..872056b2 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/open28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/openselected28-1.fw.png b/visual-kpi-docs/static/img/icons/designer/openselected28-1.fw.png new file mode 100644 index 00000000..2abd4bda Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/openselected28-1.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/openselected28-2.fw.png b/visual-kpi-docs/static/img/icons/designer/openselected28-2.fw.png new file mode 100644 index 00000000..c146b2f9 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/openselected28-2.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/openselected28.png b/visual-kpi-docs/static/img/icons/designer/openselected28.png new file mode 100644 index 00000000..3a8e04c2 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/openselected28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/options28.png b/visual-kpi-docs/static/img/icons/designer/options28.png new file mode 100644 index 00000000..e73a6f51 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/options28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/options28eee.png b/visual-kpi-docs/static/img/icons/designer/options28eee.png new file mode 100644 index 00000000..5377ceda Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/options28eee.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/options28white.png b/visual-kpi-docs/static/img/icons/designer/options28white.png new file mode 100644 index 00000000..1d22f815 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/options28white.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/preview28-2.fw.png b/visual-kpi-docs/static/img/icons/designer/preview28-2.fw.png new file mode 100644 index 00000000..ccdd6de5 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/preview28-2.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/preview28.fw.png b/visual-kpi-docs/static/img/icons/designer/preview28.fw.png new file mode 100644 index 00000000..63a49268 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/preview28.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/refreshmetadata28.fw.png b/visual-kpi-docs/static/img/icons/designer/refreshmetadata28.fw.png new file mode 100644 index 00000000..9762638e Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/refreshmetadata28.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/refreshmetadata28.png b/visual-kpi-docs/static/img/icons/designer/refreshmetadata28.png new file mode 100644 index 00000000..f33e3700 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/refreshmetadata28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/refreshmetadata28old.png b/visual-kpi-docs/static/img/icons/designer/refreshmetadata28old.png new file mode 100644 index 00000000..c8dcb4a6 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/refreshmetadata28old.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/removelogo28.png b/visual-kpi-docs/static/img/icons/designer/removelogo28.png new file mode 100644 index 00000000..790e59ed Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/removelogo28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/resettodefault28.png b/visual-kpi-docs/static/img/icons/designer/resettodefault28.png new file mode 100644 index 00000000..b2fee74a Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/resettodefault28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/save28.png b/visual-kpi-docs/static/img/icons/designer/save28.png new file mode 100644 index 00000000..2d9908e9 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/save28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/selectall28a.fw.png b/visual-kpi-docs/static/img/icons/designer/selectall28a.fw.png new file mode 100644 index 00000000..c9503991 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/selectall28a.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/selecticon28.png b/visual-kpi-docs/static/img/icons/designer/selecticon28.png new file mode 100644 index 00000000..c6509937 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/selecticon28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/separator.png b/visual-kpi-docs/static/img/icons/designer/separator.png new file mode 100644 index 00000000..ad15e1d3 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/separator.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/separator28.fw.png b/visual-kpi-docs/static/img/icons/designer/separator28.fw.png new file mode 100644 index 00000000..270784b8 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/separator28.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/tag28.png b/visual-kpi-docs/static/img/icons/designer/tag28.png new file mode 100644 index 00000000..e8f190be Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/tag28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/tooltip28gray.png b/visual-kpi-docs/static/img/icons/designer/tooltip28gray.png new file mode 100644 index 00000000..8a5b32cc Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/tooltip28gray.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/tooltip28green.png b/visual-kpi-docs/static/img/icons/designer/tooltip28green.png new file mode 100644 index 00000000..603a4856 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/tooltip28green.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/tooltipreddot28gray.png b/visual-kpi-docs/static/img/icons/designer/tooltipreddot28gray.png new file mode 100644 index 00000000..fdb98ca3 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/tooltipreddot28gray.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/transpara28.png b/visual-kpi-docs/static/img/icons/designer/transpara28.png new file mode 100644 index 00000000..9bbde25b Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/transpara28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/unselectall28a.fw.png b/visual-kpi-docs/static/img/icons/designer/unselectall28a.fw.png new file mode 100644 index 00000000..114f7d1d Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/unselectall28a.fw.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/uploadlogo28.png b/visual-kpi-docs/static/img/icons/designer/uploadlogo28.png new file mode 100644 index 00000000..cc629206 Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/uploadlogo28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/verifyinterface28.png b/visual-kpi-docs/static/img/icons/designer/verifyinterface28.png new file mode 100644 index 00000000..63da4ffa Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/verifyinterface28.png differ diff --git a/visual-kpi-docs/static/img/icons/designer/viewwebsite28.png b/visual-kpi-docs/static/img/icons/designer/viewwebsite28.png new file mode 100644 index 00000000..cacd70cf Binary files /dev/null and b/visual-kpi-docs/static/img/icons/designer/viewwebsite28.png differ diff --git a/visual-kpi-docs/static/img/overview/designer-overview2.png b/visual-kpi-docs/static/img/overview/designer-overview2.png new file mode 100644 index 00000000..f8368f07 Binary files /dev/null and b/visual-kpi-docs/static/img/overview/designer-overview2.png differ diff --git a/visual-kpi-docs/static/img/site-settings/alertmembership-worksheet.png b/visual-kpi-docs/static/img/site-settings/alertmembership-worksheet.png new file mode 100644 index 00000000..60c18566 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/alertmembership-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/alerttemplate-worksheet.png b/visual-kpi-docs/static/img/site-settings/alerttemplate-worksheet.png new file mode 100644 index 00000000..0bff9aeb Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/alerttemplate-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/attributes-worksheet.png b/visual-kpi-docs/static/img/site-settings/attributes-worksheet.png new file mode 100644 index 00000000..1bb19ddb Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/attributes-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/attributesmembership-worksheet.png b/visual-kpi-docs/static/img/site-settings/attributesmembership-worksheet.png new file mode 100644 index 00000000..9ff74d9d Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/attributesmembership-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/authoring/profile-creation.gif b/visual-kpi-docs/static/img/site-settings/authoring/profile-creation.gif new file mode 100644 index 00000000..4571fee0 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/authoring/profile-creation.gif differ diff --git a/visual-kpi-docs/static/img/site-settings/authoring/site-settings.png b/visual-kpi-docs/static/img/site-settings/authoring/site-settings.png new file mode 100644 index 00000000..0141fa55 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/authoring/site-settings.png differ diff --git a/visual-kpi-docs/static/img/site-settings/chartscolors-worksheet.png b/visual-kpi-docs/static/img/site-settings/chartscolors-worksheet.png new file mode 100644 index 00000000..831a9fd3 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/chartscolors-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/contacts-worksheet.png b/visual-kpi-docs/static/img/site-settings/contacts-worksheet.png new file mode 100644 index 00000000..07cfb805 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/contacts-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/contacts-worksheet2.png b/visual-kpi-docs/static/img/site-settings/contacts-worksheet2.png new file mode 100644 index 00000000..70e1a9e2 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/contacts-worksheet2.png differ diff --git a/visual-kpi-docs/static/img/site-settings/dashboards-worksheet.png b/visual-kpi-docs/static/img/site-settings/dashboards-worksheet.png new file mode 100644 index 00000000..b046805d Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/dashboards-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/features-worksheet.png b/visual-kpi-docs/static/img/site-settings/features-worksheet.png new file mode 100644 index 00000000..406dfc0e Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/features-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/kpistatus-worksheet.png b/visual-kpi-docs/static/img/site-settings/kpistatus-worksheet.png new file mode 100644 index 00000000..4bb88b2e Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/kpistatus-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/kpistatuscolor-enduser.png b/visual-kpi-docs/static/img/site-settings/kpistatuscolor-enduser.png new file mode 100644 index 00000000..a135f470 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/kpistatuscolor-enduser.png differ diff --git a/visual-kpi-docs/static/img/site-settings/language-worksheet.png b/visual-kpi-docs/static/img/site-settings/language-worksheet.png new file mode 100644 index 00000000..3299f2d0 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/language-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/navlink-enduser.png b/visual-kpi-docs/static/img/site-settings/navlink-enduser.png new file mode 100644 index 00000000..25c44d64 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/navlink-enduser.png differ diff --git a/visual-kpi-docs/static/img/site-settings/navlink-worksheet.png b/visual-kpi-docs/static/img/site-settings/navlink-worksheet.png new file mode 100644 index 00000000..6d7d7077 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/navlink-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/options-menu-clean.png b/visual-kpi-docs/static/img/site-settings/options-menu-clean.png new file mode 100644 index 00000000..5b523e13 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/options-menu-clean.png differ diff --git a/visual-kpi-docs/static/img/site-settings/options-menu-small.png b/visual-kpi-docs/static/img/site-settings/options-menu-small.png new file mode 100644 index 00000000..1a1791f1 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/options-menu-small.png differ diff --git a/visual-kpi-docs/static/img/site-settings/options-menu2.png b/visual-kpi-docs/static/img/site-settings/options-menu2.png new file mode 100644 index 00000000..1c504111 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/options-menu2.png differ diff --git a/visual-kpi-docs/static/img/site-settings/profilegroups-worksheet.png b/visual-kpi-docs/static/img/site-settings/profilegroups-worksheet.png new file mode 100644 index 00000000..d8df40ea Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/profilegroups-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/profiles-worksheet.png b/visual-kpi-docs/static/img/site-settings/profiles-worksheet.png new file mode 100644 index 00000000..0985fe37 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/profiles-worksheet.png differ diff --git a/visual-kpi-docs/static/img/site-settings/website-worksheet.png b/visual-kpi-docs/static/img/site-settings/website-worksheet.png new file mode 100644 index 00000000..b7141381 Binary files /dev/null and b/visual-kpi-docs/static/img/site-settings/website-worksheet.png differ diff --git a/visual-kpi-docs/static/img/working-kpis/kpis-worksheet.png b/visual-kpi-docs/static/img/working-kpis/kpis-worksheet.png new file mode 100644 index 00000000..eb020df5 Binary files /dev/null and b/visual-kpi-docs/static/img/working-kpis/kpis-worksheet.png differ