Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Visual KPI Designer #41

Merged
merged 36 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
6d2448f
docs: Visual Designer update
Feb 12, 2024
a90fd34
docs: Visual Designer Update
Feb 14, 2024
c130f1a
Merge branch 'main' into 22-sprint-2-visual-kpi-designer
htessaro Feb 19, 2024
9e4b37f
docs: designer - update overview
htessaro Feb 19, 2024
b0d82ed
docs: overview - update content
htessaro Feb 19, 2024
7281535
doc: update instalation and setup
htessaro Mar 1, 2024
1542ab6
doc: update overview and ui-tour designer
htessaro Mar 7, 2024
ac613e8
Merge branch 'main' into 22-sprint-2-visual-kpi-designer
htessaro Mar 7, 2024
fb416e4
feat: update the CardList componet.
htessaro Mar 14, 2024
3754d0d
docs: add an overview page to the instalation content of Designer
htessaro Mar 14, 2024
0b621de
docs: updates overview authoring
htessaro Mar 18, 2024
40b12ba
Merge branch 'main' into 22-sprint-2-visual-kpi-designer
htessaro Mar 18, 2024
7ef2108
docs: update profiles-dashboards
htessaro Apr 1, 2024
fb6b762
Merge branch 'main' into 22-sprint-2-visual-kpi-designer
htessaro Apr 11, 2024
eba151d
docs: create data-limit refere pages for visual-kpi-designer
htessaro Apr 12, 2024
662eeac
docs: add the website-configuration to reference pages
htessaro Apr 12, 2024
b5d4aa0
docs: updates contracts-alerts page
htessaro Apr 12, 2024
001d695
fix: table CSS customization
gabrielraeder Apr 12, 2024
745649d
fix: table column width
gabrielraeder Apr 12, 2024
d9f6062
fix: prev/next buttons
gabrielraeder Apr 12, 2024
fb50a93
style: update selector
htessaro Apr 15, 2024
5eb1ffb
chore: creates functions inputs jsons
gabrielraeder Apr 15, 2024
17fb407
docs: add attributes-and-keywords reference pages
htessaro Apr 15, 2024
746e9b2
Merge branch '22-sprint-2-visual-kpi-designer' of https://github.com/…
htessaro Apr 15, 2024
a071a62
chore: adds methods jsons
gabrielraeder Apr 15, 2024
1ea067d
style: css to overflow table content
gabrielraeder Apr 15, 2024
ca6a644
Merge branch '22-sprint-2-visual-kpi-designer' of https://github.com/…
gabrielraeder Apr 15, 2024
10fde5f
docs: update visual-kpi-designer reference tables
htessaro Apr 17, 2024
e05da55
docs: update visual kpi designer reference page
htessaro Apr 17, 2024
c6b8702
Merge branch '22-sprint-2-visual-kpi-designer' of https://github.com/…
htessaro Apr 17, 2024
e0461b6
docs: update visual-kpi-designer-references
htessaro Apr 17, 2024
d95f9b3
docs: hide page with no content
htessaro Apr 17, 2024
1b5aca9
feat: updates JsonToTable component to add rowspan in first column wh…
gabrielraeder Apr 17, 2024
492b6b4
docs: update setup-and-administration overview
htessaro Apr 17, 2024
5d02c55
docs: fix style mistakes
htessaro Apr 17, 2024
b974bc6
chore: fix errors
htessaro Apr 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion .github/styles/Vocab/Doc/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ sparkline
KPI's
Exton
Gantt
sitewide
sitewide
Unselect
10 changes: 9 additions & 1 deletion .github/styles/config/vocabularies/Doc/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Proficy
Exton
Gantt
sitewide
Unselect
pulldown
timeseries
downsampled
stddev
Expand Down Expand Up @@ -76,4 +78,10 @@ Cognite
SQLuser
projectware
picosecond
lossy
lossy
inmation
walkthrough
toolset
timeframes
Rollups
rollups
7 changes: 6 additions & 1 deletion .github/styles/config/vocabularies/docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Proficy
Exton
Gantt
sitewide
Unselect
pulldown
timeseries
downsampled
stddev
Expand Down Expand Up @@ -76,4 +78,7 @@ Cognite
SQLuser
projectware
picosecond
lossy
lossy
inmation
walkthrough
toolset
File renamed without changes.
104 changes: 87 additions & 17 deletions visual-kpi-docs/.sidebar/designer/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,29 @@ module.exports = [
// className: '',
link: {
type: 'doc',
id: 'visual-kpi-design/installation-and-setup/installation',
id: 'visual-kpi-design/installation-and-setup/overview',
},
items: [
'visual-kpi-design/installation-and-setup/installation',
'visual-kpi-design/installation-and-setup/setup-and-connection',
'visual-kpi-design/installation-and-setup/visual-kpi-designer-ui',
'visual-kpi-design/installation-and-setup/connecting',
'visual-kpi-design/installation-and-setup/ui-tour',
'visual-kpi-design/installation-and-setup/basic-setup',
],
},

{
type: 'category',
label: "Authoring",
// className: '',
link: {
type: 'doc',
id: 'visual-kpi-design/authoring/authoring',
id: 'visual-kpi-design/authoring/overview',
},
items: [
'visual-kpi-design/authoring/default-settings',
'visual-kpi-design/authoring/manage-objects',
'visual-kpi-design/authoring/profiles-dashboards',
'visual-kpi-design/authoring/contacts-alerts',
'visual-kpi-design/authoring/features-config',
'visual-kpi-design/authoring/advanced',
],
},
{
Expand All @@ -38,23 +42,89 @@ module.exports = [
// className: '',
link: {
type: 'doc',
id: 'visual-kpi-design/design/design',
id: 'visual-kpi-design/design/overview',
},
items: [
'visual-kpi-design/design/create-a-kpi',
'visual-kpi-design/design/create-an-spc',
'visual-kpi-design/design/create-a-chart',
'visual-kpi-design/design/create-a-trend',
'visual-kpi-design/design/create-a-table',
'visual-kpi-design/design/create-a-group',
'visual-kpi-design/design/create-navbar-links',
'visual-kpi-design/design/target-and-limit-generator',

{
type: 'category',
label: "Groups",
//className: '',
link: {
type: 'doc',
id: 'visual-kpi-design/design/groups',
},
items: [
'visual-kpi-design/design/query-builder',
'visual-kpi-design/design/group-maps',
],
},

{
type: 'category',
label: "KPIs",
//className: '',
link: {
type: 'doc',
id: 'visual-kpi-design/design/kpis',
},
items: [
'visual-kpi-design/design/kpis-sources',
'visual-kpi-design/design/spc-kpis',
'visual-kpi-design/design/kpis-trends',
],
},

{
type: 'category',
label: "Charts",
//className: '',
link: {
type: 'doc',
id: 'visual-kpi-design/design/charts',
},
items: [
'visual-kpi-design/design/bar-chart',
'visual-kpi-design/design/gantt-chart',
'visual-kpi-design/design/pareto-chart',
'visual-kpi-design/design/pie-chart',
'visual-kpi-design/design/xy-plots',
'visual-kpi-design/design/query-based-chart',
'visual-kpi-design/design/box-plots',
],
},

'visual-kpi-design/design/tables',
'visual-kpi-design/design/trends',

],
},
{
// {
// type: 'category',
// label: "Reference Tables",
// // className: '',
// link: {
// type: 'doc',
// id: 'visual-kpi-design/reference-tables',
// },
// items: [
// 'visual-kpi-design/reference-tables/website-reference',
// 'visual-kpi-design/reference-tables/profiles-dashboards-reference',
// 'visual-kpi-design/reference-tables/ranges-dates-reference',
// 'visual-kpi-design/reference-tables/contacts-alerts-reference',
// 'visual-kpi-design/reference-tables/features-configuration-reference',
// 'visual-kpi-design/reference-tables/advanced-reference',
// 'visual-kpi-design/reference-tables/groups-reference',
// 'visual-kpi-design/reference-tables/kpis-reference',
// 'visual-kpi-design/reference-tables/charts-reference',
// 'visual-kpi-design/reference-tables/tables-reference',
// 'visual-kpi-design/reference-tables/functions-reference',
// ],
// },
/*{
type: 'doc',
id: 'visual-kpi-design/best-practices',
// label: 'How to Use the Documentation',
// className: '',
}
},*/
]
80 changes: 78 additions & 2 deletions visual-kpi-docs/.sidebar/reference-guides/index.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
module.exports = [
{
/*{
type: 'doc',
id: 'references/references',
label: 'References',
},
},*/
{
type: 'category',
label: "Setup and Administration",
Expand Down Expand Up @@ -35,4 +35,80 @@ module.exports = [
},
],
},
{
type: 'category',
label: "Visual KPI Designer",
link: {
type: 'doc',
id: 'references/visual-kpi-designer/visual-kpi-designer-references',
},
items: [
{
type: 'category',
label: "Data Limits",
items: [
'references/visual-kpi-designer/data-limits/data-limits-for-attributes',
'references/visual-kpi-designer/data-limits/data-limits-for-default-ranges',
'references/visual-kpi-designer/data-limits/data-limits-for-groups',
'references/visual-kpi-designer/data-limits/data-limits-for-interfaces',
'references/visual-kpi-designer/data-limits/data-limits-for-kpis',
'references/visual-kpi-designer/data-limits/data-limits-for-links',
'references/visual-kpi-designer/data-limits/data-limits-for-trend-ranges',
'references/visual-kpi-designer/data-limits/data-limits-for-trends',
'references/visual-kpi-designer/data-limits/data-limits-for-website-configuration'
],
},
/*{
type: 'doc',
id: 'references/visual-kpi-designer/groups-attributes-keywords/groups-attributes-keywords',
},*/
{
type: 'category',
label: "Attributes & Keywords",
items: [
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-bar-charts',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-embedded-content',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-gantt-charts',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-groups',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-kpis',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-managed-trends',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-pareto-charts',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-pie-charts',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-tables',
'references/visual-kpi-designer/attributes-and-keywords/attributes-and-keywords-xy-plots'
],
},
{
type: 'category',
label: "Site Settings",
items: [
'references/visual-kpi-designer/site-settings/site-settings-alerts',
'references/visual-kpi-designer/site-settings/site-settings-chart-color',
'references/visual-kpi-designer/site-settings/site-settings-chart-dates',
'references/visual-kpi-designer/site-settings/site-settings-chart-ranges',
'references/visual-kpi-designer/site-settings/site-settings-contacts',
'references/visual-kpi-designer/site-settings/site-settings-dashboards',
'references/visual-kpi-designer/site-settings/site-settings-default-ranges',
'references/visual-kpi-designer/site-settings/site-settings-event-ranges',
'references/visual-kpi-designer/site-settings/site-settings-features',
'references/visual-kpi-designer/site-settings/site-settings-kpi-status',
'references/visual-kpi-designer/site-settings/site-settings-profile-groups',
'references/visual-kpi-designer/site-settings/site-settings-profiles',
'references/visual-kpi-designer/site-settings/site-settings-visual-kpi-website',
],
},
{
type: 'category',
label: "Advanced Site Settings",
items: [
'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-attributes',
'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-interfaces',
'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-nav-bar-links',
'references/visual-kpi-designer/advanced-site-settings/advanced-site-settings-site-rollups'
],
},

],
},

]
6 changes: 3 additions & 3 deletions visual-kpi-docs/.sidebar/setup-adm/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ module.exports = [
},
installation,
interfaces,
automation,
{
//automation,
/*{
type: 'doc',
id: 'setup-and-administration/best-practices',
},
},*/
];
4 changes: 2 additions & 2 deletions visual-kpi-docs/.sidebar/supporting-pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = [
id: 'supporting-pages/faqs',
label: 'FAQs',
},
{
/*{
type: 'doc',
id: 'supporting-pages/troubleshooting',
label: 'Troubleshooting',
Expand All @@ -13,7 +13,7 @@ module.exports = [
type: 'doc',
id: 'supporting-pages/training',
label: 'Training',
},
},*/
{
type: 'doc',
id: 'supporting-pages/glossary',
Expand Down
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/core-concepts/core-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: core-concepts
title: Core concepts
slug: /core-concepts
description: 'Learn about the core concepts related to Transpara Visual KPI.'
tags: []
tags: ['documentation']
---

In this section, you can learn the essential ideas to become a pro at using Visual KPI. These concepts lay the groundwork for a better understanding of the software, making it easier to get started.
Expand Down
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/core-concepts/hierarchy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: hierarchy
title: Hierarchy/Groups
slug: /core-concepts/hierarchy
description: 'Define and describe how hierarchy works inside Visual KPI.'
tags: []
tags: ['documentation']
---

import StylizedImage from '@site/src/components/StylizedImage/StylizedImage';
Expand Down
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 @@ -3,7 +3,7 @@ id: kpi
title: KPI
slug: /core-concepts/kpi
description: 'Define and describes what a kpi is.'
tags: []
tags: ['documentation']
---

import StylizedImage from '@site/src/components/StylizedImage/StylizedImage';
Expand Down
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/end-user/basic-navigation/time.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You can use offset time, which means that you call data based on a specific time

You can keep it simple or make it as sophisticated as you want when using Visual KPI's relative time functions. Using the symbol for "now"(*) as your end time, the right edge of your trends will show the most recent value available from your data source for that item. If you use the function "y" as your end time, the right edge of your trend will show the most recent value before midnight yesterday. The same is true for start times.

You can also combine functions to get something crazy (or powerful, if you prefer), like a start time defined as "go back 12 days, then show the beginning of whatever month that is, and then show what the value was at noon on that day." Using relative time functions in Visual KPI, that would be represented as `noon(bom(*-2d)).`
You can also combine functions to get something crazy (or powerful, if you prefer), like a start time defined as "go back 12 days, then show the beginning of whatever month that's, and then show what the value was at noon on that day." Using relative time functions in Visual KPI, that would be represented as `noon(bom(*-2d)).`

Here are some examples of how you can combine relative time functions:
- Beginning of this month = bom(*)
Expand Down
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/end-user/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: overview
title: End Users
slug: overview
description: 'The End User documentation section will guide you on how to use the Visual KPI solution.'
tags: []
tags: ['documentation']
---

The Visual KPI End-User Guide was designed specifically for new users to help you navigate and make the most out of your Visual KPI software. This guide aims to provide a comprehensive understanding of Visual KPI features, functionalities, and how to effectively use the application to monitor, analyze, and manage your KPIs in real-time. Here, you'll learn what Visual KPI is, its capabilities, and how it can transform your data into actionable insights. Transpara's Visual KPI software offers comprehensive features and functionalities for end-users, such as dashboards, trends, and many visualization options. It's a user-friendly interface with robust tools for working with all kinds of KPIs.
Expand Down
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/get-started/access-level.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ id: access-level
title: Access Levels
slug: /get-started/access-level
description: ''
tags: []
tags: ['documentation']
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ id: data-update-and-timestamp
title: Data Update and Timestamp
slug: /get-started/data-update-and-timestamp
description: ''
tags: []
tags: ['documentation']
---
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/get-started/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ id: navigation
title: Navigation
slug: /get-started/navigation
description: ''
tags: []
tags: ['documentation']
---
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/get-started/notifications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ id: notifications
title: Notifications
slug: /get-started/notifications
description: ''
tags: []
tags: ['documentation']
---
2 changes: 1 addition & 1 deletion visual-kpi-docs/docs/get-started/objects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ id: objects
title: Objects
slug: /get-started/objects
description: ''
tags: []
tags: ['documentation']
---
Loading