diff --git a/README.md b/README.md index f92b2323..83c4919f 100644 --- a/README.md +++ b/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 diff --git a/transpara-v6/.sidebar/dashboards/index.js b/transpara-v6/.sidebar/dashboards/index.js new file mode 100644 index 00000000..b2e48e23 --- /dev/null +++ b/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' + } + ] \ No newline at end of file diff --git a/transpara-v6/.sidebar/getting-started/index.js b/transpara-v6/.sidebar/getting-started/index.js index 1476dffb..3c43e73b 100644 --- a/transpara-v6/.sidebar/getting-started/index.js +++ b/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' }, ] \ No newline at end of file diff --git a/transpara-v6/.sidebar/index.js b/transpara-v6/.sidebar/index.js index 88777e32..f63f44f5 100644 --- a/transpara-v6/.sidebar/index.js +++ b/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 }; diff --git a/transpara-v6/.sidebar/tcalc/index.js b/transpara-v6/.sidebar/tcalc/index.js index f7b3cfdc..55bada67 100644 --- a/transpara-v6/.sidebar/tcalc/index.js +++ b/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', diff --git a/transpara-v6/docs/dashboards/dashboard-comments.mdx b/transpara-v6/docs/dashboards/dashboard-comments.mdx new file mode 100644 index 00000000..2b26adb3 --- /dev/null +++ b/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?" \ No newline at end of file diff --git a/transpara-v6/docs/dashboards/dashboards.mdx b/transpara-v6/docs/dashboards/dashboards.mdx new file mode 100644 index 00000000..7a61b653 --- /dev/null +++ b/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.) + diff --git a/transpara-v6/docs/dashboards/differences-between-v5-and-v6.mdx b/transpara-v6/docs/dashboards/differences-between-v5-and-v6.mdx new file mode 100644 index 00000000..ebb13d5c --- /dev/null +++ b/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. \ No newline at end of file diff --git a/transpara-v6/docs/dashboards/how-to-copy-a-dashboard.mdx b/transpara-v6/docs/dashboards/how-to-copy-a-dashboard.mdx new file mode 100644 index 00000000..af5b3bec --- /dev/null +++ b/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. \ No newline at end of file diff --git a/transpara-v6/docs/dashboards/how-to-create-a-dashboard.mdx b/transpara-v6/docs/dashboards/how-to-create-a-dashboard.mdx new file mode 100644 index 00000000..a81bcf0a --- /dev/null +++ b/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. \ No newline at end of file diff --git a/transpara-v6/docs/dashboards/how-to-edit-a-dashboard.mdx b/transpara-v6/docs/dashboards/how-to-edit-a-dashboard.mdx new file mode 100644 index 00000000..dce711b0 --- /dev/null +++ b/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'] +--- + diff --git a/transpara-v6/docs/dashboards/how-to-share-a-dashboard.mdx b/transpara-v6/docs/dashboards/how-to-share-a-dashboard.mdx new file mode 100644 index 00000000..bdf3d530 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/transpara-v6/docs/dashboards/public-and-private-dashboards.mdx b/transpara-v6/docs/dashboards/public-and-private-dashboards.mdx new file mode 100644 index 00000000..b6f51df7 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/transpara-v6/docs/getting-started/core-concepts/access-level.mdx b/transpara-v6/docs/getting-started/core-concepts/access-level.mdx new file mode 100644 index 00000000..cb3f5ccd --- /dev/null +++ b/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 \ No newline at end of file diff --git a/transpara-v6/docs/getting-started/core-concepts/core-concepts.mdx b/transpara-v6/docs/getting-started/core-concepts/core-concepts.mdx new file mode 100644 index 00000000..0ea2df21 --- /dev/null +++ b/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. diff --git a/transpara-v6/docs/getting-started/core-concepts/data-sources.mdx b/transpara-v6/docs/getting-started/core-concepts/data-sources.mdx new file mode 100644 index 00000000..2208b889 --- /dev/null +++ b/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. + + + + +## 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. + diff --git a/transpara-v6/docs/getting-started/core-concepts/design.mdx b/transpara-v6/docs/getting-started/core-concepts/design.mdx new file mode 100644 index 00000000..8944a082 --- /dev/null +++ b/transpara-v6/docs/getting-started/core-concepts/design.mdx @@ -0,0 +1,40 @@ +--- +id: design +title: Design and Authoring +slug: /core-concepts/design +description: 'Covers the definition of the designer role and their responsabilies.' +tags: ['Transpara Designer'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; + +**OLD TEXT, USED AS A HOLDER** + +In Transpara, **Design and Authoring** involves configuring vital components within the system. These components encompass Groups, KPIs, Charts, and Tables. Designing consists of configuring the KPIs, which information they show, and how they show them. Authoring means configuring Transpara's site and what each End User can access. + + +The Transpara Designer is the tool that helps with both these processes. It is an Excel add-in that offers versatility for various tasks, from prototypes to large-scale systems. Administrators wield the authority to manage links, ensuring streamlined user access to critical resources. + +## Transpara Designer integration + +The Transpara Designer works inside Excel as an add-in for defining Transpara metadata or attributes. For this reason, you'll need to have version 2007 of Excel or newer when you install Transpara Designer. We recommend using Excel versions 2013 or 2016. See the [system requirements and software prerequisites](https://www.transpara.com/system-requirements/). + +## Configurable objects + +Objects are all the components that can compose the graphical interface of Transpara. The design process is divided into distinct sections: + +- **Basics**: Covers fundamental aspects like naming, descriptions, and grouping KPIs. +- **User Experience**: Involves customizing numeric formats and display settings to optimize the End User interface. +- **SPC (Statistical Process Control)**: Addresses the incorporation of statistical analysis and control into the dashboard. Its feature allows users to monitor data quality and deviations from control limits. SPC is crucial for maintaining quality standards and identifying anomalies in real-time. +- **Extended**: Enables the addition of information columns, links, and parameters to enhance object functionality. +- **Access Group List**: Administrators can create, manage, and organize links for users, ensuring easy access to critical resources. Here, the Administrator can define the object-level security settings. + +:::training Visual KPI Designer Training + +For more detailed guidance on utilizing the design and authoring features, you can refer to the Visual KPI documentation on Visual KPI Designer and take the [Visual KPI Designer Training](https://www.transpara.com/course/visual-kpi-designer/). + +::: + +## What's next? + +The design process in Transpara allows for in-depth customization, ensuring that the system aligns with your organization's specific needs. Whether for rapid prototypes or large-scale production systems, Transpara Designer, the central configuration tool for Transpara, provides the necessary tools and features to configure a functional system. Access the Transpara Design to learn more about the functionalities available for Design and Authoring. diff --git a/transpara-v6/docs/getting-started/core-concepts/hierarchy.mdx b/transpara-v6/docs/getting-started/core-concepts/hierarchy.mdx new file mode 100644 index 00000000..f47bd056 --- /dev/null +++ b/transpara-v6/docs/getting-started/core-concepts/hierarchy.mdx @@ -0,0 +1,34 @@ +--- +id: hierarchy +title: Hierarchy/Groups +slug: /core-concepts/hierarchy +description: 'Define and describe how hierarchy works inside Visual KPI.' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; + +**OLD TEXT, USED AS A HOLDER** + +In Transpara, **Hierarchy** refers to the organizational structure for categorizing and managing data elements. Similar to your computer's folder structure, it simplifies data navigation and organization, allowing you to rename and group different KPIs. For this reason, we use hierarchy and groups interchangeably to refer to the same feature. Also, the hierarchy organizes KPIs based on specific criteria defined by administrators. + +Hierarchy helps separate KPIs for specific locations, making navigation easier. Objects can have multiple parents, and KPI groups can be automated based on conditions such as status or other criteria. + +## Hierarchy organizational structure + +Transpara users interact with the software using profiles, dashboards, and hierarchical groups. This versatile structure offers automatic data aggregation, color-coded status indicators, and a quick performance overview. + +Within this hierarchy, you'll find KPIs, Charts, and Tables that structure your data and a summary view to show aggregated information at higher levels. Automatic color-coding indicates data status, simplifying the assessment of KPI proportions in different states. + +Regardless of quantity, groups in the hierarchy provide consolidated summaries of their contained elements. Users navigate through the hierarchy, exploring subgroups and accessing various data objects. In addition, groups adapt automatically based on attributes, ensuring organized and relevant data. It can be dynamic and automated based on attribute changes, making it a versatile system for data organization. + +## What's Next? + +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. + +::: + diff --git a/transpara-v6/docs/getting-started/core-concepts/interfaces.mdx b/transpara-v6/docs/getting-started/core-concepts/interfaces.mdx new file mode 100644 index 00000000..20c643d7 --- /dev/null +++ b/transpara-v6/docs/getting-started/core-concepts/interfaces.mdx @@ -0,0 +1,52 @@ +--- +id: interfaces +title: Interfaces +slug: /core-concepts/interfaces +description: 'Describes the Interfaces definition and how they are used to integrate different data sources to Transpara.' +tags: ['Interfaces'] +--- + +**OLD TEXT, USED AS A HOLDER** + +Transpara Interfaces serve as essential tools for fetching data from external systems. These interfaces are designed for read-only purposes, allowing End Users to retrieve data without the ability to modify it. Admins must only make this process once, unless the data source changes, and must choose the appropriate Interface type to meet their specific data access requirements. + +## Purpose of interfaces + +The primary goal of Interfaces is to adapt data from various sources and standardize it for use within the Transpara server. External data may come with different configurations or organization from that used by Transpara, requiring preparation to shape the data into a uniform collection. After an Administrator sets up an Interface, this data preparation occurs in real-time when the Transpara server receives updated information, ensuring that the external data is seamlessly translated for use by Transpara and presented to End Users. + +## Interface outputs + +An Interface should provide three fundamental data structures to ensure Transpara functions properly: + +- **Current Value**: Enables retrieval of the current KPI value. +- **Trend Data**: Users can retrieve a series of trend KPI values between two timestamps. +- **Historical Value**: Provides access to historical data at a specific time or before a given time. + +## Interface components + +To make data available, an Interface needs to be built with three main components: + +- **Connection to the Data Source**: Establishes a connection to the external data source. +- **Query System**: Reads requests and prepares received data for use within Transpara. +- **Security Systems**: Ensures authentication and prevents data leakage. + +## Integration process +The process to set up and use an Interface involves the following steps: + +1. Define the KPI, such as reactor temperature. +2. Specify the data source (Oracle Server, SQL, API, etc.) for the KPI. +3. Identify the specific data within the source that provides reactor temperature information. +4. Define the data querying method (SQL, API requests, etc.). +5. Perform data acquisition tests to standardize queries/requests. +6. Identify security and authentication actions required for data consumption. +7. Write the Interface code, a one-time process unless the data source is modified. + +## Next Steps + +Understanding Transpara Interfaces is crucial for understanding how data is captured and made available effectively. Refer to the [Interfaces](../setup-and-administration/interfaces) documentation for detailed guides on setting up Interfaces in Transpara. Additional training resources are available through the Transpara Interfaces Training. + +:::training Visual KPI Interfaces Training + +You also have the option to register and watch the [Visual KPI Interfaces Training](https://www.transpara.com/course/visual-kpi-interfaces/) which is available for free. + +::: diff --git a/transpara-v6/docs/getting-started/core-concepts/kpi.mdx b/transpara-v6/docs/getting-started/core-concepts/kpi.mdx new file mode 100644 index 00000000..e2713d86 --- /dev/null +++ b/transpara-v6/docs/getting-started/core-concepts/kpi.mdx @@ -0,0 +1,30 @@ +--- +id: kpi +title: KPI +slug: /core-concepts/kpi +description: 'Define and describes what a kpi is.' +tags: ['documentation'] +--- + +import StylizedImage from '@site/src/components/StylizedImage/StylizedImage'; + +**OLD TEXT, USED AS A HOLDER** + +KPI stands for **Key Performance Indicator**, a measurable value organizations use to evaluate their success in achieving specific business objectives. Simply put, it refers to something you consider important enough to monitor that should behave as expected. These KPIs, such as Key Metrics and Performance Indicators, are closely related to performance analysis. Each KPI is associated with specific data used to evaluate and measure various metrics that provide insights into multiple aspects of business performance. + +## How KPIs work on Transpara + +Transpara works by visually representing these KPIs in an easily understandable and accessible format. It collects data from diverse sources such as databases, applications, or other systems and then displays the information through intuitive visualizations like charts, graphs, or dashboards. + +Furthermore, KPIs are often color-coded to signify their status on Transpara, making it easy for users to quickly assess performance against expected standards. + +These indicators serve as a core element of the user experience, providing visual and meaningful insights into an organization's performance. Transpara is an assertive tool for organizations that provides a comprehensive and visually engaging representation of key metrics based on near real-time data. + +## What's next? +You can access the End User section for a more comprehensive understanding of how to utilize KPIs. + +:::training Visual KPI End-User Training + +You also have the option to register and watch the [End-User training](https://www.transpara.com/course/visual-kpi-end-user/) which is available for free. + +::: \ No newline at end of file diff --git a/transpara-v6/docs/getting-started/how-to-migrate-to-transpara.mdx b/transpara-v6/docs/getting-started/how-to-migrate-to-transpara.mdx new file mode 100644 index 00000000..e1c9084f --- /dev/null +++ b/transpara-v6/docs/getting-started/how-to-migrate-to-transpara.mdx @@ -0,0 +1,8 @@ +--- +id: how-to-migrate-to-transpara +title: How to Migrate to Transpara +slug: how-to-migrate-to-transpara +description: 'How to Migrate to Transpara' +--- + +Users familiar with Visual KPI will recognize most aspects of Transpara's UI. \ No newline at end of file diff --git a/transpara-v6/docs/getting-started/how-to-use-the-documentation.mdx b/transpara-v6/docs/getting-started/how-to-use-the-documentation.mdx new file mode 100644 index 00000000..d5defdc1 --- /dev/null +++ b/transpara-v6/docs/getting-started/how-to-use-the-documentation.mdx @@ -0,0 +1,45 @@ +--- +id: how-to-use-the-documentation +title: How to Use the Documentation +slug: /how-to-use-the-documentation +description: 'Learn about the user types and how to use Transpara documentation.' +tags: ['documentation'] +--- + +**OLD TEXT, USED AS A HOLDER** + +On this page, we describe the different Transpara user types and options available for them. From this page, we define the paths of specific content each user should cover to optimize their time and learning curve, focusing on what you need to accomplish your goals. + +## Transpara User Types + +The Transpara documentation aims to provide content in a tailored way for three user types: + +- **Administrator**: Administrators usually are from the IT team. They're responsible for the Transpara integration, covering the system preparation and installation. Administrators create or use existing interfaces to connect data sources to Transpara. In addition, if your company already has KPIs, the Administrator can use the automation tools provided by Transpara to import these KPIs into Transpara automatically. + +- **Designer**: The Designer manages the Transpara configuration, preparing the system for end users to consume the data. They use the Transpara Designer tool, a versatile Excel-based solution, to set up the system's appearance and behavior. The Designer is responsible for creating visualization objects, such as KPIs, Charts, and Tables, and organizing them into Groups. + +- **End-User**: The End-users of Transpara are the individuals who use the software to access data, reports, and insights. They consume the data available on Transpara after the integration from the Administrator and customization from the Designer. End-users don't necessarily require extensive technical knowledge to use Transpara. They're responsible for analyzing the available data. + +## Documentation Structure + +It is important to note that the documentation for Transpara is organized to serve the 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 [Transpara Core Concepts](/docs/core-concepts) to gain a general understanding of the platform's functionality. + +After reading the core concepts, each user can continue to their specific section: + +- [Setup and Administration](/docs/setup-and-administration): This section was planned to help the Administrator install Transpara, create and start using interfaces, and show how to use the automation functionalities to import existing KPIs from your system into Transpara. +- [Transpara Design](/docs/visual-kpi-designer/overview): Designers find in this section the necessary content to configure Transpara and create KPIs, Charts, Tables, and Groups. +- [End User](/docs/end-user/overview): The guide for end users to learn how to use and take advantage of Transpara is available in this section. + +In addition to these tailored sections, Transpara documentation provides support pages to cover specific needs, where you can find: + +- [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 Transpara functionalities. + +- [Frequently Asked Questions (FAQs)](/docs/faqs): This section contains answers to common questions and issues that users may encounter while using Transpara, offering quick solutions. + +- [Training materials](/docs/training): Include training video courses and other materials designed to educate users on effectively using Transpara and its features. + +- [Glossary](/docs/glossary): Explore a list of key terms and their definitions to clarify technical jargon and terminology used within Transpara. + +## What's Next? + +If you are new to Transpara, we recommend accessing the [Transpara Core Concepts](/docs/core-concepts) page first. If you are already familiar with Transpara, you can proceed to one of the pages described above, depending on your needs. \ No newline at end of file diff --git a/transpara-v6/docs/getting-started/how-transpara-works.mdx b/transpara-v6/docs/getting-started/how-transpara-works.mdx new file mode 100644 index 00000000..a1094f87 --- /dev/null +++ b/transpara-v6/docs/getting-started/how-transpara-works.mdx @@ -0,0 +1,48 @@ +--- +id: how-transpara-works +title: How Transpara Works +slug: /how-transpara-works +description: 'Discover how Transpara is structured and works.' +tags: ['documentation'] +--- + +**OLD TEXT, USED AS A HOLDER** + +At the core of Transpara is its ability to effortlessly integrate with your existing operations. Transpara's flexibility is one of its defining features. In addition to supporting thousands of data sources, it provides customizable deployment options and security functionalities to cover all industries and businesses. + +## Where Transpara Software Lives + +Many new users assume that Transpara software operates in the cloud, such as a SaaS, and that customer data will be hosted externally. However, this isn't the case. + +First, Transpara doesn't require moving any data to new databases. It reads your data in near-real-time from wherever you keep it and uses it without requiring you to manage and maintain a new master data source. + +Regarding the Transpara deployment, you can choose the option that best suits your business needs. You can integrate Transpara software inside your environment using one of the following options: + +- **In Your Cloud**: Transpara can be hosted in your cloud environment, providing the convenience of cloud-based deployment. + +- **On Your Server**: Alternatively, you can run Transpara on your server, giving you complete control over your operations and ensuring the data will stay within your organization. + +Transpara understands that each customer and each application may require a different deployment approach, and we're open to customizing it and aligning it to your unique needs. + +:::support Contact Transpara + +The Transpara team is always ready to support you. Contact our [support team](https://www.transpara.com/contact-us/) so we can solve any doubts you have regarding how Transpara can fit into your company. + +::: + +## Security Integration + +Transpara efficiently integrates with your existing security model. Transpara understands that only you thoroughly understand your security requirements, so we make our solution fully customizable at all levels. When using Transpara, you can: + +- Set up permissions for your Transpara websites to limit who can view your KPI data. +- Create local groups and users to specify who can access each KPI collection. +- Use object-level security to restrict access to specific objects within Transpara, such as KPIs, Charts, Tables, or Groups. +- Define permissions for the Transpara Designer to limit who can modify your KPI configurations. + +Transpara is a Web server-based application. As a result, it takes advantage of existing authentication and rights-assignment subsystems within the platform, including the directory and all related security policies. In addition, Transpara makes sharing real-time information easy and secure. It shares links rather than data, ensuring that sensitive information doesn't fall into the wrong hands. + +To learn more about security in Transpara, access the [Security](./core-concepts/access-level) page in the documentation or the [security articles list](https://www.transpara.com/article-categories/security/) in the knowledge base. + +## What's Next? + +Transpara integration and its usage provide endless options. On the documentation, you can follow different paths depending on your current stage, such as installation, design, and data management. Access the page [How to Use the Documentation](./how-to-use-the-documentation) to learn about the paths you can follow to take advantage of all Transpara features. diff --git a/transpara-v6/docs/getting-started/transpara-approach.mdx b/transpara-v6/docs/getting-started/transpara-approach.mdx new file mode 100644 index 00000000..33a1a4c6 --- /dev/null +++ b/transpara-v6/docs/getting-started/transpara-approach.mdx @@ -0,0 +1,27 @@ +--- +id: transpara-approach +title: The Transpara Approach +slug: /transpara-approach +description: 'Learn how Transpara differs from the competitors and provides a unique approach to make KPI management easier and accessible everywhere.' +tags: ['documentation'] +--- + +**OLD TEXT, USED AS A HOLDER** + +When dealing with KPI data visualization, Transpara stands out as a game-changer compared to other software. Transpara takes a different approach, providing automatic data visualization despite the type and origin of your data. This unique way of addressing the KPI data visualization sets it apart from other solutions, such as PowerBI. + +## Why Transpara 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 tools are highly processing-demanding, presenting significant loading times and frequent slowing or even freezing devices. + +### Transpara Advantages + +Transpara is a data visualization tool that lets you focus on data analysis instead of creating charts. Once you connect to your data source, Transpara offers multiple out-of-the-box ways to visualize data that truly matters to your business. You can customize the visualization to meet your business's unique needs and switch between different visualizations as required. + +Transpara has a lightweight interface that loads instantly on any device, eliminating the need to deal with long loading times or device freezing. It doesn't store your company's sensitive information and only acquires data from your data sources in real time. + +In summary, Transpara sets KPI apart from conventional data visualization tools by handling the data visualization and providing a light interface without storing data outside your server or cloud account. + +## What's Next? + +To learn more about where Transpara software lives and the security solutions it uses to protect your data, we recommend you access the [How Transpara works](./how-transpara-works). diff --git a/transpara-v6/docs/getting-started/what-is-transpara.mdx b/transpara-v6/docs/getting-started/what-is-transpara.mdx new file mode 100644 index 00000000..dcdcbee6 --- /dev/null +++ b/transpara-v6/docs/getting-started/what-is-transpara.mdx @@ -0,0 +1,53 @@ +--- +id: what-is-transpara +title: What is Transpara? +slug: / +description: 'Discover Transpara V6' +--- + +**OLD TEXT, USED AS A HOLDER** + +Transpara is an innovative software solution that simplifies real-time operations management and performance tracking for businesses into one easy-to-use solution. Transpara 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 + +Transpara 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 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, Transpara also sends notifications when there is something you need to address, and you can access it using desktop or mobile. + +Transpara typical customers come from various industries, including: + +- Energy & Utilities +- IT Cloud & Data +- Manufacturing +- Mining +- Oil & Gas +- Pharma & Biotech +- Pulp & Paper +- Telecommunications +- Food & Beverage +- Water & Wastewater +- and more + +Transpara's solution is completely customizable, and we keep adding new features to meet your changing business needs. + +## What are the benefits of using Transpara? + +Transpara enables you to connect with multiple data sources and integrate them easily, customizing each operation through an intuitive and user-friendly dashboard. With Transpara, you have the following benefits: + +- 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. +- Connect your company to various data sources and solutions in a unified way. +- Simplify analysis and decision-making based on accurate information. +- Rely on the free support of a dedicated sales team. + +## Real-Time Excellence with Transpara + +Transpara 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/). + +:::support Contact Transpara + +The Transpara team is always ready to support you. Contact our [support team](https://www.transpara.com/contact-us/) so we can solve 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 support dozens of data sources out of the box and are ready to help you if you have other needs. \ No newline at end of file diff --git a/transpara-v6/docs/tcalc/how-to-use-tcalc.mdx b/transpara-v6/docs/tcalc/how-to-use-tcalc.mdx new file mode 100644 index 00000000..19176fa1 --- /dev/null +++ b/transpara-v6/docs/tcalc/how-to-use-tcalc.mdx @@ -0,0 +1,87 @@ +--- +id: how-to-use-tcalc +title: How to Use tCalc +slug: how-to-use-tcalc +description: '' +tags: ['documentation'] +--- + +tCalc is a robust calculation engine designed for flexible and scalable data processing. This guide will walk you through the process of using tCalc, from connecting databases to defining and evaluating calculations. + +:::info Work in Progress + +Some sections are placeholders for information that will be added as the project progresses. + +::: + +## Connecting to Databases to Import Data + +tCalc allows you to import data from multiple sources. Data can originate from graph databases like tGraph, relational databases, or other defined interfaces. Attributes in the system may be **static** or **dynamic**, with dynamic attributes fetching real-time data via defined lookups. + +### Steps to Connect a Database: + +1. Navigate to the **Interfaces** section in tCalc. +2. Define the endpoint for the data source. +3. Use the **lookup feature** to specify the attribute you want to retrieve (e.g., selecting a column from an SQL table or a tag from a time-series database). + +:::info Work in Progress + +More details on database integration will be added here as they are finalized. + +::: + +## Creating a Template + +Templates are predefined configurations for calculations that streamline the setup process. They allow consistent behavior across multiple objects. + +### Steps to Create a Template: + +1. Go to the **Templates** section. +2. Select the template type (e.g., KPI template, Metric template). +3. Define input attributes (e.g., attributes from the parent, child, or sibling objects in the hierarchy). +4. Specify triggers, such as event-based or interval-based calculations. + +:::info Work in Progress + +More details on templates will be added here as they are finalized. + +::: + +## Defining Statements + +Statements in tCalc define the core logic of a calculation. They are executed sequentially, with outputs from one statement often serving as inputs for the next. + +### Programming Language for Statements + +tCalc supports predefined functions and operations that can be dynamically inserted via the interface. Users can drag-and-drop functions to build statements. + +### How to Define Statements + +1. Start by selecting a template or creating a new calculation. +2. Input variables will appear automatically based on the target object. +3. Use the editor to define your statement logic. For example, `Status = CalculateStatus(ActualValue, Threshold)` +5. Save and evaluate the statements in real time to test results. + +## Connecting to Databases to Export Results + +After calculating, tCalc can export results to the same or other data sources. Export configurations define the destination and format of the output. + +### Steps to Export Results + +1. Configure the export interface in the **Interfaces** section. +2. Map the output attributes from the calculation to the corresponding fields in the target system. +3. Test the export setup using the evaluation feature to verify data accuracy. + +## Using the Template + +Templates simplify the reuse of calculations across multiple objects. + +### Applying a Template + +1. Select a target object (e.g., a substation, district, or KPI). +2. Choose an existing template and instantiate it for the object. +3. Modify parameters if needed, or activate the template version for immediate use. + +### Versioning + +Templates support multiple versions. You can save changes as a new version and activate them when ready. Existing calculations tied to the template will update automatically upon activation. diff --git a/transpara-v6/docs/tcalc/tcalc-glossary.mdx b/transpara-v6/docs/tcalc/tcalc-glossary.mdx index f009a1c7..de3ad621 100644 --- a/transpara-v6/docs/tcalc/tcalc-glossary.mdx +++ b/transpara-v6/docs/tcalc/tcalc-glossary.mdx @@ -3,7 +3,7 @@ id: tcalc-glossary title: tCalc Glossary slug: tcalc-glossary description: '' -tags: ['documentation'] +tags: ['glossary'] --- - **tCalc**: The overall solution that integrates various tools for building and managing calculations, formulas, and data within the tModel. It includes features for building, storing, and executing calculations. @@ -40,4 +40,8 @@ tags: ['documentation'] - **Break Statement**: A special function in a calculation that halts further calculation if a specified condition is not met, improving performance by stopping unnecessary operations. -- **Eventual Consistency**: The principle that data will eventually become consistent across all systems, though calculations may not always occur in real time due to delays in execution. \ No newline at end of file +- **Eventual Consistency**: The principle that data will eventually become consistent across all systems, though calculations may not always occur in real time due to delays in execution. + +- **Latched**: A time-bound configuration for dashboards where all widgets synchronize to a single, unified time range, overriding individual time settings, enabling cohesive analysis within the specified time window. + +- **Hierarchy**: The organizational structure in dashboards that functions like folders on a PC, enabling users to create unlimited levels of groups. Each group can contain multiple objects, such as dashboards or KPIs, improving scalability, navigation, and contextual relevance by associating dashboards with specific contexts, such as regions, sites, or departments. \ No newline at end of file diff --git a/transpara-v6/docs/what-is-transpara.mdx b/transpara-v6/docs/what-is-transpara.mdx deleted file mode 100644 index 8504364e..00000000 --- a/transpara-v6/docs/what-is-transpara.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: what-is-transpara -title: What is Transpara? -slug: / -description: 'Discover Transpara V6' ---- - -**OLD TEXT, USED AS A HOLDER** - -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 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: - -- Energy & Utilities -- IT Cloud & Data -- Manufacturing -- Mining -- Oil & Gas -- Pharma & Biotech -- Pulp & Paper -- Telecommunications -- Food & Beverage -- Water & Wastewater -- and more - -Visual KPI's solution is completely customizable, and we keep adding new features to meet your changing business needs. - -## What are the benefits of using Visual KPI? - -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 have the following benefits: - -- 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. -- Connect your company to various data sources and solutions in a unified way. -- Simplify 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](https://www.transpara.com/contact-us/). - -:::support Contact Transpara - -The Transpara team is always ready to support you. Contact our [support team](https://www.transpara.com/contact-us/) so we can solve 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 support dozens of data sources out of the box and are ready to help you if you have other needs. - - diff --git a/transpara-v6/sidebars.js b/transpara-v6/sidebars.js index 0d503367..f9b966c3 100644 --- a/transpara-v6/sidebars.js +++ b/transpara-v6/sidebars.js @@ -11,6 +11,7 @@ const { gettingStarted, + dashboards, tcalc } = require('./.sidebar'); @@ -31,6 +32,13 @@ const sidebars = { className: 'sidebar_title', }, ...gettingStarted, + { + type: 'html', + value: 'Dashboards', + defaultStyle: true, + className: 'sidebar_title', + }, + ...dashboards, { type: 'html', value: 'tCalc',