Start working on the V6 content

README.md

@@ -1,6 +1,6 @@
 # Visual KPI Documentation
 
-Welcome to the Visual KPI Documentation repository. This documentation project is powered by Docusaurus, providing a user-friendly and organized platform for learning and reference.
+Welcome to the Visual KPI Documentation repository. This documentation project is powered by Docusaurus, providing a user-friendly and organized platform for learning and reference. 
 
 ## Table of Contents
 

transpara-v6/.sidebar/dashboards/index.js

@@ -0,0 +1,17 @@
+module.exports = [
+    {
+      type: 'doc',
+      id: 'dashboards/dashboards',
+      label: 'Dashboards'
+    },
+    {
+      type: 'doc',
+      id: 'dashboards/how-to-create-a-dashboard',
+      label: 'How to Create a Dashboard'
+    },
+    {
+      type: 'doc',
+      id: 'dashboards/differences-between-v5-and-v6',
+      label: 'Differences Between v5 and v6'
+    }
+  ]

transpara-v6/.sidebar/getting-started/index.js

@@ -1,6 +1,44 @@
 module.exports = [
   {
     type: 'doc',
-    id: 'what-is-transpara',
+    id: 'getting-started/what-is-transpara',
+    label: 'What is Transpara?'
+  },
+  {
+    type: 'doc',
+    id: 'getting-started/transpara-approach',
+    label: 'The Transpara Approach'
+  },
+  {
+    type: 'doc',
+    id: 'getting-started/how-transpara-works',
+    label: 'How Transpara Works'
+  },
+  {
+    type: 'doc',
+    id: 'getting-started/how-to-use-the-documentation',
+    label: 'How to Use the Documentation'
+  },
+  {
+    type: 'category',
+    label: "Core Concepts",
+    link: {
+      type: 'doc',
+      id: 'getting-started/core-concepts/core-concepts',
+    },
+    items: [
+      'getting-started/core-concepts/kpi',
+      'getting-started/core-concepts/hierarchy',
+      'getting-started/core-concepts/design',
+      'getting-started/core-concepts/data-sources',
+      'getting-started/core-concepts/interfaces',
+      'getting-started/core-concepts/access-level',
+
+    ],
+  },
+  {
+    type: 'doc',
+    id: 'getting-started/how-to-migrate-to-transpara',
+    label: 'How to Migrate to Transpara'
   },
 ]

transpara-v6/.sidebar/index.js

@@ -1,7 +1,9 @@
 const gettingStarted = require('./getting-started');
+const dashboards = require('./dashboards');
 const tcalc = require('./tcalc');
 
 module.exports = {
   gettingStarted,
+  dashboards,
   tcalc
 };

transpara-v6/.sidebar/tcalc/index.js

@@ -9,6 +9,11 @@ module.exports = [
     id: 'tcalc/how-tcalc-works',
     label: 'How tCalc Works',
   },
+  {
+    type: 'doc',
+    id: 'tcalc/how-to-use-tcalc',
+    label: 'How to Use tCalc',
+  },
   {
     type: 'doc',
     id: 'tcalc/tcalc-glossary',

transpara-v6/docs/dashboards/dashboard-comments.mdx

@@ -0,0 +1,11 @@
+---
+id: dashboard-comments
+title: Dashboard Comments
+slug: /dashboard-comments
+description: 'Learn the basics about the dashboard comments.'
+tags: ['dashboards']
+---
+
+You can add a comment to anything in a Dashboard. That includes any Object inside the Dashboard, as well as the Dashboard itself. These comments will be on a thread and anyone with access can respond.
+
+For example, if there are 3 KPIs in the red, you can add a comment directly on the Dashboard asking "Why are those on the red this morning?"

transpara-v6/docs/dashboards/dashboards.mdx

@@ -0,0 +1,43 @@
+---
+id: dashboards
+title: Dashboards
+slug: /dashboards
+description: 'Learn the basics about the dashboards.'
+tags: ['dashboards']
+---
+
+## Basic Features [rethink this title]
+
+At the top of the Dashboard, you will see the Dashboard's name, a lock symbol (if the Dashboard is locked), the **Edit Mode** button, the other options button (...), the **Add Widget** button, the **Reset** button, the **Save** button, and the dropdown arrow for more options.
+
+### Other Options (...)
+
+Clicking on the (...) button, you will see a drop-down menu with the following options:
+
+1. **Create Ad Hoc Trend**
+2. **Mark as Favorite**
+3. **Set as Default Dashboard**
+4. **Add to Bookmark Bar**
+5. **Lock Dashboard**
+6. **Dashboard Settings**
+7. **Delete**
+
+### Add Widget
+
+Clickin on **Add Widget**, you will see a drop-down menu with the following options:
+
+1. **Dashboard Link**
+2. **Custom Link**
+3. **Text Block**
+4. **Image Block**
+5. **Video**
+6. **Divider**
+
+## Time Ranges
+
+Time ranges can be defined for each added Object, or for the entire Dashboard (through the Designer). The time range can be overridden by clicking on the calendar icon, at the top right corner of the Dashboard screen and selecting a time range.  If you do that, all the objects in the Dashboard will appear with that time range.
+
+When adding a new object to the Dashboard, it will preserve the selected time range. For example, if you are looking at a Trend for 10 minutes period, 2 weeks ago, and you add that to the Dashboard, it will maintain that time range configuration.
+
+[comment]: # (Check if the time will always be that specific time in that one day, or if it wil "walk" once the day moves, for example, two days from now, the 10 min period will be the the same or it will be two weeks before that day.)
+

transpara-v6/docs/dashboards/differences-between-v5-and-v6.mdx

@@ -0,0 +1,24 @@
+---
+id: differences-between-v5-and-v6
+title: Differences Between v5 and v6
+slug: /differences-between-v5-and-v6
+description: 'Learn the differences between v5 and v6 dashboards.'
+tags: ['dashboards']
+---
+
+- **Delete Dashboards**: If the user created a Dashboard, they can delete it. Previously only the Designer had the power to delete Dashboards.
+
+## Dashboard Hierarchy
+
+Dashboards in V6 are no longer isolated objects but can exist within a hierarchy. This allows dashboards to be associated with specific groups or sites, improving navigation and organization. For example:
+
+- Dashboards can belong to a specific region or site.
+- Users can access dashboards relevant to their context without excessive scrolling or searching.
+
+## Editing in Context
+
+In v6, you can edit a Dashboard while still seeing its contents.
+
+## KPI Positioning in Different Sizes
+
+you can set up things to be in the same container, so that when the size of the screen goes down, specific things remain together.

transpara-v6/docs/dashboards/how-to-copy-a-dashboard.mdx

@@ -0,0 +1,11 @@
+---
+id: how-to-copy-a-dashboard
+title: How to Copy a Dashboard
+slug: /how-to-copy-a-dashboard
+description: 'Learn how to copy a dashboard.'
+tags: ['dashboards']
+---
+
+Another way of creating a Dashboard is by copying or duplicating an existing Dashboard. In the sidebar, to the left, you will see a **Create New** button at the bottom of the Dashboards section. You can click on it to create a new Dashboard or a copy of an existing Dashboard. For duplicating an existing Dashboard, you will have to select the option **Copy Existing Dashboard** and then select the Dashboard you wish to copy from the drop-down list. You can also search by name, which is especially useful if you have many Dashboards.
+
+You must select a Profile to which the new Dashboard will be linked, give it a name and, if you wish, give it a description. After that is done, you can click **Add** to create the new Dashboard.

transpara-v6/docs/dashboards/how-to-create-a-dashboard.mdx

@@ -0,0 +1,21 @@
+---
+id: how-to-create-a-dashboard
+title: How to Create a Dashboard
+slug: /how-to-create-a-dashboard
+description: 'Learn how to create a dashboard.'
+tags: ['dashboards']
+---
+
+To create a Dashboard, follow these steps:
+
+1. Find an object that you would like to add to you Dashboard, such as a Trend, Chart, or KPI.
+
+2. With the desired object opened, click on the configurations button, on the top right corner.
+
+3. In this menu you will see the options to **Add to current Dashboard**, **Create New Dashboard with This**, and **Add to Existing Dashboard**.
+
+## Copy Dashboard
+
+Another way of creating a Dashboard is by copying or duplicating an existing Dashboard. In the sidebar, to the left, you will see a **Create New** button at the bottom of the Dashboards section. You can click on it to create a new Dashboard or a copy of an existing Dashboard. For duplicating an existing Dashboard, you will have to select the option **Copy Existing Dashboard** and then select the Dashboard you wish to copy from the drop-down list. You can also search by name, which is especially useful if you have many Dashboards.
+
+You must select a Profile to which the new Dashboard will be linked, give it a name and, if you wish, give it a description. After that is done, you can click **Add** to create the new Dashboard.

transpara-v6/docs/dashboards/how-to-edit-a-dashboard.mdx

@@ -0,0 +1,8 @@
+---
+id: how-to-edit-a-dashboard
+title: How to Edit a Dashboard
+slug: /how-to-edit-a-dashboard
+description: 'Learn how to edit a dashboard.'
+tags: ['dashboards']
+---
+

transpara-v6/docs/dashboards/how-to-share-a-dashboard.mdx

@@ -0,0 +1,9 @@
+---
+id: how-to-share-a-dashboard
+title: How to Share a Dashboard
+slug: /how-to-share-a-dashboard
+description: 'Learn how to share a dashboard.'
+tags: ['dashboards']
+---
+
+You can select an user from a drop-down menu or copy a link to send directly to someone with access. You can select wether to share only as a viewer or as an editor.

transpara-v6/docs/dashboards/public-and-private-dashboards.mdx

@@ -0,0 +1,9 @@
+---
+id: public-and-private-dashboards
+title: Public and Private Dashboards
+slug: /public-and-private-dashboards
+description: 'Learn the basics about public and private dashboards.'
+tags: ['dashboards']
+---
+
+Public vs. Private Dashboards

transpara-v6/docs/getting-started/core-concepts/access-level.mdx

@@ -0,0 +1,31 @@
+---
+id: access-level
+title: Access Levels
+slug: /core-concepts/access-level
+description: 'Describes how security works when working with Transpara and presents the access levels concepts.'
+tags: ['Security', 'Object-level Security', 'Access levels']
+---
+
+**OLD TEXT, USED AS A HOLDER**
+
+Data security is a top priority for Transpara. Various security measures are in place to safeguard your data at all process stages. From safely integrating data sources to presenting KPIs on the Transpara dashboard, you can choose who can access what type of data and function.
+
+## Object-level security
+
+Transpara implements object-level security for its sites, allowing you to tailor the security model and level of detail to your organization's needs. This involves creating user groups and assigning different access levels to each group. Since access permissions are defined at the object level, end-users won't notice any differences in the interface. Object-level security access groups are set up using the Visual KPI Designer.
+
+The process for defining different access levels involves three simple steps:
+
+1. Create local user groups.
+2. Enable object-level security.
+3. Assign different access levels to KPIs and Objects for the previously created groups.
+
+As a result, KPIs and groups that aren't part of a user's access level won't appear on the screen. Consequently, user groups with different access levels can access the same dashboard but view different KPIs in their browser, ensuring the data is available only to those who should have access to it.
+
+## What's next?
+
+Now that you have covered all the core concepts of the Transpara, it is time to check the specific content for your role. If you aren't familiar with the documentation organization, access the [how-to-use-the-documentation](/docs/how-to-use-the-documentation). Otherwise, you can see the specific section for each use type:
+
+- Setup and Administration
+- Transpara Design
+- End User

transpara-v6/docs/getting-started/core-concepts/core-concepts.mdx

@@ -0,0 +1,31 @@
+---
+id: core-concepts
+title: Core concepts
+slug: /core-concepts
+description: 'Learn about the core concepts related to Transpara.'
+tags: ['documentation']
+---
+
+**OLD TEXT, USED AS A HOLDER**
+
+In this section, you can learn the essential ideas to become a pro at using Transpara. These concepts lay the groundwork for a better understanding of the software, making it easier to get started.
+
+## Main concepts 
+
+- **[KPI (Key Performance Indicators)](./core-concepts/kpi)**: KPIs are metrics used to measure the performance of critical activities. They represent specific data points or indicators indispensable for tracking and evaluating how well an organization is meeting its goals. KPIs are essential tools for decision-makers, providing insights into performance trends and guiding strategic adjustments based on real-time data.
+
+- **[Hierarchy/Groups](./core-concepts/hierarchy)**: Hierarchy and Groups are different ways of referring to Transpara's organization model. Hierarchy is basically a system of Groups that allows you to organize and categorize your KPIs, similar to your computer's folders. The Groups visualization shows data in various colors, indicating the KPIs' status and allowing easy data visualization.
+
+- **[Design and authoring](./core-concepts/design)**: This part of Transpara involves configuring key objects like Groups, KPIs, Charts, and Tables. Transpara 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 Transpara, "Data Sources" refers to the locations and origins of data that the system accesses and uses 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 Transpara system.
+
+-  **[Interfaces](./core-concepts/interfaces)**:  Interfaces in Transpara 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.
+
+-  **[Access Levels](./core-concepts/access-level)**: Access levels in the context of KPI systems refer to the permissions and restrictions applied to users or roles within the system. Access levels determine what users can see and do within the KPI system, ensuring data security and integrity, efficiency, usability, and compliance.
+
+## What's Next?
+
+If you want to recap the basic concepts of the Transpara, you can read our topic [What is Transpara](/docs/getting-started/what-is-transpara).
+
+To continue your journey with Transpara documentation, we suggest you access the core concepts subpages.

transpara-v6/docs/getting-started/core-concepts/data-sources.mdx

@@ -0,0 +1,43 @@
+---
+id: data-sources
+title: Data Sources
+slug: /core-concepts/data-sources
+description: 'Presents the definition of data sources and how they are used with the Transpara system.'
+tags: ['Data sources']
+---
+
+import StylizedImage from '@site/src/components/StylizedImage/StylizedImage';
+
+**OLD TEXT, USED AS A HOLDER**
+
+The data presented on Transpara doesn't require a dedicated storage system. Transpara doesn't require you to move your data from the server or cloud system you are currently using. Transpara will consider all systems used by your company as data sources from which to retrieve information. Rather than migrating data into a new centralized repository, Transpara communicates with these diverse sources, eliminating the need for data duplication and making management more straightforward.
+
+This enables Transpara to access near real-time data, providing up-to-the-minute information with added context, color, status indicators, and meaningful insights. By interfacing with different data sources, Transpara ensures you're always working with the latest data without the hassle of manual updates or migration.
+
+<StylizedImage
+  imgURL="img\core-concepts\data-sources\data-sources.png"
+  alt="Data sources available"
+/>
+
+
+## Types of data sources
+
+Transpara provides comprehensive support for various data source types, requiring specialized [interfaces](./interfaces) for each source. These data sources can be categorized into several classes. A summary of the many data sources available for integration with Transpara is listed below: 
+
+- **Industrial and enterprise historians**, like OSIsoft PI, GE Proficy, Rockwell, Honeywell, and more.
+- **Relational databases**, such as Microsoft SQL Server, Oracle, MySQL, and Access.
+- **External web services**, which may provide data like weather conditions, market pricing, and supplier information through an API.
+- **Manual data entries** via Excel, form applications, or directly within Transpara.
+- **Business applications**, including ERP, CRM, and specialized industry software.
+- **Data obtained from devices** like sensors, IoT, IIoT, and control systems (DCS/PLC).
+
+Transpara continuously interacts with data sources, ensuring a near real-time experience and eliminating the need for manual page-refreshing to access the most current data.
+
+## Data sources requirements
+
+Different data sources may require different processes to integrate with Transpara and recover data in real time. This involves understanding whether data must be retrieved from external systems or databases. However, the Transpara team is always ready to assist you. If you use a database different from those listed above, don't worry, the Transpara team can adapt it to ensure it works seamlessly with Transpara.
+
+## What's next?
+
+As a next step, we encourage you to access the [Interfaces](./interfaces) page to learn how different databases are connected to Transpara.
+