Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To access the Visual KPI documentation page related to the main branch of this p
## Project Organization

To contribute or request modifications and updates, please create an issue. When creating issues, be sure to assign relevant labels to facilitate project organization. You can find a list of existing labels [here](https://github.com/transpara/documentation/labels). Additionally, you have the option to create branches and assign collaborators to them.
All new issues are initially allocated to the "ToDo" column within the [Project](https://github.com/orgs/transpara/projects/19) board of the project repository.
All new issues are initially allocated to the "ToDo" column within the [Project](https://github.com/orgs/transpara/projects/19) board of the project repository.

## Branches Organization

Expand Down
48 changes: 32 additions & 16 deletions visual-kpi-docs/docs/end-user/basic-navigation/visualization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,31 @@ import SvgFont from '@site/src/components/SvgFont/SvgFont';

Visual KPI provides different options to visualize data, making it easier to communicate information and suit different learning styles, ensuring everyone in a company can easily understand trends and patterns. Additionally, having various visualization options lets users personalize their views to focus on the insights that matter most to their roles.

## Group visualizations
## Group Roll-Ups/List View

Groups are how your information is organized, a key form of navigation. Some of the icons you see in Groups are universal. Others only show up if they have been turned on and/or configured in the Visual KPI Designer. And still, others show up depending on what you are viewing.
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 (<SvgFont icon="206"/>).

<StylizedImage
imgURL="img/docs/end-user/basic-navigation/visualization/basicnavigation-groups-rollup.png"
alt="List View"
/>

Group Roll-ups are bar charts that summarize how all your KPIs in a defined set (Group) are performing at a glance. The colors on Group Roll-ups indicate status and are relative to the other colors. Each bar shows the group's performance in percentages and rolls them up to show how that group is performing.

## Top Bar
The top bar in Group Roll-Ups (parent group) represents the overall status of the group. It includes the parent group and all child groups. That means that no matter how many levels of groups you have, the parent group will always roll up the overall status of all the KPIs in that group and every group that belongs to that group.

### Drill Down

When viewing a Group Roll-Up, you can explore more details by drilling down into specific groups. Each drill-down step reveals additional information about the selected group and its subgroups, if available. You can continue drilling down through all levels of groups to see their details.

<StylizedImage
imgURL="img/docs/end-user/basic-navigation/visualization/visualization-drill-down.gif"
alt="Drill Down"
/>

## Group Visualizations

Groups are how your information is organized, a key form of navigation. Some of the icons you see in Groups are universal. Others only show up if they have been turned on and/or configured in the Visual KPI Designer. And still, others show up depending on what you are viewing.

In the top bar, you find different visualization options for your groups and KPIs. Some icons and functions you may see related to Groups are:

Expand All @@ -33,19 +53,6 @@ In the top bar, you find different visualization options for your groups and KPI
alt="Menu options"
/>

### Group Roll-Ups/List View

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 (<SvgFont icon="206"/>).

<StylizedImage
imgURL="img/docs/end-user/basic-navigation/visualization/basicnavigation-groups-rollup.png"
alt="List View"
/>

Group Roll-ups are bar charts that summarize how all your KPIs in a defined set (Group) are performing at a glance. The colors on Group Roll-ups indicate status and are relative to the other colors. Each bar shows the group's performance in percentages and rolls them up to show how that group is performing.

The top bar in Group Roll-Ups (parent group) represents the overall status of the group. It includes the parent group and all child groups. That means that no matter how many levels of groups you have, the parent group will always roll up the overall status of all the KPIs in that group and every group that belongs to that group.

### Filters

Use the Filters (<SvgFont icon="184"/>) 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:
Expand Down Expand Up @@ -112,6 +119,15 @@ The lower right corner of a KPI will warn you when a KPI status has recently cha
alt=""
/>

#### Add Block to Dashboard

When visualizing KPIs as blocks, you can select one or more and add them directly to the Dashboard. To do that, select the desired KPIs, which will show at the top of the page. Once all the KPIs you wish to add are selected, click on **Add to Dashboard**. After they are in your Dashbaord, you can [customize the Dashboard](/docs/end-user/basic-navigation/dashboards#customize-a-dashboard) as you wish.

<StylizedImage
imgURL="img/docs/end-user/features/visualization/kpi/features-visualization-blockdashboardwidget.gif"
alt="Add Block to Dashboard"
/>

### View as Group Map

The Group Map (<SvgFont icon="141"/>) 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.
Expand Down
40 changes: 22 additions & 18 deletions visual-kpi-docs/docs/end-user/features/visualizations/charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,21 @@ tags: ['features', 'end-user', 'advanced', 'visualization', 'view', 'pareto', 'p
import StylizedImage from '@site/src/components/StylizedImage/StylizedImage';
import SvgFont from '@site/src/components/SvgFont/SvgFont';

<head>
<title>Charts</title>
<meta name="keywords" content="features, end user, advanced, visualization, view, pareto, pie chart, gantt, bar chart, histogram, XY plot, box plot, gauge cahrt, kpi image overlay view, chart types, visualize data, data visualization, chart view"/>
</head>

Charts show data as it relates to its defined limits. Visual KPI uses many chart types to visualize data using status, colors, and limits. The chart view options are:

1. [XY plots](/docs/end-user/features/visualizations/charts#xy-plots) (<SvgFont icon="133"/>)
1. [XY Plots](/docs/end-user/features/visualizations/charts#xy-plots) (<SvgFont icon="133"/>)
2. [Histogram](/docs/end-user/features/visualizations/charts#histogram-charts) (<SvgFont icon="292"/>)
3. [Bar charts](/docs/end-user/features/visualizations/charts#bar-charts) (<SvgFont icon="142"/>)
4. [Pareto charts](/docs/end-user/features/visualizations/charts#pareto-charts) (<SvgFont icon="132"/>)
5. [Pie charts](/docs/end-user/features/visualizations/charts#pie-chats) (<SvgFont icon="124"/>)
6. [Box plots](/docs/end-user/features/visualizations/charts#box-plots) (<SvgFont icon="23"/>)
7. [Gantt charts](/docs/end-user/features/visualizations/charts#gantt-charts) (<SvgFont icon="122"/>)
8. [Gauge charts](/docs/end-user/features/visualizations/charts#gauge-charts) (<SvgFont icon="11"/>)

3. [Bar Charts](/docs/end-user/features/visualizations/charts#bar-charts) (<SvgFont icon="142"/>)
4. [Pareto Charts](/docs/end-user/features/visualizations/charts#pareto-charts) (<SvgFont icon="132"/>)
5. [Pie Charts](/docs/end-user/features/visualizations/charts#pie-charts) (<SvgFont icon="124"/>)
6. [Box Plots](/docs/end-user/features/visualizations/charts#box-plots) (<SvgFont icon="23"/>)
7. [Gantt Charts](/docs/end-user/features/visualizations/charts#gantt-charts) (<SvgFont icon="122"/>)
8. [Gauge Charts](/docs/end-user/features/visualizations/charts#gauge-charts) (<SvgFont icon="11"/>)

<StylizedImage
imgURL="img/docs/end-user/features/visualization/charts/features-visualization-charts-cut.png"
Expand All @@ -32,9 +36,9 @@ Not all charts are available everywhere. Depending on the object you select, dif
Note also that to use some chart options, you need to fulfill some requirements. For example, to make the XY plot visualization available, you need to select at least two KPIs.
:::

## XY plots
## XY Plots

XY plots (<SvgFont icon="133"/>), also known as Scatter charts, help you see how two sets of data are related. By looking at where the dots are placed, you can tell whether the two data sets have a relationship or pattern.
XY plots (<SvgFont icon="133"/>), also known as Scatter Plot, help you see how two sets of data are related. By looking at where the dots are placed, you can tell whether the two data sets have a relationship or pattern.

For example, a wind farm operator might use an XY plot to examine the relationship between wind speed (X-axis) and the amount of energy generated by the turbines (Y-axis). By plotting these data points, the chart can show how changes in wind speed affect energy output.

Expand Down Expand Up @@ -62,7 +66,7 @@ To add the fit line, click the **XY Plot Options** icon (<SvgFont icon="188 "/>)

The XY plots in Visual KPI can be associated with time-series or non-time-series. In addition, they can be manually or query-based configured, depending on how your admin set it.

## Histogram charts
## Histogram Charts

Histogram charts in Visual KPI provide a way to visualize the frequency distribution of range values for your KPIs over time. A histogram is a type of bar chart that represents the distribution of numerical data by dividing it into intervals, often called bins, and counting the number of data points that fall into each bin. The height of each bar reflects the frequency of data points within that interval. The histograms help you identify concentrations and patterns that inform decision-making.

Expand Down Expand Up @@ -97,7 +101,7 @@ Histogram charts are useful for KPIs that aren't regularly sampled. They help sp

:::

## Bar charts
## Bar Charts

Bar charts (<SvgFont icon="142"/>) 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.

Expand All @@ -115,7 +119,7 @@ Depending on the configuration by your admin, Bar charts can be:
alt="Visualization charts"
/>

## Pareto charts
## Pareto Charts

Pareto charts (<SvgFont icon="132"/>) can help you quickly see which of your assets are most critical and know where you need to focus. Thus, you can use them to monitor quality control, identifying where most problems come from.

Expand All @@ -131,7 +135,7 @@ A Pareto chart contains bars and a line graph:

In Visual KPI, you can 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.

## Pie chats
## Pie Charts

Pie charts (<SvgFont icon="124"/>) 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.

Expand All @@ -145,9 +149,9 @@ Depending on how your admin configures them, Pie charts can be:
alt="Pie Chart"
/>

## Box plots
## Box Plots

Box plots (<SvgFont icon="23"/>) display variation in samples without making assumptions about the underlying statistical distribution. In Visual KPI, Box plots can be based on time-series data or non-time-series data.
Box plots (<SvgFont icon="23"/>), aslo known as Whisker plots, display variation in samples without making assumptions about the underlying statistical distribution. In Visual KPI, Box plots can be based on time-series data or non-time-series data.

Box plots display a dataset through quartiles:

Expand All @@ -164,7 +168,7 @@ End users in Visual KPI sites can create box plots, or admins can create Box plo
alt="Box Plot Chart"
/>

## Gantt charts
## Gantt Charts

Gantt charts (<SvgFont icon="122"/>) are great for showing time-sequenced events. They can show you all of the elements of a project along a timeline, including when each component is scheduled to be completed, any dependencies, and the status of each. Task or project elements are listed along the vertical axis of the Gantt Chart, and the horizontal axis displays time intervals.

Expand All @@ -179,7 +183,7 @@ Gantt charts are only query-based in Visual KPI. Your admin must create them.

:::

## Gauge charts
## Gauge Charts

Gauge charts (<SvgFont icon="11"/>), also known as Dial or Speedometer, are a meter-type visualization that shows the real-time status of a KPI, indicated by a gauge and needle, within a range that includes targets and actual values. These charts include minimum and maximum ranges and an indicator for an ideal target. They also can be used to show actual performance versus targets or progress toward a target for anything from temperature, weight, and speed to percentages of sales or work completed, performance, and more.

Expand Down
22 changes: 11 additions & 11 deletions visual-kpi-docs/docs/end-user/features/visualizations/kpi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Trends are highly configurable. You can go back as far as data exists, define an

## View as a status history chart

The KPI Status History view (<SvgFont icon="37"/>) 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.
The KPI Status History view (<SvgFont icon="37"/>), also known as Shaded Line Chart, 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 Trend 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.

<StylizedImage
imgURL="img/docs/end-user/features/visualization/kpi/features-visualization-statushistorychart.png"
Expand Down Expand Up @@ -165,19 +165,19 @@ For any group, see how many times notifications have been sent for the KPIs in a

When accessing KPIs, you may want to know more about a particular one. Clicking the **View Details** icon (<SvgFont icon="267"/>), you may find any of the following KPI details:

1. Contacts
2. Links
3. KPI properties
4. KPI stats
5. Parameters
6. Manual data entry (if enabled)
7. Custom attributes
8. Membership
- Contacts
- Links
- KPI properties
- KPI stats
- Parameters
- Manual data entry (if enabled)
- Custom attributes
- Membership

{/* <StylizedImage
<StylizedImage
imgURL="img/docs/end-user/features/visualization/kpi/enduser-features-visualization-kpi-details.gif"
alt="KPI Details"
/> */}
/>

## KPI link view

Expand Down
17 changes: 17 additions & 0 deletions visual-kpi-docs/docs/end-user/features/visualizations/trends.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,23 @@ From any KPI list view, click the **Select KPI** icon (<SvgFont icon="255"/>) an

Regardless of the trend or chart type you selected to view, you can use the menu in the new view to choose any of the other trends or chart types to visualize data in. When in a trend, you can add a background color to show status changes over time using the Show Status Background icon.

## SPC

[Statistical Process Control (SPC)](https://en.wikipedia.org/wiki/Statistical_process_control) is a method for monitoring, controlling, and improving processes based on statistical analysis. It measures whether processes are within control limits.

You can use SPC rules to measure quality and productivity. Data is plotted on control charts over a time range using standard deviations and other statistics so you can quickly visualize and analyze it and see when a process is out of control and needs attention.

SPC contains a handy set of rules for defining control limits in cases where time values don't correlate. An example would be data collected from lab samples or tracking blood sugar results in diabetes patients.

By charting the data over time and using statistical decision rules, you can determine whether your process or data is stable or has variations that denote instability. You can see where improvements need to be made or take action in real-time with processes outside control limits.

When you apply SPC rules, a KPI may be charted with a Center Line (control value or xBar) or at 1, 2, or 3 standard deviations.

<StylizedImage
imgURL="img/designer/kpis-spc.png"
alt="KPI SPC Example"
/>

## What's next?

To finish your learning, check out the [Embedded Content](/docs/end-user/features/visualizations/embedded-content) for more information on using external links in Visual KPI or embedding Visual KPI in other applications.
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,6 @@ Security in Visual KPI is multi-level. To understand the security measures we im
- **Authorization** refers to a collection of users (assigned to AD Groups) with predefined access. A user must belong to an AD Group to gain access to a particular site in Visual KPI. Data may not be available to the user group on that site unless the group also has the appropriate rights assignment.
- **Rights assignment** determines what information a user should have access to and what is blocked once the user has proven, with valid credentials, that he is a legit user with authorized access. Visual KPI Server and Active Directory are used to manage rights assignment.

To understand how the entire security path works in Visual KPI, think of these fundamental steps (each of which may require a multi-step process to set up):

1. Data encryption for transmission between the Web server and Visual KPI client. https://www.transpara.com/knowledge-base/enable-encryption/

2. Validation of user ID and password for authorized access to any Visual KPI client. https://www.transpara.com/knowledge-base/security-create-local-groups/

3. Inclusion of users with authorized access to an Active Directory Group. https://www.transpara.com/knowledge-base/security-create-local-groups/

4. Rights assignment to each Active Directory Group. https://www.transpara.com/knowledge-base/visual-kpi-object-level-security/

## Who Sees What?

Rights assignment can be managed globally or locally. In other words, a security group can have access to everything or only certain portions of the Visual KPI site.
Expand All @@ -47,6 +37,4 @@ Unfortunately, one of the greatest threats to your sensitive data could come fro

## Get Started with Visual KPI Security and Encryption

Setting up security and encryption in Visual KPI is straightforward when you use Visual KPI Server Manager integrated with IIS Manager.

If you just need the basic steps, read the Security Quickstart (https://www.transpara.com/knowledge-base/enable-security/), which includes links to more detailed steps. If you're not comfortable following the Quickstart and really need a deep dive into Visual KPI security, follow the articles below (preferably in order) to learn how security works in Visual KPI and how to set it up for your system.
Setting up security and encryption in Visual KPI is straightforward when you use Visual KPI Server Manager integrated with IIS Manager. Learn more about how Visual KPI security works with the [Security Inheritance](/docs/setup-and-administration/security/security-inheritance) guide or [Enable Security](/docs/setup-and-administration/security/enable-security) with our step-by-step guide.
Loading