diff --git a/visual-kpi-docs/docs/core-concepts/core-concepts.mdx b/visual-kpi-docs/docs/core-concepts/core-concepts.mdx index 9f4175f4..7cff8288 100644 --- a/visual-kpi-docs/docs/core-concepts/core-concepts.mdx +++ b/visual-kpi-docs/docs/core-concepts/core-concepts.mdx @@ -16,7 +16,7 @@ In this section, you can learn the essential ideas to become a pro at using Visu - **[Design and authoring](./core-concepts/design)**: This part of Visual KPI involves configuring key objects like Groups, KPIs, Charts, and Tables. Visual KPI Designer, an Excel-based tool, is versatile and suitable for tasks ranging from prototypes to large-scale systems. The KPI design process covers Basics, User Experience, SPC, Extended, and Access Group List sections. Administrators manage links for user accessibility, ensuring vital resources are easily reachable. -- **[Data Sources](./core-concepts/data-sources)**: In Visual KPI, "Data Sources" refer to the locations and origins of data that the system accesses and utilizes for various functions. Understanding data sources is crucial as it ensures the practicality and feasibility of requested interfaces. Moreover, a data source serves as the point from which the software collects and integrates data. This knowledge is essential for effectively integrating data into the Visual KPI system. +- **[Data Sources](./core-concepts/data-sources)**: In Visual KPI, "Data Sources" refers to the locations and origins of data that the system accesses and utilizes for various functions. Understanding data sources is crucial as it ensures the practicality and feasibility of requested interfaces. Moreover, a data source serves as the point from which the software collects and integrates data. This knowledge is essential for effectively integrating data into the Visual KPI system. - **[Interfaces](./core-concepts/interfaces)**: Interfaces in Visual KPI are how the software retrieves data from external systems. These interfaces are always read-only, meaning they can fetch data but not alter it. Users can ensure smooth data flow into the KPI system by selecting the right interface, enhancing functionality, and providing accurate information for informed decision-making. @@ -27,4 +27,4 @@ In this section, you can learn the essential ideas to become a pro at using Visu If you want to recap the basic concepts of the Visual KPI, you can read our topic [What's Visual KPI](./). -To continue your journey with Visual KPI documentation, we suggest you to access the core concepts subpages. +To continue your journey with Visual KPI documentation, we suggest you access the core concepts subpages. diff --git a/visual-kpi-docs/docs/core-concepts/hierarchy.mdx b/visual-kpi-docs/docs/core-concepts/hierarchy.mdx index 5f9beadd..f0f7cbc1 100644 --- a/visual-kpi-docs/docs/core-concepts/hierarchy.mdx +++ b/visual-kpi-docs/docs/core-concepts/hierarchy.mdx @@ -33,6 +33,13 @@ Regardless of quantity, groups in the hierarchy provide consolidated summaries o ## What's Next? -Users efficiently navigate the hierarchy, drilling into subgroups and accessing data objects. Hierarchy views display lists of groups, KPIs, and charts, depending on the data at that level. Objects can appear in multiple groups due to Visual KPI attribute-based structure. +Users efficiently navigate the hierarchy, drilling into subgroups and accessing data objects. Hierarchy views display lists of groups, KPIs, and charts, depending on the data at that level. Objects can appear in multiple groups due to the Visual KPI attribute-based structure. + +For more details on using the hierarchy and understanding its structure, you can access the End User guide. + +:::training Training + +Module six of [Visual KPI training](https://www.transpara.com/lesson/groups-hierarchy-end-user/) training addresses the hierarchy content in depth. + +::: -For more details on using the hierarchy and understanding its structure, you can access the End User guide or watch the module sixth of the [Visual KPI training](https://www.transpara.com/lesson/groups-hierarchy-end-user/). diff --git a/visual-kpi-docs/docs/core-concepts/kpi.mdx b/visual-kpi-docs/docs/core-concepts/kpi.mdx index 8ab6f7f5..3e14c04e 100644 --- a/visual-kpi-docs/docs/core-concepts/kpi.mdx +++ b/visual-kpi-docs/docs/core-concepts/kpi.mdx @@ -29,7 +29,7 @@ These indicators serve as a core element of the user experience, providing visua /> ## What's next? -For a more comprehensive understanding of how to utilize KPIs, you can access the [End User](../end-user/overview.mdx) section. +You can access the [End User](/docs/end-user/overview) section for a more comprehensive understanding of how to utilize KPIs. :::training Visual KPI End-User Training diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/alerts.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/alerts.mdx index 6e594e71..46d78257 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/alerts.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/alerts.mdx @@ -29,12 +29,19 @@ Visual KPI Alerts are based on the status of the KPI and are configurable in man alt="Alert trend" /> -:::notified +:::info The admin must configure the alerts ::: -## What's Next? +## What's next? + +Learn how to [change between themes](/docs/end-user/basic-navigation/dark-light-theme) in Visual KPI. + +:::training + +If you have KPIs that need to be watched closely, go deeper watching the Alerts & Advanced lesson in our [End User Visual KPI](https://www.transpara.com/lesson/search-end-user/) training. + +::: -If you have KPIs that need to be watched closely, go deeper watching the Alerts & Advanced lesson in our [End User Visual KPI](https://www.transpara.com/lesson/search-end-user/) training. \ No newline at end of file diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/analytics.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/analytics.mdx index 176b840b..bb333a40 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/analytics.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/analytics.mdx @@ -8,7 +8,7 @@ tags: ['basic-navigation', 'quick-start', 'end-user', 'analytics'] import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; -Visual KPI provide different types of analytics you can configure and use to understand KPI patterns. In addition, on this page you find how you can pivot your data from different angles to get a complete view of how your operations are running. +Visual KPI provides different types of analytics you can configure and use to understand KPI patterns. In addition, on this page you find how you can pivot your data from different angles to get a complete view of how your operations are running. ## Ad Hoc Trend View diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/basic-navigation.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/basic-navigation.mdx index d8bf38d3..273b6ca8 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/basic-navigation.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/basic-navigation.mdx @@ -8,29 +8,29 @@ tags: ['basic-navigation', 'quick-start', 'end-user'] import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; -Visual KPI provides several ways to you access information. In this section you find information on how to use these features. Use this page to learn the basics and explores the pages you need. +Visual KPI provides several ways to access information. In this section, you find information on how to use these features. Use this page to learn the basics and explore the pages you need. ## Basic navigation features Discover the key features that empower your navigation in Visual KPI, allowing you to seamlessly access and manage information. -### [Profiles](./profiles) +### [Profiles](/docs/end-user/basic-navigation/profiles) -A profile consists of custom dashboards, bookmark bar, and watch list of important KPIs. You can create as many profiles as you need, customize them as you want, and switch between them anytime. Depending on how your team configure Visual KPI, you may have Private and Public profiles available. +A profile consists of custom dashboards, bookmark bar, and a watch list of important KPIs. You can create as many profiles as you need, customize them as you want, and switch between them anytime. Depending on how your team configures Visual KPI, you may have Private and Public profiles available. -### [Dashboards](./dashboards) +### [Dashboards](/docs/end-user/basic-navigation/dashboards) Visual KPI Dashboards belong to profiles, and you can monitor all your operational information from them. You can have as many dashboards as you need. You can personalize them and add new visualizations to fit your purposes. The dashboard can be your personalized or role-based visualization of KPIs, charts, groups, and tables. -### [Hierarchy/Groups](./groups) +### [Hierarchy/Groups](/docs/end-user/basic-navigation/groups) -Hierarchy or Groups define how you organize the information from your process within Visual KPI. It works as folders on your computer, so you can have as many groups as you need, with unlimited levels. Moreover, groups can contain several objects at any level of the hierarchy, including KPIs, charts, tables, or even other groups. Organizing your KPIs and other objects into groups helps you understand your problems and reflect your process organization. +Hierarchy or Groups define how you organize the information from your process within Visual KPI. It works as folders on your computer, so you can have as many groups as you need, with unlimited levels. Moreover, groups can contain several objects at any level of the hierarchy, including KPIs, charts, tables, or even other groups. Organizing your KPIs and other objects into groups helps you understand your problems and reflect on your process organization. -### [Visualizations](./visualization) +### [Visualizations](/docs/end-user/basic-navigation/visualization) -Visual KPI provides several visualization option you can use. Here is a list of the main automatic visualization options available in Visual KPI: +Visual KPI provides several visualization options you can use. Here is a list of the main automatic visualization options available in Visual KPI: 1. **Group roll up**: In the **Groups** tab, you see the first group as All Groups, which summarizes all the KPIs from all groups in your Visual KPI. Click in one of the parent groups below to show the ones composing this parent. You can click in one of these child groups to see the KPIs that compose them. @@ -48,23 +48,23 @@ Visual KPI provides several visualization option you can use. Here is a list of alt="Quickstart tools" /> -### [Search](./search) +### [Search](/docs/end-user/basic-navigation/search) Visual KPI embeds a large volume of information, and during its use, you may need to find specific information for any reason. You can use the Search Bar to get live results from all dashboards, groups, KPIs, charts, and tables that meet your search input. This feature shows you the top five search results within each object type, and you can click an object type to see all results that include the parameter you entered. The search results also present the KPI status to provide a quick status understanding. -### [Analytics](./analytics) +### [Analytics](/docs/end-user/basic-navigation/analytics) Analytics, or Ad Hoc Trends, are a custom type of trend you can build in your Visual KPI, add to your dashboard, and monitor in real-time. For instance, if you are having trouble with multiple KPIs, you can trend them against each other to analyze if there is any correlation between them. You can create an Ad Hoc Trend from any KPI List View, using up to 20 KPIs (also called "pens"), and change the period for your analysis. -### [Alerts](./alerts) +### [Alerts](/docs/end-user/basic-navigation/alerts) Visual KPI sends alert notifications or reminders to contact emails when any KPIs need attention. You can prevent false alerts when you have a piece of equipment that's OFF by setting its status as **Not in Service**. Moreover, every notification includes a link back to Visual KPI that takes you to a KPI live trend of the exact moment the alert occurred. -### [Dark/Light Themes](./dark-light-theme) +### [Dark/Light Themes](/docs/end-user/basic-navigation/dark-light-theme) Transpara team knows that some folks prefer to work in the dark. Those folks change the Visual KPI background interface. You can configure light & dark themes, set defaults, and decide whether users can change defaults. Furthermore, you can customize how the status of your KPIs appears in light and dark themes, selecting colors for each theme and each status. -### [Time](./time) +### [Time](/docs/end-user/basic-navigation/time) Visual KPI shows your data in near real-time. The timestamp in the top bar of Visual KPI sites displays when data was last updated. You can choose to display the timestamp based on the server or client time, even if the server and Visual KPI client are in different time zones. @@ -74,4 +74,4 @@ Even though the information may come from several data sources, you control the ## What's next? -Explore more details of the basic navigation accessing the [Profiles](./profiles) and learn more about the Profiles feature for Visual KPI. \ No newline at end of file +Explore more details of the basic navigation, access [Profiles](./profiles), and learn more about the Profiles feature for Visual KPI. \ No newline at end of file diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/dark-Light-theme.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/dark-Light-theme.mdx index c455cc80..83ad2ec5 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/dark-Light-theme.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/dark-Light-theme.mdx @@ -9,9 +9,7 @@ tags: ['basic-navigation', 'quick-start', 'end-user', 'dark-light-theme', 'backg import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; import SvgFont from '@site/src/components/SvgFont/SvgFont'; -In this section you will learn how to choose between dark and light themes in your Visual KPI site. - -By default, Visual KPI sites have a white background; this 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. Your admin can fully customize how the status of your KPIs appear in light and dark themes, selecting colors for each theme and each status. +By default, Visual KPI sites have a white background; this 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. Your admin can fully customize how the status of your KPIs appears in light and dark themes, selecting colors for each theme and each status. ) pull-down menu to see the existing dashboards associated with the profile you are currently using. You also have the option to create new ones using the **New Dashboard** option from the menu. @@ -22,11 +22,11 @@ To change between different dashboards, use the **Dashboard** (). +1. Click on the **Dashboard** icon (). 2. Select **New Dashboard**. 3. Type a dashboard name and description. 4. If you want to copy an existing dashboard, check the **Copy Existing Dashboard** option. @@ -67,7 +67,7 @@ In the dashboard, the Options menu () offers different ways If you are in the Groups, KPIs, Charts, or Tables tabs, you'll see the **Add to Dashboard** option by accessing the **Options** menu. Click in the **Add to Dashboard** option to add the selected object to the current Dashboard. -## Customize a dashboard +## Customize a Dashboard In addition to creating Dashboards based on existing models, you can arrange your Dashboard to suit your needs by: @@ -86,7 +86,7 @@ After customizing the dashboard, don't forget to click **Save** at the bottom of The option to resize and move KPIs and other objects enables you to place the KPIs you use often or need to see immediately at the top and make KPIs larger or smaller in size. -To resize or move KPIs in your dashboard, follow the steps describe below: +To resize or move KPIs in your dashboard, follow the steps described below: 1. Click in the **Options** menu (). 2. Select **Customize Dashboard** (). @@ -105,11 +105,11 @@ You can see a configuration example in the GIF below. alt="Edit the dashboard" /> -:::info KPIs and other Objects sizes +:::info KPIs and other Object sizes KPIs and other objects vary in size based on their type. -- Geo Maps and KPI lists must be at least 50 percent the width of your Dashboard (up to 100 percent width). +- Geo Maps and KPI lists must be at least 50 percent of the width of your Dashboard (up to 100 percent width). - Charts, trends, texts, or image widgets can be as small as 25 percent of the Dashboard width. - KPI dashboard widgets can range from 25 to 50 percent width. The same applies to height. - Some Dashboard objects can expand to 8 times (8x) the original height. @@ -123,7 +123,7 @@ Some Visual KPI objects have multiple possible visualizations and information th 1. Click in the **Options** menu (). 2. Select **Customize Dashboard** (). 3. Select the object block you want to change the visualization in the **Customize Your Dashboard** board. A green dashed border appears around the selected object and a new board will show up listing all available visualization options. -4. Check the visualization option you want to see in the dashboard for the selected object. Depending on the object type, different option will be available. The complete list is presented below: +4. Check the visualization option you want to see in the dashboard for the selected object. Depending on the object type, different options will be available. The complete list is presented below: - Sparkline - Bullet Chart - Status History Chart @@ -148,12 +148,12 @@ You can add any object to your dashboard. To add a new visualization: 1. Access the KPI, object, or any visualization you want to add to the dashboard. 2. Click in the **Options** menu (). -3. Select one of the three option available: - - **Add to *Dashboard*** (): The current dashboard name will be in the *Dashboard* place. This option add the current view directly to the dashboard you're currently using. +3. Select one of the three options available: + - **Add to *Dashboard*** (): The current dashboard name will be in the *Dashboard* place. This option adds the current view directly to the dashboard you're currently using. - **Add to New Dashboard** (): This enables you to use the current visualization in a new dashboard that you will create. **Add to Existing Dashboard** (): Use this option to add the current visualization to another dashboard other than the one you are currently using. -The current object will be available in the selected dashboard. You can use the [resize and move objects](dashboards#resize-and-move-objects) position it in the desired place. +The current object will be available in the selected dashboard. You can use the [resize and move objects](dashboards#resize-and-move-objects) to position them in the desired place. ). +1. Click on the Time Range Picker (). 2. Select a default or custom Time Range. All data related to time will be displayed on your Dashboard based on the selected range. Use the time range paddles to advance or regress the time range. For example, if you selected a 24-hour time range, the advance paddle will show KPI data for the following 24-hour period. diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/groups.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/groups.mdx index 50932d5e..fab7c263 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/groups.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/groups.mdx @@ -72,19 +72,19 @@ Some icons you see in Groups are universal. Others only appear if turned on and/ ## Add groups to a dashboard -You can integrate Groups visualization in your Dashboard using Single Group Dashboard Widgets. These widgets feature a Roll-Up Bar, displaying KPIs from the main group and its subgroups. Each widget includes the group name, description, and group info (if configured). +You can integrate Group visualizations in your Dashboard using Single Group Dashboard Widgets. These widgets feature a Roll-Up Bar, displaying KPIs from the main group and its subgroups. Each widget includes the group name, description, and group info (if configured). -To include a new Group visualization into your dashboard, follow the steps below: +To include a new Group visualization in your dashboard, follow the steps below: 1. Access the desired group. 2. Click in the **Options** menu (). -3. Select the Dashboard () to add the group into. You can add it to the current Dashboard, a new one, or an existing one. +3. Select the Dashboard () to add the group. You can add it to the current Dashboard, a new one, or an existing one. ## What's next? -What's to know more about Groups visualization? Access the Visualization page to learn the basics of the different visualizations for your Groups and KPIs. \ No newline at end of file +What's to know more about Group visualization? Access the [Visualization](/docs/end-user/features/visualizations/overview) page to learn the basics of the different visualizations for your Groups and KPIs. \ No newline at end of file diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/profiles.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/profiles.mdx index 2773a6bf..85f884b1 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/profiles.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/profiles.mdx @@ -58,7 +58,7 @@ To access a profile from another group, you first need to change to the desired To create a new profile, you need to follow the steps below: -1. Click in the **Profile** icon () under your company logo and select **Change Profile**. +1. Click on the **Profile** icon () under your company logo and select **Change Profile**. 2. Check the option **or Create a new one**. 3. Select a **Profile Group** to use as the base for the profile you're creating. 4. Name and clearly describe the new profile and click **Save**. @@ -79,7 +79,7 @@ To switch to a different profile from your current profile group: If the profile that you are looking for isn't there or is from another group, follow the steps below: -1. Click in the **Profile** icon () under your company logo and select **Change Profile** (). +1. Click on the **Profile** icon () under your company logo and select **Change Profile** (). 2. Select the **Profile Group** in which the profile you're looking for is part. 3. Select the profile you want to use. diff --git a/visual-kpi-docs/docs/end-user/basic-navigation/search.mdx b/visual-kpi-docs/docs/end-user/basic-navigation/search.mdx index 57e1a599..69095eaf 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/search.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/search.mdx @@ -27,7 +27,7 @@ The search feature is live, meaning live results will be displayed below the sea ## Create Ad Hoc Groups -Ad Hoc are a trend type you can create by combining different KPIs. You can use the Search feature to find related KPIs and then create Ad Hoc based on the results. This way, you have a easy approach to visualize related content. +Ad Hoc is a trend type you can create by combining different KPIs. You can use the Search feature to find related KPIs and then create Ad Hoc based on the results. This way, you have an easy approach to visualizing related content. To create an Ad Hoc, follow the steps below: @@ -43,13 +43,21 @@ To create an Ad Hoc, follow the steps below: - Box Plot () - Table () -In addition to the options listed on step 5, you also have the option to add the selected KPIs to Dashboard () or add them to Watchlist (). +In addition to the options listed in step 5, you also have the option to add the selected KPIs to the Dashboard () or add them to the Watchlist (). -## What's Next? +:::training + +Learn more about the search engine by watching the Search lesson in our [End User Visual KPI](https://www.transpara.com/lesson/search-end-user/) training. + +::: + +## What's next? + +Check the available [Analytics](/docs/end-user/basic-navigation/analytics) Visual KPI provides. + -Learn more about the search engine by watching the Search lesson in our [End User Visual KPI](https://www.transpara.com/lesson/search-end-user/) training. \ No newline at end of file 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 230ceaa3..57ec4381 100644 --- a/visual-kpi-docs/docs/end-user/basic-navigation/time.mdx +++ b/visual-kpi-docs/docs/end-user/basic-navigation/time.mdx @@ -13,9 +13,10 @@ This section will present how end users can work with different time parameters ## Timestamp -Visual KPI shows your data in real time. 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. Your admin can set the default to Client Time or Server Time, and decide whether or not users can change the timestamp display setting in the client. +Visual KPI shows your data in real-time. By default, the timestamp display in Visual KPI sites is set to Client Time, the time indicated by the device on which you are accessing the Visual KPI client. Your admin can set the default to Client Time or Server Time, and decide whether or not users can change the timestamp display setting in the client. + +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. If you have admin permission, you can choose to display the timestamp based on the server or client time, even if the server and Visual KPI client are in different time zones. -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. If you have the admin permission, 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. ) -2. [**Only show descendant/child groups**](visualization#only-show-descendantchild-groups) ( / ) -3. [**Add Group to Dashboard**](visualization#add-groups-to-dashboard) () -4. [**View as List**](visualization#group-roll-upslist-view) () -5. [**View as KPI Map**](visualization#view-as-kpi-map) () -6. [**View as Group Map**](visualization#view-as-group-map) () -7. [**View as Group Map Table**](visualization#view-as-group-map-table) () -8. [**View as Geo Map**](visualization#view-as-geo-map) () +1. [**Filter**](/docs/end-user/basic-navigation/visualization/#filters) () +2. [**Only show descendant/child groups**](/docs/end-user/basic-navigation/visualization/#only-show-descendantchild-groups) ( / ) +3. **Add Group to Dashboard** () +4. [**View as List**](/docs/end-user/basic-navigation/visualization/#group-roll-upslist-view) () +5. [**View as KPI Map**](/docs/end-user/basic-navigation/visualization/#view-as-kpi-map) () +6. [**View as Group Map**](/docs/end-user/basic-navigation/visualization/#view-as-group-map) () +7. [**View as Group Map Table**](/docs/end-user/basic-navigation/visualization/#view-as-group-map-table) () +8. [**View as Geo Map**](/docs/end-user/basic-navigation/visualization/#view-as-geo-map) () ). +The Group Roll-Up is the list view, which is the default view in [Groups](/docs/end-user/basic-navigation/groups). You can always come back to this view by clicking the **List View** icon (). ) option to customize Groups, KPIs, Charts or Tables you are currently viewing based on selected parameters. You can select filters to show only those objects with a specified status. The filtering options may vary in Groups, KPIs, Charts, and Tables. It also depends on how the Visual KPI admin has configured the filter tool in your organization. Usually, you have two filter options available: -- [Status Filter ](visualization#status-filter) -- [Near Me Filter](visualization#near-me-filter) +- [Status Filter ](/docs/end-user/basic-navigation/visualization/#status-filter) +- [Near Me Filter](/docs/end-user/basic-navigation/visualization/#near-me-filter) -#### Status Filter +#### Status filter -Use the Status Filter to see KPIs with specific status. For example, you can use this option to see only KPIs with High High High status. To use this filter, follow the steps below. +Use the Status Filter to see KPIs with a specific status. For example, you can use this option to see only KPIs with High High High status. To use this filter, follow the steps below. 1. Select the **Filter** icon (). 2. Check the status you want to see. For this example, only the **High High High** status is selected. @@ -66,11 +66,11 @@ Use the Status Filter to see KPIs with specific status. For example, you can use alt="Menu options" /> -#### Near Me Filter +#### Near Me filter Visual KPI can show assets geographically located near you. To accomplish it, Visual KPI uses the GPS on your mobile device (or IP address on a non-GPS device, which is less accurate) to filter and sort information based on your current location. This is useful if you want to show only assets within a specific radius of where you are. -If your admin has turned on this feature in the Visual KPI Designer, you can access it via the Filters icon (). The Near Me filter can work with Groups, KPIs, Charts, or Tables. In addition, if the feature is enabled by the admin, you can filter, sort objects by distance, and view assets on a map. To use the Near Me Filter, follow the steps below: +If your admin has turned on this feature in the Visual KPI Designer, you can access it via the Filters icon (). The Near Me filter can work with Groups, KPIs, Charts, or Tables. In addition, if the admin enables the feature, you can filter and sort objects by distance and view assets on a map. To use the Near Me Filter, follow the steps below: 1. Select the **Filter** icon (). 2. Check the **Near Me Filter** checkbox. @@ -88,11 +88,11 @@ To use the Near Me Filter, you must permit Visual KPI to access your location. I ::: -### Only Show Descendant/Child Groups +### Only show descendant/child groups With this option, you can show all child items of the group you are currently viewing or collapse the list to go to the top level of the current list. When you use the **Show all Descendant Groups** (), all subgroups will show up. On the other hand, when you use the **Only Show Child Groups** (), only direct subgroups from the current Hierarchy level will be displayed. -On the example below, the **Only Show Child Groups** () option is active. Thus only the groups at the top of the Hierarchy are available and the **Management** is one of them. When the **Show all Descendant Groups** () is selected, the sub groups show up. You can check the level of the subgroup by the number of **-** before the name the group has. Thus, you can verify that the **Management** group is composed by four other subgroups (Economic, Environmental, Operation, and Social). +in the example below, the **Only Show Child Groups** () option is active. Thus, only the groups at the top of the Hierarchy are available and the **Management** is one of them. When the **Show all Descendant Groups** () is selected, subgroups show up. You can check the level of the subgroup by the number of **-** before the name the group has. Thus, you can verify that the **Management** group is composed of four other subgroups (Economic, Environmental, Operation, and Social). ) view is similar to the [View as KPI Map](visualization#view-as-kpi-map) but is more advanced and gives each Group its status. Based on a configurable time limit, they show the KPIs within a group and highlight the worst-performing and recently changed KPIs. In the Visual KPI Group Map, you can quickly see if any KPIs are in alert condition. +The Group Map () view is similar to the [View as KPI Map](/docs/end-user/basic-navigation/visualization/#view-as-kpi-map) but is more advanced and gives each Group its status. Based on a configurable time limit, they show the KPIs within a group and highlight the worst-performing and recently changed KPIs. In the Visual KPI Group Map, you can quickly see if any KPIs are in alert condition. The bar across the top of each Group in the Group Map indicates the Group's status as determined by the Group Map settings. You'll see either the most recently changed KPI in the Group, the worst performing KPI in the Group, or any custom status set by your Visual KPI Designer admin. This way, you can quickly see if a group needs attention based on what's happening with critical KPIs or if all of the KPIs in the Group are on target. @@ -135,9 +135,9 @@ Group Maps may or may not show up, depending on if your admin has configured the ::: -### View as Group Map Table +### View as Group Map table -The Group Map Table () view is similar to the [Group Map](visualization#view-as-group-map) view, in a different layout. It shows groups as titles in a table. As happens when using the [Group Map](visualization#view-as-group-map), you can select and click on any KPI in the Group Map Table to display details and other KPI options. +The Group Map Table () view is similar to the [Group Map](/docs/end-user/basic-navigation/visualization/#view-as-group-map) view but has a different layout. It shows groups as titles in a table. As happens when using the [Group Map](/docs/end-user/basic-navigation/visualization/#view-as-group-map), you can select and click on any KPI in the Group Map Table to display details and other KPI options. ) view is similar to the [Group Map](vi The Geo Map () option combines the latitude and longitude of your assets and Google Maps to create an interactive visualization right inside the Visual KPI. When you select the Geo Map, you can use the Google Maps interactive functionalities to zoom, pivot, or rotate, for example. -In addition to the default Google Maps tools, you can click a set of values on the map to see details. If you are viewing a Geo Map based on groups, you may see a pie chart that sums up everything in that group. Clicking on the pie chart opens details for any groups displayed. You can even use your GPS location or IP address to [filter](visualization#near-me-filter) data based on its physical distance from you. +In addition to the default Google Maps tools, you can click a set of values on the map to see details. If you are viewing a Geo Map based on groups, you may see a pie chart that sums up everything in that group. Clicking on the pie chart opens details for any groups displayed. You can even use your GPS location or IP address to [filter](/docs/end-user/basic-navigation/visualization/#near-me-filter) data based on its physical distance from you. ## What's next? -To continue covering the core concepts for End-Users, access the [Real Time](real-time) page to learn more about the near real-time data processing of Transpara's Visual KPI. \ No newline at end of file +To continue covering the core concepts for End-Users, access the [Real-Time](real-time) page to learn more about the near real-time data processing of Transpara's Visual KPI. \ No newline at end of file diff --git a/visual-kpi-docs/docs/end-user/features/dashboards.mdx b/visual-kpi-docs/docs/end-user/features/dashboards.mdx index 929cba8f..a1a6de3a 100644 --- a/visual-kpi-docs/docs/end-user/features/dashboards.mdx +++ b/visual-kpi-docs/docs/end-user/features/dashboards.mdx @@ -9,9 +9,9 @@ tags: ['features', 'quick-start', 'end-user', 'advanced', 'dashboard'] import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; import SvgFont from '@site/src/components/SvgFont/SvgFont'; -From the Visual KPI Dashboard, you can monitor all of your information, personalize the Dashboard, and add new visualizations. You can have as many Dashboards as you want, and they're part of profiles. The Dashboard is your personalized or role-based visualization of KPIs and other object types (charts, groups, tables, embedded content, etc.). +From the Visual KPI Dashboard, you can monitor all of your information, personalize the Dashboard, and add new visualizations. You can have as many Dashboards as you want. They're part of profiles. The Dashboard is your personalized or role-based visualization of KPIs and other object types (charts, groups, tables, embedded content, etc.). -The previous [Dashboard](/docs/end-user/basic-navigation/dashboards) page addressed the main dashboard functionalities, such as the options menu, how to create a dashboard, set properties, resize and move a KPI, select a KPI visualization, add a new object and add a custom time range. This section will go deeper into the dashboard features and explore other ways to take advantage of this crucial tool. +The previous [Dashboard](/docs/end-user/basic-navigation/dashboards) page addressed the main dashboard functionalities, such as the options menu, creating a dashboard, setting properties, resizing and moving a KPI, selecting a KPI visualization, adding a new object, and adding a custom time range. This section will investigate the dashboard features and explore other ways to take advantage of this crucial tool. ## Dashboard properties @@ -31,17 +31,17 @@ Once you click the Gear icon () and select Customize Dashbo ### Add a link widget -You can add and customize just about anything to your dashboard, even elements that don't live in Visual KPI. Websites you reference often, links to Web-based software you need for your job, or Visual KPI dashboards that you monitor frequently. These dashboard elements are called link widgets. If it has a URL, you can link it. +You can add and customize just about anything to your dashboard, even elements that don't live in Visual KPI. Websites you often reference, links to Web-based software you need for your job, or Visual KPI dashboards you monitor frequently. These dashboard elements are called link widgets. If it has a URL, you can link it. Some elements you can add as a link widget: -- Another dashboard within your profile -- Another dashboard from another profile to which you have access -- A link to Web-based software you may use for admin purposes -- A link to another website you monitor frequently -- A link to a YouTube video +- Another dashboard within your profile. +- Another dashboard from another profile to which you have access. +- A link to Web-based software you may use for admin purposes. +- A link to another website you monitor frequently. +- A link to a YouTube video. -#### Add dashboard link widget +#### Add a dashboard link widget Once you click **Add Dashboard Link Widget**, select the dashboard link that you want to add to your dashboard through the dropdown menu. You can choose it from any profile that you have access to. Then, inform your preferences for alignment, text size, color, and icon. Finally, click Add to immediately add it to your dashboard. You can move and resize this widget in this same menu. Don't forget to **Save** your changes. @@ -50,11 +50,11 @@ Once you click **Add Dashboard Link Widget**, select the dashboard link that you alt="Dashboard Link Widget" /> -#### Add custom link widget +#### Add a custom link widget The Custom Link Widget, or Generic Link, adds a widget on the dashboard to just about anything you can link to with a URL. You can use links to objects inside Visual KPI, such as trends or KPIs, but it's easier to add these to the dashboard with the Add to Dashboard command within Options. -In the Dashboard Properties panel, click **Add Custom Link Widget**. Customize your new link widget by adding a name and an external link for the widget, choose a widget color and icon, and click **Add**. After adjusting its position and size, click **Save**. +In the Dashboard Properties panel, click **Add Custom Link Widget**. Customize your new link widget by adding a name and an external link for the widget, choosing a widget color and icon, and clicking **Add**. After adjusting its position and size, click **Save**. -#### Add collection chart widget +#### Add a collection chart widget ). -- Select multiple KPIs by clicking the box to the left of any KPI in the list. -- From the sub-menu, select the Dashboard () or Watchlist () icons to save the selected objects. +1.Navigate to the relevant group and list view. +2. From the KPI list view, click the **Select KPI** icon (). +3. Select multiple KPIs by clicking the box to the left of any KPI in the list. +4. From the sub-menu, select the **Dashboard** () or **Watchlist** () icons to save the selected objects. Observe the example below, which shows multiple KPIs selected in the Exton Group and both (1) Dashboard and (2) Watchlist icons. @@ -128,7 +128,7 @@ Observe the example below, which shows multiple KPIs selected in the Exton Group #### Watchlist -Think of your Visual KPI Watchlist as those KPIs that could get your promoted or fired. Your Watchlist appears in the top bar of your Visual KPI site as a orange-colored number with an eye icon () next to it. This number shows how many KPIs are currently in alert status. +Think of your Visual KPI Watchlist as those KPIs that could get you promoted or fired. Your Watchlist appears in the top bar of your Visual KPI site as an orange-colored number with an eye icon () next to it. This number shows how many KPIs are currently in alert status. To add a KPI to your Visual KPI Watchlist, follow the steps: diff --git a/visual-kpi-docs/docs/end-user/features/features.mdx b/visual-kpi-docs/docs/end-user/features/features.mdx index f3cd6c4a..a69af6d9 100644 --- a/visual-kpi-docs/docs/end-user/features/features.mdx +++ b/visual-kpi-docs/docs/end-user/features/features.mdx @@ -17,4 +17,4 @@ Visual KPI lets you compare many types of data, even across multiple sources, wi ## What's next? -Start learning the best of Visual KPI by accessing our [Profiles](/docs/end-user/features/profiles) page. \ No newline at end of file +Start learning more about the features available in Visual KPI by accessing the [Profiles](/docs/end-user/features/profiles) page. \ No newline at end of file diff --git a/visual-kpi-docs/docs/end-user/features/groups.mdx b/visual-kpi-docs/docs/end-user/features/groups.mdx index 29036201..012d4f48 100644 --- a/visual-kpi-docs/docs/end-user/features/groups.mdx +++ b/visual-kpi-docs/docs/end-user/features/groups.mdx @@ -9,13 +9,13 @@ tags: ['features', 'quick-start', 'end-user', 'advanced', 'hierarchy', 'groups'] import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; import SvgFont from '@site/src/components/SvgFont/SvgFont'; -The basic navigation [Groups](/docs/end-user/basic-navigation/groups) page addressed how Groups work just like folders on your PC, and you can have as many groups as you want, unlimited levels of groups containing multiple objects at any level of the hierarchy. Moreover, on that page, are listed functions such as Drilling Down Through Groups, Breadcrumbs, and some visualization views. +The basic navigation [Groups](/docs/end-user/basic-navigation/groups) page addressed how Groups work, just like folders on your PC, and you can have as many groups as you want, with unlimited levels of groups containing multiple objects at any level of the hierarchy. Moreover, on that page are listed functions such as Drilling Down Through Groups, Breadcrumbs, and some visualization views. -Now we will go deeper into the different types of objects that you can find in Groups. We will also explore more visualization options for your Groups to help you understand your data, leading to better decisions. +Now, we will go deeper into the different types of objects that you can find in Groups. We will also explore more visualization options for your Groups to help you understand your data, leading to better decisions. ## KPIs -The KPI tab on the Visual KPI main menu shows all KPIs at the level you are currently viewing. The default view for the KPI tab is the List View, which shows the KPI name, status, sparkline, actual and target values, a bullet chart, and details. KPIs in this view can be filtered and grouped by status or attribute. All group views have analytics built right in. +The KPI tab on the Visual KPI main menu shows all KPIs at the level you are currently viewing. The default view for the KPI tab is the List View, which shows the KPI name, status, sparkline, actual and target values, a bullet chart, and details. In this view, KPIs can be filtered and grouped by status or attribute. All group views have analytics built right in. Learn more about the other view options on our [KPI Visualization](/docs/end-user/features/visualizations/kpi) page. @@ -27,7 +27,7 @@ The Charts tab on the Visual KPI navigation bar displays any charts that are ava :::note Viewing Charts -Not all Groups have charts. If there are no charts in the group (or its child groups) you are viewing, the Charts tab will disappear. If the Charts tab is grayed out, there are charts in child groups and you can click to see them. +Not all Groups have charts. The Charts tab will disappear if there are no charts in the group (or its child groups) you are viewing. If the Charts tab is grayed out, there are charts in child groups, and you can click to see them. ::: @@ -37,7 +37,7 @@ The Chart List View shows you the chart name, the type of chart, a mini visualiz The quickest way to see all charts available on your Visual KPI website is to click the Home icon (). This will take you to the top-level group. If there are any charts at the Home level, you can click the **Charts** tab to see them. To drill down further and see charts for all descendant groups, click **Show Charts for this Group and All Child Groups** (). -At the Charts tab, you can use a menu that allows you to interact with the chart or change the parameters. Use your mouse to scroll over the chart and see values or other information associated with the chart. +At the Charts tab, you can use a menu to interact with the chart or change the parameters. Use your mouse to scroll over the chart and see values or other information associated with the chart. :::note Menu Changes @@ -52,24 +52,25 @@ The menu will change depending on the type of chart you are viewing. ## Tables -Any table that lives in an SQL-based data source (SQL Server, Oracle, MySQL, Excel, Access, and more) can be converted in a Visual KPI's Tables feature. Your admin must set up tables in Visual KPI Designer. +Any table that lives in an SQL-based data source (SQL Server, Oracle, MySQL, Excel, Access, and more) can be converted in a Visual KPI's Tables feature. Your admin must set up tables into Visual KPI Designer. -Similarly to Charts, the Tables tab on Visual KPI's main navigation menu displays any tables available in the group you are currently viewing and it won't appear if there are no tables in the group or its child groups. +Similar to Charts, the Tables tab on Visual KPI's main navigation menu displays any tables available in the group you are currently viewing, and it won't appear if there are no tables in the group or its child groups. ### Tables view You can configure multiple tables from the same data and add color and icons to your tables to highlight status based on the parameters you set. Therefore, you can be free to create maintenance logs, shift reports, and error lists, or use any other tabular data you have access to. Click **Tables** in the navigation bar and expand this list to see tables for all child groups available to you. To open any table in the list, click on its name in the list. -If you are in the Tables list view (), click the **More** icon () in any table to open a drop-down panel that shows some basic information about the table. Whereas the View Full Table Details icon () opens the System Configuration Details screen. This gives you detailed information about the configuration of the table set up by your admin in the Visual KPI Designer. +If you are in the Tables list view (), click the **More** icon () in any table to open a drop-down panel that shows some basic information about the table. Whereas the View Full Table Details icon () opens the System Configuration Details screen. This gives you detailed information about the table configuration set up by your admin in the Visual KPI Designer. -Visual KPI Tables features: -1. Visualize any tabular or rectangular data. -2. Visualize time-series or non-time-series data. -3. Tables support time ranges/filtering and can be scrolled forward or back in time. -4. Tables can be query-based. -5. Tables can be searched, and so can individual columns. -6. Tables support HTML content. +In summary, the Visual KPI Tables provides the following features: + +- Visualize any tabular or rectangular data. +- Visualize time-series or non-time-series data. +- Tables support time ranges/filtering and can be scrolled forward or back in time. +- Tables can be query-based. +- Tables can be searched, and so can individual columns. +- Tables support HTML content. ) allows you to search dynamical ## What's next? -If you want to become a Visual KPI pro user, go to our [Visualization](/docs/end-user/features/visualizations/overview) page to learn the best view features for your analysis and KPI monitoring. \ No newline at end of file +To become a Visual KPI pro user, go to our [Visualization](/docs/end-user/features/visualizations/overview) page to learn the best view features for your analysis and KPI monitoring. \ No newline at end of file diff --git a/visual-kpi-docs/docs/end-user/features/profiles.mdx b/visual-kpi-docs/docs/end-user/features/profiles.mdx index 3c83e55f..660ebbea 100644 --- a/visual-kpi-docs/docs/end-user/features/profiles.mdx +++ b/visual-kpi-docs/docs/end-user/features/profiles.mdx @@ -9,13 +9,12 @@ tags: ['features', 'quick-start', 'end-user', 'advanced', 'profile'] import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; import SvgFont from '@site/src/components/SvgFont/SvgFont'; -Profiles are where your Dashboards live and all the personalized layer of visual KPI is for an end user. A profile is a collection of important things that are personalized for a user, but it doesn't need to be a person, it could be a role, a site, a room, an asset, or anything else you might want. - -A profile can be grouped into profile groups, like only for executives, maintenance, a plant, or anything else. Additionally, the administrator can lock down entire profiles or individually lock down dashboards. Therefore, in a locked profile or dashboard, if you try to use the gear you're going to see that there are limited options, such as Customize Dashboard. The profile contains three different things: +Profiles are where your Dashboards live and all the personalized layer of visual KPI is for an end user. A profile is a collection of important personalized things for a user, but it doesn't need to be a person. A profile can be related to a role, a site, a room, an asset, or anything else you might want. +A profile can be grouped into profile groups, like only for executives, maintenance, a plant, or anything else. Additionally, the administrator can lock down entire profiles or individually lock down dashboards. Therefore, in a locked profile or dashboard, if you try to use the gear, you're going to see that there are limited options, such as Customize Dashboard. The profile contains three different things: 1. **Dashboards**: You can create and personalize as many dashboards as you want for each profile, so you can easily toggle back and forth between them. You can also copy dashboards from other profiles and lock them to block editing of any format from other users. -2. **Bookmark bar**: If you change profiles then you're going to change to a different bookmark bar but if you only change dashboards you'll stay within the same profile, so your bookmark bar stays the same. -3. **Watchlist**: The Watchlist gives you a set of customizable favorites list of KPIs. You can add as many to it as you want and the orange number beside the timestamp tells you how many KPIs on your Watchlist are in an alert condition. By default, you see them sorted by 'in alert' and 'not alert'. You can you multiple [KPI Visualizations](/docs/end-user/features/visualizations/kpi) with the top bar icons and sort the list by using the arrows beside the column title. +2. **Bookmark bar**: If you change profiles, then you're going to change to a different bookmark bar, but if you only change dashboards, you'll stay within the same profile, so your bookmark bar stays the same. +3. **Watchlist**: The Watchlist gives you a set of customizable favorites list of KPIs. You can add as many to it as you want, and the orange number beside the timestamp tells you how many KPIs on your Watchlist are in an alert condition. By default, you see them sorted by 'in alert' and 'not alert'. You can use multiple [KPI Visualizations](/docs/end-user/features/visualizations/kpi) with the top bar icons and sort the list by using the arrows beside the column title. ) and **Edit Bookmarks** icon () to edit your favorite list. You can configure it in a few different ways: -- Relocate by drag and dropping -- Change name and description -- Delete -- Choose a different icon -- Add new bookmarks, such as any Visual KPI object from any profile or an external link +- Relocate by dragging and dropping. +- Change name and description. +- Delete. +- Choose a different icon. +- Add new bookmarks, such as any Visual KPI object from any profile or an external link. The example below shows the bookmark options and how to add a new one. @@ -92,9 +91,9 @@ Follow the steps below to change to a different Profile: ## What's next? -To continue your journey with Visual KPI advanced features for end-users, we suggest reading our [Dashboards](/docs/end-user/features/dashboards) page. +To continue your journey with Visual KPI advanced features for end-users, read the [Dashboards](/docs/end-user/features/dashboards) page. -:::training Enroll in our Profiles training +:::training Enroll in our Profile training If you want to go deeper into the Profiles, you can enroll in our [Visual KPI Training](https://www.transpara.com/course/visual-kpi-end-user/) and watch the [Profiles](https://www.transpara.com/lesson/profiles-end-user/) class. diff --git a/visual-kpi-docs/docs/end-user/features/visualizations/charts.mdx b/visual-kpi-docs/docs/end-user/features/visualizations/charts.mdx index b2fb14d4..f094e8e7 100644 --- a/visual-kpi-docs/docs/end-user/features/visualizations/charts.mdx +++ b/visual-kpi-docs/docs/end-user/features/visualizations/charts.mdx @@ -23,16 +23,16 @@ Charts show data as it relates to its defined limits. Visual KPI uses many chart ### Bar charts -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 bar, but the related sets are clustered and compared against other clustered data. +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 data sets so that each specific set has its bar. Still, the related sets are clustered and compared against other clustered data. Depending on the configuration by your admin, Bar Charts can be: -1. Time-series or non-time-series data. -2. Manually or query-based configured. -3. Stacked and clustered. -4. Horizontal or vertical. -5. Custom colored. -6. Color changing above and below the target. +- Time-series or non-time-series data. +- Manually or query-based configured. +- Stacked and clustered. +- Horizontal or vertical. +- Custom colored. +- Color changing above and below the target. ) can help you quickly see which of your assets are most critical and know where you need to focus. A Pareto chart is a type of chart that contains both bars and a line graph, where individual values are represented in descending order by bars, and the cumulative total is represented by the line. +Pareto Charts () can help you quickly see which of your assets are most critical and know where you need to focus. A Pareto chart contains both bars and a line graph, where individual values are represented in descending order by bars, and the line represents the cumulative total. -Pareto Charts show assets and values in the bars and use a line to show cumulative effect. They can be used to monitor quality control, showing where most of the problems are coming from. +Pareto Charts show assets and values in the bars and use a line to show cumulative effect. They can be used to monitor quality control, showing where most problems come from. -You can even show relative data using stacked Pareto charts. Each bar can show multiple values with each displaying a different color, and as you move your cursor over each bar you'll see the actual values as tooltips. +You can even show relative data using stacked Pareto charts. Each bar can show multiple values, each displaying a different color, and as you move your cursor over each bar, you'll see the actual values as tooltips. ) display a simple graphic that shows the relative proportions of your compared assets. However, Pie Charts has some disadvantages for Visual KPI, such as its size for screen presentation and the limited ability to compare peer data. +Pie Charts () display a simple graphic that shows the relative proportions of your compared assets. However, Pie Charts have some disadvantages for Visual KPI, such as their size for screen presentation and the limited ability to compare peer data. Depending on how they're configured by your admin, Pie Charts can be: -1. Manually and query-based configured. -2. Mouse over dynamic. +- Manually and query-based configured. +- Mouse over dynamic. ), also known as Dial or Speedometer, are a me Gauge charts are ideal for showing: -1. Actual status related to targets. -2. Progress toward a goal. -3. Percentage measurement. +- Actual status related to targets. +- Progress toward a goal. +- Percentage measurement. -If configured by your administrator, you can visualize any trend as a Gauge chart. Simply click the gauge icon on any KPI trend view. +If configured by your admin, you can visualize any trend as a Gauge chart. Simply click the gauge icon on any KPI trend view. ), or Scatter Charts as they're sometimes called, show the relationships between two sets of data. They're great for showing correlations between one or many variables or calculations. +XY Plots (), or Scatter Charts as they're sometimes called, show the relationships between two data sets. They're great for showing correlations between one or many variables or calculations. Based on how your admin configures XY Plots or Scatter Charts, they may be: -1. Time-series or non-time-series. -2. Manually or query-based configured . +- Time-series or non-time-series. +- Manually or query-based configured. ): Filter by status or distance from where you are standing. +1. **[Filter](/docs/end-user/basic-navigation/visualization/#filters)** (): Filter by status or distance from where you are standing. 2. **Grouping** (): Allows you to group your KPIs by Standard or Custom Attributes such as Status, Group, or any other that makes sense for your organization. Your admin can configure Custom Attributes. -3. **[Only Show Descendant/Child Groups](/docs/end-user/basic-navigation/visualization)** (/): Show all child items of the group you are currently viewing or collapse the list to go to the top level of the current list. +3. **[Only Show Descendant/Child Groups](/docs/end-user/basic-navigation/visualization/#only-show-descendantchild-groups)** (/): Show all child items of the group you are currently viewing or collapse the list to go to the top level of the current list. 4. **Time Ranges** (): Configure a Time Range for all your KPIs. Especially useful when using Trend View to compare values. 5. **Revert** (): Return to the default KPI view. 6. **Select KPIs** (): Select multiple KPIs by clicking the box to the left of any KPI in the list. -7. **[View as List](/docs/end-user/basic-navigation/visualization)** (): This is the default view in the Group view, but you can see your data in other visualizations. +7. **[View as List](/docs/end-user/basic-navigation/visualization/#group-roll-upslist-view)** (): This is the default view in the Group view, but you can see your data in other visualizations. 8. **View as Bullet Chart** (): It's similar to the KPI List View and Status History view, but the KPI Bullet Chart view focuses on the current status of the KPI relative to targets and limits. 9. **View as Trend List** (): Present the KPIs as trends, so you can quickly compare the KPIs values from your Group. 10. **View as Status History Chart** (): Projects vertical color bars to show Highs and Lows or other targets based on status color. 11. **View as Status History Map**: Similar to Status History Chart, but you can see a status history chart in the trend view. Click the Status Background icon to activate the background. -12. **[View as KPI Map](/docs/end-user/basic-navigation/visualization)** (): KPI maps, if configured by your admin, show a graphical heat map of all the KPIs in the level you are currently viewing. -13. **[View as Group Map](/docs/end-user/basic-navigation/visualization)** (): Shows a bar across the top of each group to indicate the status of the group as determined by the Group Map settings. -14. **[View as Group Map Table](/docs/end-user/basic-navigation/visualization)** (): Similar to the Group Map View, it shows the groups as titles in a table. -15. **[View as Geo Table](/docs/end-user/basic-navigation/visualization)** (): The Group Map view is similar to the KPI Map but gives each group its status. +12. **[View as KPI Map](/docs/end-user/basic-navigation/visualization/#view-as-kpi-map)** (): KPI maps, if configured by your admin, show a graphical heat map of all the KPIs in the level you are currently viewing. +13. **[View as Group Map](/docs/end-user/basic-navigation/visualization/#view-as-group-map)** (): Shows a bar across the top of each group to indicate the status of the group as determined by the Group Map settings. +14. **[View as Group Map Table](/docs/end-user/basic-navigation/visualization/#view-as-group-map-table)** (): Similar to the Group Map View, it shows the groups as titles in a table. +15. **[View as Geo Table](/docs/end-user/basic-navigation/visualization/#view-as-geo-map)** (): The Group Map view is similar to the KPI Map but gives each group its status. 16. **View Status Summary** (): Shows you a summary and history of your best and worst KPIs at the group level in Pareto chart form. 17. **View Status History** (): Shows you the relative performance of the selected KPIs grouped into the various status options. 18. **View Notification History** (): See how many times notifications have been sent for the KPIs in alert status. @@ -47,11 +47,11 @@ The KPI Bullet Chart view () is similar to the KPI List Vie For the KPI Bullet Chart, you have multiple view options. Use the Grouping icon to select from the Default view, Actual EU (engineering units), Deviation %, and Deviation EU. -For this view, each KPI requires a minimum amount of information to be included in its configuration. For example, you need a minimum of one limit and even then it will be very limited. One of the most important attributes to add to each KPI is a min and max value. These are the limits of what you expect to be possible and where any value outside of this is most likely incorrect data (for example, a KPI measuring available disk space should never be able to show a negative number or a number larger than the size of your disk). +Each KPI requires a minimum amount of information to be included in its configuration for this view. For example, you need a minimum of one limit, and even then, it will be very limited. A minimum and maximum value is one of the most important attributes to add to each KPI. These are the limits of what you expect to be possible and where any value outside of this is most likely incorrect data (for example, a KPI measuring available disk space should never be able to show a negative number or a number larger than the size of your disk). -In all cases, the leftmost edge is defined by the first non-empty low side value (min, LLL, LL, L, Actual) while the rightmost edge is defined by the last non-empty high side value (max, HHH, HH, H, Actual). +In all cases, the leftmost edge is defined by the first non-empty low side value (min, LLL, LL, L, Actual), while the rightmost edge is defined by the last non-empty high side value (max, HHH, HH, H, Actual). -The example below shows the Deviation % view which centers the target and shows which KPIs are deviating by a great % from their target. +The example below shows the Deviation % view, which centers on the target and shows which KPIs are deviating by a great % from their target. ) shows a real-time trend of KPIs, which are great for visualizing historical and time-stamped data by just moving your mouse over the trends. Trends can be configured in Visual KPI Designer or created on the fly by users in your Visual KPI sites. -You can visualize trends for individual KPIs or select up to 20 individual KPIs to view and compare as trends. With trends, you can compare multiple values, or the same value, at different times. And as with all KPIs, you can see the trend change in real-time as the data changes. +You can visualize trends for individual KPIs or select up to 20 to view and compare as trends. With trends, you can compare multiple values or the same value at different times. As with all KPIs, the trend changes in real-time as the data changes. -Trends are highly configurable. You can go back as far as data exists, define and customize time ranges, and more. You can even define custom, Ad Hoc trends right from your device and add them to your Dashboard. Use filters, grouping, and time ranges to elaborate all kinds of trends. Learn more about [Trends](/docs/end-user/features/visualizations/trends) and their different types of visualization. +Trends are highly configurable. You can go back as far as data exists, define and customize time ranges, and more. You can even define custom Ad Hoc trends right from your device and add them to your Dashboard. Use filters, grouping, and time ranges to elaborate all kinds of trends. Learn more about [Trends](/docs/end-user/features/visualizations/trends) and their different types of visualization. -## View as status history chart +## View as a status history chart The KPI Status History view () shows you a summary and history of your best and worst KPIs at the group level. This view is similar to the KPI List view and the KPI Bullet Chart view, but the KPI Status History view shows status changes over time. Clicking on a KPI in this view opens the full KPI Status History Trend. @@ -101,7 +101,7 @@ The KPI Status History view () shows you a summary and histo ## View status summary -Visual KPI shows you a summary and history of your best and worst KPIs at the group level. Status Summary (), Status History (), and Notification History () allow you to track over time the history of KPIs in alert and when alert notifications have been sent. You can see Status for the entire group as a Pareto chart, and then get more details for individual KPIs. Also, adjust the time range to see a summary or history over a given reference, and freely scroll back and forward in time. +Visual KPI shows you a summary and history of your best and worst KPIs at the group level. Status Summary (), Status History (), and Notification History () allow you to track over time the history of KPIs in alert and when alert notifications have been sent. You can see Status for the entire group as a Pareto chart and then get more details for individual KPIs. Also, adjust the time range to see a summary or history over a given reference and freely scroll back and forward in time. For any group of KPIs, retrieve a list of KPIs that displays relative performance over the period defined. The Pareto chart shows which KPIs are the worst performing as a percentage of the total. Move your mouse over a KPI in the chart to see a value. @@ -121,12 +121,11 @@ For Status Summary () and Status History (): -- for Status Summary, to see how many times the KPIs have been in an alert state over the defined period, or have reached a particular status over time. -- for Status History, to see how many times a KPI has reached a particular status over time. - + - for Status Summary, to see how many times the KPIs have been in an alert state over the defined period, or have reached a particular status over time. + - for Status History, to see how many times a KPI has reached a particular status over time. 2. **Time-in-State icon** (): -- for Status Summary, to see how much time a KPI spent in an alert state. -- for Status History, in a status state. + - for Status Summary, to see how much time a KPI spent in an alert state. + - for Status History, in a status state. Click any KPI in the Pareto chart to see a trend over time and a list view below the trend. @@ -164,10 +163,10 @@ When accessing KPIs, you may want to know more about a particular one. Clicking ## KPI link view -You'll find links all over Visual KPI. Visual KPI links can be configured by administrators or by Visual KPI site users. The link view isn't limited to internal links, you can add external links to software or other tools you use often. Some of the most common places you'll find the Visual KPI links view are: +You'll find links all over Visual KPI. Visual KPI links can be configured by administrators or by Visual KPI site users. The link view isn't limited to internal links. You can add external links to software or other tools you often use. Some of the most common places you'll find the Visual KPI links view are: 1. **Visual KPI objects**: Links from an object, such as a KPI, chart, or group. These are added as an attribute via Visual KPI Designer and they're tied to the object and available to all profiles. -2. **Dashboard link widgets**: using the [Customize Dashboard widget](/docs/end-user/features/dashboards) you can tie a link to a Dashboard. However, only profiles with access to these Dashboards will see them. +2. **Dashboard link widgets**: using the [Customize Dashboard widget](/docs/end-user/features/dashboards), you can tie a link to a Dashboard. However, only profiles with access to these Dashboards will see them. 3. **Bookmark bar links**: Links on the [Bookmark bar](/docs/end-user/features/profiles) are tied to a profile. 4. **Nav bar links**: These links, configured by your admin, are sitewide and everyone with access to the site will see them. 5. **KPI detail pages**: Links for the KPI detail view must be configured by your admin. diff --git a/visual-kpi-docs/docs/end-user/features/visualizations/trends.mdx b/visual-kpi-docs/docs/end-user/features/visualizations/trends.mdx index 84fcc034..5ffba051 100644 --- a/visual-kpi-docs/docs/end-user/features/visualizations/trends.mdx +++ b/visual-kpi-docs/docs/end-user/features/visualizations/trends.mdx @@ -9,11 +9,11 @@ tags: ['features', 'end-user', 'advanced', 'visualization', 'view', 'trends', 'p import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; import SvgFont from '@site/src/components/SvgFont/SvgFont'; -Trends, or Ad Hoc Trends, are a custom type of trend that you can build right inside your Visual KPI site. You can save an Ad Hoc Trend and add it to the Dashboard and get it updated in real time. +Trends, or Ad Hoc Trends, are a custom type of trend that you can build right inside your Visual KPI site. You can save an Ad Hoc Trend, add it to the Dashboard, and update it in real-time. -Click anywhere in an individual KPI to enlarge the trend and get access to options for visualizing your trend based on the parameters you choose. Trends can monitor a value or show a current status if targets and limits have been configured by your administrator. The default trend view will depend on how your admin has configured trends. Still, you have many options for viewing Visual KPI trends and quickly seeing how a KPI performs over time. +Click anywhere in an individual KPI to enlarge the trend and get access to options for visualizing your trend based on the parameters you choose. Trends can monitor a value or show a current status if your administrator has configured targets and limits. The default trend view will depend on how your admin has configured trends. Still, you have many options for viewing Visual KPI trends and quickly seeing how a KPI performs over time. -You can do many different things with Trends to see data in various ways. When visualizing a trend you have de following visualization options: +You can do many different things with Trends to see data in various ways. When visualizing a trend, you have the following visualization options: 1. **Trend Options** (): Choose Trend Scale and Line types, turn on/off Trend live updates, and define the Pen width. 2. **Modify Trend** (): Select minimum and maximum for Y axis, add pens and customize your trend. @@ -29,22 +29,22 @@ You can do many different things with Trends to see data in various ways. When v 12. **Cursor Mode** (): Scroll over the trend chart with your mouse to see more data details associated with specific points in time along the trend. Clicking or tapping on the trend will lock the current cursor and let you add additional cursors for comparison. 13. **Snap to** (): Snap your cursor to point along the trend line where actual values exist in the data source, highlighting the difference between real values and interpolated lines drawn between values. 14. **Legend**: You can define the limits and references for your trend, and name each of those references as you like. These names will be shown on the legend. -15. **Timestamp** (/): use de paddles to change the time view. +15. **Timestamp** (/): Use paddles to change the time view. -For a standard Visual KPI trend with targets and limits, you'll see a trend of the KPI value over time, along with targets and limits and the current status. A legend will appear below the trend to indicate how to read targets and limits. Using the Trend menu, you can change everything from the time range view to the status history. You can view raw data and details about the KPI. +For a standard Visual KPI trend with targets and limits, you'll see a trend of the KPI value over time, along with targets and limits and the current status. A legend will appear below the trend to indicate how to read targets and limits. You can change everything from the time range view to the status history using the Trend menu. You can view raw data and details about the KPI. ## Trend view options -The Trend Options icon () allows you to change how you view data and targets and limits in a trend. +The Trend Options icon () lets you change how you view data, targets, and limits in a trend. ### Trend scale -View the trend in Single Scale mode with only the Target line indicator showing, or you can view in Multi-Scale mode that shows all status indicator line parameters. This is most appropriate when viewing managed or Ad Hoc trends with multiple pens that have very different scales. On multi-scale trends, clicking on the pen name in the legend of the trend will adjust the Y-axis. +View the trend in Single Scale mode with only the Target line indicator showing, or you can view in Multi-Scale mode that shows all status indicator line parameters. This is most appropriate when viewing managed or Ad Hoc trends with multiple pens with very different scales. On multi-scale trends, clicking on the pen name in the trend legend will adjust the Y-axis. ### Trend type @@ -76,4 +76,4 @@ Regardless of the trend or chart type you select and view, you can use the menu ## What's next? -If you are interested in deep diving into Trends, please check our [KPI Visualization](/docs/end-user/features/visualizations/kpi) page to learn about all the KPI visualization options that Visual KPI has to offer. \ No newline at end of file +If you are interested in deep-diving into trends, check out the [KPI Visualization](/docs/end-user/features/visualizations/kpi) page to learn about all the KPI visualization options that Visual KPI has to offer. \ No newline at end of file diff --git a/visual-kpi-docs/docs/end-user/overview.mdx b/visual-kpi-docs/docs/end-user/overview.mdx index 8a82e7e1..6b1417ab 100644 --- a/visual-kpi-docs/docs/end-user/overview.mdx +++ b/visual-kpi-docs/docs/end-user/overview.mdx @@ -6,7 +6,7 @@ description: 'The End User documentation section will guide you on how to use th tags: [] --- -This 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 you with a comprehensive understanding of Visual KPI's 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. +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. ## [Core Concepts](/docs/end-user/core-concepts/overview) @@ -18,6 +18,6 @@ Further, in [Basic Navigation](/docs/end-user/basic-navigation/overview), we'll ## [Features](/docs/end-user/features/end-user/features) -Then, in [Features](/docs/end-user/features/end-user/features), we're going to deep dive into advanced ways of using the Visual KPI tools. Learn how to do trend analysis within Visual KPI, and customize your view to suit your specific needs by exploring the various visualization options available in our software. +Then, in [Features](/docs/end-user/features/end-user/features), we're going to dive deep into advanced ways of using the Visual KPI tools. Learn how to do trend analysis within Visual KPI and customize your view to suit your specific needs by exploring the various visualization options available in our software. -The Visual KPI End-User Guide is your go-to resource for getting started and becoming proficient with the Visual KPI application. By following this guide, you'll be well on your way to leveraging Visual KPI to its fullest potential, turning your operational data into actionable insights that drive decision-making and improve performance. \ No newline at end of file +The Visual KPI End-User Guide is your go-to resource for getting started and becoming proficient with the Visual KPI application. By following this guide, you'll be well on your way to leveraging Visual KPI to its fullest potential, turning your operational data into actionable insights that drive decision-making and improve performance. 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 34a98f22..34341a31 100644 --- a/visual-kpi-docs/docs/how-to-use-the-documentation.mdx +++ b/visual-kpi-docs/docs/how-to-use-the-documentation.mdx @@ -20,7 +20,7 @@ The Visual KPI documentation aims to provide content in a tailored way for three ## Documentation Structure -It's important to note that the documentation for Visual KPI has been organized to serve three types of users - each with their own section and specific content to assist them in using the available tools. However, we suggest starting with the [Visual KPI Core Concepts](/docs/core-concepts) to gain a general understanding of the platform's functionality. +It's important to note that the documentation for Visual KPI has been organized to serve three types of users - each with its own section and specific content to assist them in using the available tools. However, we suggest starting with the [Visual KPI Core Concepts](/docs/core-concepts) to gain a general understanding of the platform's functionality. After covering the concepts, each user can follow their specific section: @@ -32,13 +32,13 @@ In addition to these tailored sections, Visual KPI documentation provides suppor - [Reference guides](/docs/references): These provide detailed documentation and information for users to refer to when they need in-depth knowledge or assistance regarding specific Visual KPI functionalities. -- [Frequently asked questions (FAQs)](/docs/faq): This section contains answers to common questions and issues that users may encounter while using Visual KPI, offering quick solutions. +- [Frequently Asked Questions (FAQs)](/docs/faq): This section contains answers to common questions and issues that users may encounter while using Visual KPI, offering quick solutions. - [Troubleshooting resources](/docs/troubleshooting): If you come across any errors while using Visual KPI, such as interface connection issues or when attempting to verify SQL-related problems, it's advisable to consult the troubleshooting suggestions for assistance. - [Training materials](/docs/training): Include training video courses and other materials designed to educate users on effectively using Visual KPI and its features. -- [Glossary](/docs/glossary): Here you find list of key terms and their definitions to clarify technical jargon and terminology used within Virtual KPI. +- [Glossary](/docs/glossary): Explore a list of key terms and their definitions to clarify technical jargon and terminology used within Virtual KPI. ## What's Next? diff --git a/visual-kpi-docs/docs/how-visual-kpi-works.mdx b/visual-kpi-docs/docs/how-visual-kpi-works.mdx index d5dd64d1..958a7042 100644 --- a/visual-kpi-docs/docs/how-visual-kpi-works.mdx +++ b/visual-kpi-docs/docs/how-visual-kpi-works.mdx @@ -24,7 +24,7 @@ Transpara understands that each customer and each application may require a diff :::support Contact Transpara -Transpara team is always ready for supporting you. Get in touch with our [support team](https://www.transpara.com/contact-us/) so we can cover any doubts you have regarding how Transpara Visual KPI can feet into your company. +Transpara team is always ready to support you. Contact our [support team](https://www.transpara.com/contact-us/) so we can cover any doubts you have regarding how Transpara Visual KPI can fit into your company. ::: diff --git a/visual-kpi-docs/docs/visual-kpi-approach.mdx b/visual-kpi-docs/docs/visual-kpi-approach.mdx index 5fdadfca..38d1e2d7 100644 --- a/visual-kpi-docs/docs/visual-kpi-approach.mdx +++ b/visual-kpi-docs/docs/visual-kpi-approach.mdx @@ -10,7 +10,7 @@ When dealing with KPI data visualization, Transpara's Visual KPI stands out as a ## Why Visual KPI is Different From Other Solutions -Conventional data visualization software requires you to execute a time-consuming process to be able to visualize each KPI. For each KPI visualization, you need to create individual charts and link them to the data source. This repetitive process is unfeasible for companies with hundreds or thousands of KPIs to monitor. In addition, some data visualization software is high processing demanding, presenting significant loading times and frequent slowing or even freezing devices. +Conventional data visualization software requires you to execute a time-consuming process to be able to visualize each KPI. For each KPI visualization, you need to create individual charts and link them to the data source. This repetitive process is unfeasible for companies with hundreds or thousands of KPIs to monitor. In addition, some data visualization tools are highly processing-demanding, presenting significant loading times and frequent slowing or even freezing devices. ### Visual KPI Advantages diff --git a/visual-kpi-docs/docs/what-is-visual-kpi.mdx b/visual-kpi-docs/docs/what-is-visual-kpi.mdx index b1ed026c..f47c1400 100644 --- a/visual-kpi-docs/docs/what-is-visual-kpi.mdx +++ b/visual-kpi-docs/docs/what-is-visual-kpi.mdx @@ -6,11 +6,11 @@ description: 'Discover Transpara Visual KPI solution and learn more about its so tags: [] --- -Transpara's Visual KPI is a 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. +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. ## Our Product and Who Uses It -Visual KPI offers different options to monitor your business operations in a straightforward solution. You won't have to contact different teams to get insights. Instead, Transpara's Visual KPI automatically collects data from various sources, and you can view it all on a single place. It simplifies the data analysis, making things easier to manage. In addition, Visual KPI also sends notifications when there is something you need to address and you can access it using desktop or mobile. +Visual KPI offers different options to monitor your business operations in a straightforward solution. You won't have to contact different teams to get insights. Instead, Transpara's Visual KPI automatically collects data from various sources, and you can view it all in a single place. It simplifies the data analysis, making things easier to manage. In addition, Visual KPI also sends notifications when there is something you need to address, and you can access it using desktop or mobile. Visual KPI typical customers come from various industries, including: @@ -32,19 +32,25 @@ The solution is completely customizable, and we keep adding new features to meet Visual KPI enables you to connect with multiple data sources and integrate them easily, customizing each operation through an intuitive and user-friendly dashboard. With Transpara's Visual KPI, you can enjoy the following benefits: -- Visualize and monitoring the performance of your operations in near real-time, eliminating the reliance on outdated reports. +- Visualize and monitor the performance of your operations in near real-time, eliminating the reliance on outdated reports. - Use on different devices (computer or on your mobile phone). -- Have an intuitive and flexible control panel, where you can adapt the displayed information according to your company's specific needs. +- Have an intuitive and flexible control panel where you can adapt the displayed information according to your company's specific needs. - Connect your company to various data sources and solutions in a unified way. - Simplified analysis and decision-making based on accurate information. - Rely on the free support of a dedicated sales team. ## Real-Time Excellence with Visual KPI -Transpara's Visual KPI provides a comprehensive solution to connect and optimize your operations management and monitor near real-time performance. If you want to learn more or have a specific data source you'd like to include in your platform, [please contact us](./). +Transpara's Visual KPI provides a comprehensive solution to connect and optimize your operations management and monitor near real-time performance. If you want to learn more or have a specific data source you'd like to include in your platform, [please contact us](https://www.transpara.com/contact-us/). -We're constantly updating and expanding our software to meet your ever-evolving needs. We already support dozens of data sources out the box and we're ready to help you in case you have special needs. +:::support Contact Transpara + +Transpara team is always ready to support you. Contact our [support team](https://www.transpara.com/contact-us/) so we can cover any doubts you have regarding how Transpara Visual KPI can fit into your company. + +::: + +We're constantly updating and expanding our software to meet your ever-evolving needs. We already support dozens of data sources out of the box, and we're ready to help you if you have special needs. ## What's Next? -To continue your journey with Visual KPI documentation, we suggest you to see the unique [Visual KPI approach](./visual-kpi-approach) and [how it works](./how-visual-kpi-works). +To continue your journey with Visual KPI documentation, we suggest you to see the unique [Visual KPI approach](/docs/visual-kpi-approach) and [how it works](/docs/how-visual-kpi-works).