Skip to content

Commit

Permalink
Merge branch 'main' into table-component
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielraeder authored Mar 4, 2024
2 parents b31aae1 + 589ad3f commit 36e198d
Show file tree
Hide file tree
Showing 27 changed files with 226 additions and 206 deletions.
4 changes: 2 additions & 2 deletions visual-kpi-docs/docs/core-concepts/core-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
11 changes: 9 additions & 2 deletions visual-kpi-docs/docs/core-concepts/hierarchy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/core-concepts/kpi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
13 changes: 10 additions & 3 deletions visual-kpi-docs/docs/end-user/basic-navigation/alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
28 changes: 14 additions & 14 deletions visual-kpi-docs/docs/end-user/basic-navigation/basic-navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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.
Explore more details of the basic navigation, access [Profiles](./profiles), and learn more about the Profiles feature for Visual KPI.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<StylizedImage
imgURL="/img/docs/end-user/basic-navigation/dark-light-theme/basicnavigation-lightdarktheme.gif"
Expand All @@ -20,4 +18,4 @@ By default, Visual KPI sites have a white background; this is the light theme. B

## What's Next?

Learn how to work with different time parameters in your Visual KPI site accessing the [Time](time) content.
Learn to work with different time parameters in your Visual KPI site accessing the [Time](/docs/end-user/basic-navigation/time) content.
24 changes: 12 additions & 12 deletions visual-kpi-docs/docs/end-user/basic-navigation/dashboards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import SvgFont from '@site/src/components/SvgFont/SvgFont';

Dashboards offer a personalized overview of your core information. Customize multiple dashboards to monitor the processes you manage efficiently. You can customize your dashboards with several Visual KPI objects like KPIs, charts, tables, groups, trends, and external links. In addition, it's possible to easily arrange, resize, and incorporate custom images, statistics, and dynamic text blocks.

## Selecting a dashboard
## Selecting a Dashboard

To change between different dashboards, use the **Dashboard** (<SvgFont icon="10"/>) 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.

Expand All @@ -22,11 +22,11 @@ To change between different dashboards, use the **Dashboard** (<SvgFont icon="10

You can have as many dashboards as you want, belonging to one or more profiles. When you change your profile, the dashboard list updates, presenting the dashboards linked with the current Dashboard.

## How to create a dashboard
## How to create a Dashboard

You can create a new dashboard from scratch or copy an existing one. For instance, copying an existing dashboard can be helpful when you want to edit a locked dashboard or compile dashboards from different profiles in your profile. To create a new dashboard, follow the steps below:

1. Click in the **Dashboard** icon (<SvgFont icon="10"/>).
1. Click on the **Dashboard** icon (<SvgFont icon="10"/>).
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.
Expand Down Expand Up @@ -67,7 +67,7 @@ In the dashboard, the Options menu (<SvgFont icon="188"/>) 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:

Expand All @@ -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 (<SvgFont icon="188"/>).
2. Select **Customize Dashboard** (<SvgFont icon="260"/>).
Expand All @@ -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.
Expand All @@ -123,7 +123,7 @@ Some Visual KPI objects have multiple possible visualizations and information th
1. Click in the **Options** menu (<SvgFont icon="188"/>).
2. Select **Customize Dashboard** (<SvgFont icon="260"/>).
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
Expand All @@ -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 (<SvgFont icon="188"/>).
3. Select one of the three option available:
- **Add to *Dashboard*** (<SvgFont icon="115"/>): 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*** (<SvgFont icon="115"/>): 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** (<SvgFont icon="115"/>): This enables you to use the current visualization in a new dashboard that you will create.
**Add to Existing Dashboard** (<SvgFont icon="115"/>): 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.

<StylizedImage
imgURL="img/docs/end-user/basic-navigation/dashboards/basicnavigation-add-to-dashboard.gif"
Expand All @@ -166,7 +166,7 @@ When you first access a dashboard, each KPI typically uses a different Time Rang

To define a standard Time Range for all objects in your dashboard, follow the steps below:

1. Click in the Time Range Picker (<SvgFont icon="244"/>).
1. Click on the Time Range Picker (<SvgFont icon="244"/>).
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.
Expand Down
Loading

0 comments on commit 36e198d

Please sign in to comment.