https://docs.datonis.io/mediawiki/api.php?action=feedcontributions&user=Amit&feedformat=atomDatonis - User contributions [en]2024-03-29T07:12:46ZUser contributionsMediaWiki 1.28.2https://docs.datonis.io/mediawiki/index.php?title=Create_your_own_custom_dashboards&diff=1373Create your own custom dashboards2020-07-23T10:33:46Z<p>Amit: </p>
<hr />
<div>== Getting started with Datonis BI ==<br />
The tool can be accessed by logging into the following link: <u><nowiki>https://bi.datonis.io/</nowiki></u><br />
<br />
The same Datonis MInt credentials can be used to log into the tool. If you have already logged into Datonis MInt, the tool will automatically load by visiting the above-mentioned link.<br />
<br />
[[File:Altizon BI Homepage.png|600x600px]]<br />
<br />
A page showing Dashboards will come up. These are all the dashboards that are already created on this account.<br />
<br />
'''Note –''' The account used in this manual is our sales demo account which already has some dashboards created. If you are a new user, the list will be blank.<br />
<br />
== Basic Concepts ==<br />
<br />
=== Charts and Dashboards ===<br />
There are 2 elements to remember while creating a Dashboard in Datonis BI:<br />
# '''Charts''' – A chart is a visualisation element (e.g. bar chart, pivot table, pie chart, filter box).<br />
# '''Dashboards''' – Dashboard is a collection of one or many charts which together provide some business value.<br />
The workflow to create a dashboard is as follows:<br />
<br />
=== Dashboard creation flow ===<br />
[[File:Steps to create Dashboard.png|498x498px]]<br />
<br />
<br />
== Creating a Chart ==<br />
<br />
=== Chart Types ===<br />
Datonis BI has a rich set of data visualisation components. Some of them are explained below.<br />
# '''Line Chart''' - A line chart displays information as a series of data points connected by a line. This chart can be used to plot a quantity that varies over a time range. E.g. The trend of energy consumption over a period of a week.<br />
# '''Dual Line Chart''' - A dual-axis line chart uses two axes to display the relationship of two differently scaled components. E.g. The trend of Production and Rejection quantity.<br />
# '''Table''' - A table lets you select the data from a set of components and displays in a tabular form. <br />
# '''Pivot Table''' - A pivot table allows you to summarise your data easily. This chart helps you to answer your questions with minimal effort.<br />
# '''Bar Chart''' - A bar/ column chart displays categorical information with vertical bars showing the value of the categorical component.<br />
# '''Time Series Bar Chart''' - Similar to a bar chart, this displays categorical information with it's value over a time range.<br />
# '''Pie Chart''' - A pie chart is used to show relative sizes of data.<br />
# '''Histogram''' - A histogram shows the shape and spread of the data being visualized.<br />
# '''Treemap'''- A treemap shows categorical component magnitude as a colour difference. E.g. Part Cycle Time Ratio - The values <=1 show a GREEN color while the values >1 show RED; meaning that the Cycle Times falling in RED are taking more time the standard cycle times.<br />
# '''Big Number''' - This chart just shows a component value. E.g. to monitor the total number of alerts generated for the selected duration.<br />
# '''Box Plot''' - The box plot shows the distribution of data using 5 metrics ( min, first quartile, median, third quartile, and max).<br />
# '''Bubble Chart''' - Bubble/ Scatter chart plots a series of data points to see if there is any correlation between 2 components.<br />
# '''and others...'''<br />
<br />
=== Steps for creating a chart ===<br />
Click on the 'Charts' Tab at the top left of the screen.<br />
<br />
[[File:Create a chart.png|600x600px]]<br />
<br />
<br />
Similar to the Dashboard page, a page showing the list of charts is shown.<br />
To create a new chart, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
[[File:Create a new chart.png|600x600px]]<br />
<br />
<br />
A new page showing the chart configuration will be shown. The next step is to choose the [[Analytics Data Model|data source]] and visualisation type.<br />
In the ‘Choose a datasource’ drop down, the user will be able to see all the datasources available in his/her account.<br />
In the ‘visualisation type’ the user can select a chart from a vast variety of chart types.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
=== Example video for creating a chart ===<br />
Here is an example video of how you can create a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/k3nuNbrJLL8}}<br />
<br />
=== Chart creation example ===<br />
<br />
The below shows a step-by-step way to create a chart.<br />
<br />
Clicking on the ‘Table’ button (default selection of Table) will pop up a screen showing all the supported visualisations. The user will have to select one and then click on ‘Create New Chart’.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
<br />
A new page with two sections will open. The section on the left is the chart type configuration and the section on the right is the chart data rendering section (marked in Red and Blue respectively).<br />
<br />
[[File:Chart page options.png|600x600px]]<br />
<br />
<br />
The left section is used to configure the settings like Time column, Metrics, Series etc. which are dependent on the visualisation type the user chooses.<br />
<br />
The example shown in this case is for a Bar Chart. The bar chart will have a Categorical variable on the X- axis and a Numeric variable on the Y-axis.<br />
<br />
On top of the left section, there are 2 tabs:<br />
<br />
1. '''Data -''' This tab contains the configuration related to the data being viewed in the chart.<br />
<br />
2. '''Customise -''' This tab contains the look and feel settings for the selected visualisation type.<br />
<br />
<br />
Some of the features are explained in the example below.<br />
<br />
==== Create a chart showing average OEE by Workcenters ====<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter<br />
<br />
'''Note –''' In metrics, you will need to provide an aggregation function amongst the list already provided. Check below image for more details.<br />
<br />
[[File:Chart page options - aggregate functions.png|600x600px]]<br />
<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Rendering the chart.png|600x600px]]<br />
<br />
<br />
==== Segregate the average OEE by Shift ====<br />
<br />
Let us say, you want to identify which Shift contributed to what OEE percent? Also, we want to use bar values and stacked bars.<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter, Breakdowns: Shift Name<br />
<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Changing some configuration of the chart.png|600x600px]]<br />
<br />
<br />
This completes the first requirement of Avg OEE by Workcenter and Shift. The second requirement is more of a look-and-feel change which can be done using the 'Customize' tab.<br />
<br />
In Customize tab, we need to tick options: Bar Values and Stacked Bars. The final output looks like this:<br />
<br />
[[File:Rendering the chart with changes in the configuration section.png|600x600px]]<br />
<br />
'''Note -''' Each visualisation type will have different Data and Customize selections.<br />
<br />
<br />
Once you are satisfied with the chart and its look and feel, the chart needs to be saved by clicking on the 'Save' button on the top left side of the screen.<br />
<br />
Once you click on the Save button, a popup will be shown. The chart needs to be given a name by which it will be visible on the Dashboard.<br />
<br />
<br />
There are 2 ways to add a Chart to a Dashboard.<br />
<br />
1. Directly from the Save menu saying, ‘Add chart to existing dashboard’ or ‘Add to new dashboard.’<br />
<br />
2. Create a dashboard from the Dashboards page, open the dashboard and then add a Chart to it.<br />
<br />
[[File:Saving a chart.png|600x600px]]<br />
<br />
<br />
Once you save the dashboard, it will be visible as a row in the Charts page list.<br />
<br />
[[File:Chart List.png|600x600px]]<br />
<br />
<br />
If you select 'Add to new Dashboard', a dashboard will also be created, and this chart will be added in the newly created dashboard.<br />
<br />
<br />
== Creating a Dashboard ==<br />
<br />
=== Steps for creating a Dashboard ===<br />
Please read below for a step-by-step way to create a dashboard.<br />
<br />
Click on the 'Dashboards' Tab at the top left of the screen.<br />
<br />
To create a new dashboard, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
A configuration page will open. On this page, the user has to enter the Title, Owners (if multiple people need to edit the dashboard) and select/unselect 'Published' checkbox and then click on 'Save'. By selecting Published checkbox, all users having access to the underlying data source can view the dashboard.<br />
<br />
The dashboard will be visible as a row in the Dashboards page list.<br />
<br />
[[File:Dashboard List.png|600x600px]]<br />
<br />
<br />
Click on the Dashboard name to access the dashboard.<br />
<br />
[[File:Open the created Dashboard.png|600x600px]]<br />
<br />
<br />
You can see that a blank dashboard has been created. Now we need to add our created chart into this Dashboard. To do this, click on ‘Edit dashboard’ button on the top right of the screen.<br />
<br />
This will open an 'Insert Components' tab in which you need to select your charts and filters.<br />
<br />
[[File:Insert Components Tab.png|600x600px]]<br />
<br />
<br />
This will list all the charts that have been created using this account.<br />
<br />
[[File:Chart List in components tab.png|600x600px]]<br />
<br />
<br />
Select the chart we created and drag it to the blank screen.<br />
<br />
[[File:Adding a chart to the dashboard.png|600x600px]]<br />
<br />
<br />
This will add the chart to the dashboard. You can resize the chart by using the arrow at the bottom right of the chart. <br />
<br />
[[File:Resizing the chart.png|600x600px]] <br />
<br />
<br />
Once you are satisfied with the layout, click on ‘Save changes’ and the dashboard will be ready.<br />
<br />
[[File:Final Dashboard.png|600x600px]]<br />
<br />
=== Example video for creating a dashboard ===<br />
Here is an example video of how you can create a dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/dxU1pTMXG8A}}<br />
<br />
== Adding a Filter ==<br />
A filter is a chart type that is used to narrow down the data selection based on user selection. E.g. Shift Filter can be used to specify which shifts to consider, Workcenter Filter specifies which workcenters' data to consider etc.<br />
<br />
Similar to any other chart, the chart to use here is 'Filter Box'. Rest of the steps for adding it to the dashboard are the same as mentioned in the 'Creating a Chart' section.<br />
<br />
=== Example video for adding a filter ===<br />
Here is an example video of how you can create a filter.<br />
<br />
{{#ev:youtube|https://youtu.be/fFWRQGXfsMQ}}<br />
<br />
== Publishing a Dashboard ==<br />
Once you create a dashboard, for other users to view the dashboard it needs to be published. To do that, go to the Dashboard tab and click on the 'Edit Record' button on the actions tab. Scroll down to the selection of 'Published'. Tick the Published checkbox and save your changes.<br />
<br />
=== Example video for publishing a dashboard ===<br />
Here is an example video of how you can publish a Dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/DOb6dsaPfBA}}<br />
<br />
== Customizing the look and feel ==<br />
For all of the chart types as mentioned above, there is a 'Customize' Tab in each of the charts. This tab is used to customize the look and feel of the chart.<br />
<br />
Some of the customizations include: <br />
* Changing the color scheme<br />
* Sorting the data by a column<br />
* Adding Data Labels<br />
* Changing the X/Y Axis labels<br />
* Changing the X/Y Axis Data Formats<br />
* Filtering the data by a condition<br />
<br />
'''Note -''' Each chart will have its own Customize options. Not all charts will have all the customisations listed above.<br />
<br />
=== Example video for customising look-and-feel ===<br />
Here is an example video of how you can customise the look and feel of a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/V5RGvZywKtU}}</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=MediaWiki:Sidebar&diff=1372MediaWiki:Sidebar2020-07-23T10:32:33Z<p>Amit: </p>
<hr />
<div>* navigation<br />
** Datonis|Home<br />
* IOT Platform<br />
** Datonis_Documentation_Home|Platform Docs<br />
** Datonis_Edge_Gateway|Edge Gateway<br />
** Datonis_FAQs|FAQs<br />
** Knowledge_Base|Knowledge Base<br />
* Applications<br />
** Datonis_AppCenter|AppCenter<br />
** Datonis_Manufacturing_Intelligence|MInt<br />
** Datonis_Business_Intelligence|BI<br />
* Partners<br />
** Datonis Resources|Resources<br />
** Application Development Framework|App Development<br />
* Engineering<br />
** Engineering:Home|Engineering<br />
** Engineering:Solution_Architecture|Solution Architecture<br />
** Engineering:SOC2|SOC2</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Create_your_own_custom_dashboards&diff=1371Create your own custom dashboards2020-07-23T10:27:06Z<p>Amit: </p>
<hr />
<div>== Getting started with Datonis BI ==<br />
The tool can be accessed by logging into the following link: <u><nowiki>https://bi.datonis.io/</nowiki></u><br />
<br />
The same Datonis MInt credentials can be used to log into the tool. If you have already logged into Datonis MInt, the tool will automatically load by visiting the above-mentioned link.<br />
<br />
[[File:Altizon BI Homepage.png|600x600px]]<br />
<br />
A page showing Dashboards will come up. These are all the dashboards that are already created on this account.<br />
<br />
'''Note –''' The account used in this manual is our sales demo account which already has some dashboards created. If you are a new user, the list will be blank.<br />
<br />
== Basic Concepts ==<br />
<br />
=== Charts and Dashboards ===<br />
There are 2 elements to remember while creating a Dashboard in Datonis BI:<br />
# '''Charts''' – A chart is a visualisation element (e.g. bar chart, pivot table, pie chart, filter box).<br />
# '''Dashboards''' – Dashboard is a collection of one or many charts which together provide some business value.<br />
The workflow to create a dashboard is as follows:<br />
<br />
=== Dashboard creation flow ===<br />
[[File:Steps to create Dashboard.png|498x498px]]<br />
<br />
<br />
== Creating a Chart ==<br />
<br />
=== Chart Types ===<br />
Altizon BI has a rich set of data visualisation components. Some of them are explained below.<br />
# '''Line Chart''' - A line chart displays information as a series of data points connected by a line. This chart can be used to plot a quantity that varies over a time range. E.g. The trend of energy consumption over a period of a week.<br />
# '''Dual Line Chart''' - A dual-axis line chart uses two axes to display the relationship of two differently scaled components. E.g. The trend of Production and Rejection quantity.<br />
# '''Table''' - A table lets you select the data from a set of components and displays in a tabular form. <br />
# '''Pivot Table''' - A pivot table allows you to summarise your data easily. This chart helps you to answer your questions with minimal effort.<br />
# '''Bar Chart''' - A bar/ column chart displays categorical information with vertical bars showing the value of the categorical component.<br />
# '''Time Series Bar Chart''' - Similar to a bar chart, this displays categorical information with it's value over a time range.<br />
# '''Pie Chart''' - A pie chart is used to show relative sizes of data.<br />
# '''Histogram''' - A histogram shows the shape and spread of the data being visualized.<br />
# '''Treemap'''- A treemap shows categorical component magnitude as a colour difference. E.g. Part Cycle Time Ratio - The values <=1 show a GREEN color while the values >1 show RED; meaning that the Cycle Times falling in RED are taking more time the standard cycle times.<br />
# '''Big Number''' - This chart just shows a component value. E.g. to monitor the total number of alerts generated for the selected duration.<br />
# '''Box Plot''' - The box plot shows the distribution of data using 5 metrics ( min, first quartile, median, third quartile, and max).<br />
# '''Bubble Chart''' - Bubble/ Scatter chart plots a series of data points to see if there is any correlation between 2 components.<br />
# '''and others...'''<br />
<br />
=== Steps for creating a chart ===<br />
Click on the 'Charts' Tab at the top left of the screen.<br />
<br />
[[File:Create a chart.png|600x600px]]<br />
<br />
<br />
Similar to the Dashboard page, a page showing the list of charts is shown.<br />
To create a new chart, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
[[File:Create a new chart.png|600x600px]]<br />
<br />
<br />
A new page showing the chart configuration will be shown. The next step is to choose the [[Analytics Data Model|data source]] and visualisation type.<br />
In the ‘Choose a datasource’ drop down, the user will be able to see all the datasources available in his/her account.<br />
In the ‘visualisation type’ the user can select a chart from a vast variety of chart types.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
=== Example video for creating a chart ===<br />
Here is an example video of how you can create a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/k3nuNbrJLL8}}<br />
<br />
=== Chart creation example ===<br />
<br />
The below shows a step-by-step way to create a chart.<br />
<br />
Clicking on the ‘Table’ button (default selection of Table) will pop up a screen showing all the supported visualisations. The user will have to select one and then click on ‘Create New Chart’.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
<br />
A new page with two sections will open. The section on the left is the chart type configuration and the section on the right is the chart data rendering section (marked in Red and Blue respectively).<br />
<br />
[[File:Chart page options.png|600x600px]]<br />
<br />
<br />
The left section is used to configure the settings like Time column, Metrics, Series etc. which are dependent on the visualisation type the user chooses.<br />
<br />
The example shown in this case is for a Bar Chart. The bar chart will have a Categorical variable on the X- axis and a Numeric variable on the Y-axis.<br />
<br />
On top of the left section, there are 2 tabs:<br />
<br />
1. '''Data -''' This tab contains the configuration related to the data being viewed in the chart.<br />
<br />
2. '''Customise -''' This tab contains the look and feel settings for the selected visualisation type.<br />
<br />
<br />
Some of the features are explained in the example below.<br />
<br />
==== Create a chart showing average OEE by Workcenters ====<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter<br />
<br />
'''Note –''' In metrics, you will need to provide an aggregation function amongst the list already provided. Check below image for more details.<br />
<br />
[[File:Chart page options - aggregate functions.png|600x600px]]<br />
<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Rendering the chart.png|600x600px]]<br />
<br />
<br />
==== Segregate the average OEE by Shift ====<br />
<br />
Let us say, you want to identify which Shift contributed to what OEE percent? Also, we want to use bar values and stacked bars.<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter, Breakdowns: Shift Name<br />
<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Changing some configuration of the chart.png|600x600px]]<br />
<br />
<br />
This completes the first requirement of Avg OEE by Workcenter and Shift. The second requirement is more of a look-and-feel change which can be done using the 'Customize' tab.<br />
<br />
In Customize tab, we need to tick options: Bar Values and Stacked Bars. The final output looks like this:<br />
<br />
[[File:Rendering the chart with changes in the configuration section.png|600x600px]]<br />
<br />
'''Note -''' Each visualisation type will have different Data and Customize selections.<br />
<br />
<br />
Once you are satisfied with the chart and its look and feel, the chart needs to be saved by clicking on the 'Save' button on the top left side of the screen.<br />
<br />
Once you click on the Save button, a popup will be shown. The chart needs to be given a name by which it will be visible on the Dashboard.<br />
<br />
<br />
There are 2 ways to add a Chart to a Dashboard.<br />
<br />
1. Directly from the Save menu saying, ‘Add chart to existing dashboard’ or ‘Add to new dashboard.’<br />
<br />
2. Create a dashboard from the Dashboards page, open the dashboard and then add a Chart to it.<br />
<br />
[[File:Saving a chart.png|600x600px]]<br />
<br />
<br />
Once you save the dashboard, it will be visible as a row in the Charts page list.<br />
<br />
[[File:Chart List.png|600x600px]]<br />
<br />
<br />
If you select 'Add to new Dashboard', a dashboard will also be created, and this chart will be added in the newly created dashboard.<br />
<br />
<br />
== Creating a Dashboard ==<br />
<br />
=== Steps for creating a Dashboard ===<br />
Please read below for a step-by-step way to create a dashboard.<br />
<br />
Click on the 'Dashboards' Tab at the top left of the screen.<br />
<br />
To create a new dashboard, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
A configuration page will open. On this page, the user has to enter the Title, Owners (if multiple people need to edit the dashboard) and select/unselect 'Published' checkbox and then click on 'Save'. By selecting Published checkbox, all users having access to the underlying data source can view the dashboard.<br />
<br />
The dashboard will be visible as a row in the Dashboards page list.<br />
<br />
[[File:Dashboard List.png|600x600px]]<br />
<br />
<br />
Click on the Dashboard name to access the dashboard.<br />
<br />
[[File:Open the created Dashboard.png|600x600px]]<br />
<br />
<br />
You can see that a blank dashboard has been created. Now we need to add our created chart into this Dashboard. To do this, click on ‘Edit dashboard’ button on the top right of the screen.<br />
<br />
This will open an 'Insert Components' tab in which you need to select your charts and filters.<br />
<br />
[[File:Insert Components Tab.png|600x600px]]<br />
<br />
<br />
This will list all the charts that have been created using this account.<br />
<br />
[[File:Chart List in components tab.png|600x600px]]<br />
<br />
<br />
Select the chart we created and drag it to the blank screen.<br />
<br />
[[File:Adding a chart to the dashboard.png|600x600px]]<br />
<br />
<br />
This will add the chart to the dashboard. You can resize the chart by using the arrow at the bottom right of the chart. <br />
<br />
[[File:Resizing the chart.png|600x600px]] <br />
<br />
<br />
Once you are satisfied with the layout, click on ‘Save changes’ and the dashboard will be ready.<br />
<br />
[[File:Final Dashboard.png|600x600px]]<br />
<br />
=== Example video for creating a dashboard ===<br />
Here is an example video of how you can create a dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/dxU1pTMXG8A}}<br />
<br />
== Adding a Filter ==<br />
A filter is a chart type that is used to narrow down the data selection based on user selection. E.g. Shift Filter can be used to specify which shifts to consider, Workcenter Filter specifies which workcenters' data to consider etc.<br />
<br />
Similar to any other chart, the chart to use here is 'Filter Box'. Rest of the steps for adding it to the dashboard are the same as mentioned in the 'Creating a Chart' section.<br />
<br />
=== Example video for adding a filter ===<br />
Here is an example video of how you can create a filter.<br />
<br />
{{#ev:youtube|https://youtu.be/fFWRQGXfsMQ}}<br />
<br />
== Publishing a Dashboard ==<br />
Once you create a dashboard, for other users to view the dashboard it needs to be published. To do that, go to the Dashboard tab and click on the 'Edit Record' button on the actions tab. Scroll down to the selection of 'Published'. Tick the Published checkbox and save your changes.<br />
<br />
=== Example video for publishing a dashboard ===<br />
Here is an example video of how you can publish a Dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/DOb6dsaPfBA}}<br />
<br />
== Customizing the look and feel ==<br />
For all of the chart types as mentioned above, there is a 'Customize' Tab in each of the charts. This tab is used to customize the look and feel of the chart.<br />
<br />
Some of the customizations include: <br />
* Changing the color scheme<br />
* Sorting the data by a column<br />
* Adding Data Labels<br />
* Changing the X/Y Axis labels<br />
* Changing the X/Y Axis Data Formats<br />
* Filtering the data by a condition<br />
<br />
'''Note -''' Each chart will have its own Customize options. Not all charts will have all the customisations listed above.<br />
<br />
=== Example video for customising look-and-feel ===<br />
Here is an example video of how you can customise the look and feel of a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/V5RGvZywKtU}}</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Create_your_own_custom_dashboards&diff=1370Create your own custom dashboards2020-07-23T10:09:04Z<p>Amit: </p>
<hr />
<div>== Getting started with Datonis BI ==<br />
The tool can be accessed by logging into the following link: <u><nowiki>https://bi.datonis.io/</nowiki></u><br />
<br />
The same Datonis MInt credentials can be used to log into the tool. If you have already logged into Datonis MInt, the tool will automatically load by visiting the above-mentioned link.<br />
<br />
[[File:Altizon BI Homepage.png|600x600px]]<br />
<br />
A page showing Dashboards will come up. These are all the dashboards that are already created on this account.<br />
<br />
'''Note –''' The account used in this manual is our sales demo account which already has some dashboards created. If you are a new user, the list will be blank.<br />
<br />
== Basic Concepts ==<br />
<br />
=== Charts and Dashboards ===<br />
There are 2 elements to remember while creating a Dashboard in Datonis BI:<br />
# '''Charts''' – A chart is a visualisation element (e.g. bar chart, pivot table, pie chart, filter box).<br />
# '''Dashboards''' – Dashboard is a collection of one or many charts which together provide some business value.<br />
The workflow to create a dashboard is as follows:<br />
<br />
=== Dashboard creation flow ===<br />
[[File:Steps to create Dashboard.png|498x498px]]<br />
<br />
<br />
== Creating a Chart ==<br />
<br />
=== Chart Types ===<br />
Altizon BI has a rich set of data visualisation components. Some of them are explained below.<br />
# '''Line Chart''' - A line chart displays information as a series of data points connected by a line. This chart can be used to plot a quantity that varies over a time range. E.g. The trend of energy consumption over a period of a week.<br />
# '''Dual Line Chart''' - A dual-axis line chart uses two axes to display the relationship of two differently scaled components. E.g. The trend of Production and Rejection quantity.<br />
# '''Table''' - A table lets you select the data from a set of components and displays in a tabular form. <br />
# '''Pivot Table''' - A pivot table allows you to summarise your data easily. This chart helps you to answer your questions with minimal effort.<br />
# '''Bar Chart''' - A bar/ column chart displays categorical information with vertical bars showing the value of the categorical component.<br />
# '''Time Series Bar Chart''' - Similar to a bar chart, this displays categorical information with it's value over a time range.<br />
# '''Pie Chart''' - A pie chart is used to show relative sizes of data.<br />
# '''Histogram''' - A histogram shows the shape and spread of the data being visualized.<br />
# '''Treemap'''- A treemap shows categorical component magnitude as a colour difference. E.g. Part Cycle Time Ratio - The values <=1 show a GREEN color while the values >1 show RED; meaning that the Cycle Times falling in RED are taking more time the standard cycle times.<br />
# '''Big Number''' - This chart just shows a component value. E.g. to monitor the total number of alerts generated for the selected duration.<br />
# '''Box Plot''' - The box plot shows the distribution of data using 5 metrics ( min, first quartile, median, third quartile, and max).<br />
# '''Bubble Chart''' - Bubble/ Scatter chart plots a series of data points to see if there is any correlation between 2 components.<br />
# '''and others...'''<br />
<br />
=== Steps for creating a chart ===<br />
Click on the 'Charts' Tab at the top left of the screen.<br />
<br />
[[File:Create a chart.png|600x600px]]<br />
<br />
Similar to the Dashboard page, a page showing the list of charts is shown.<br />
<br />
To create a new chart, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
[[File:Create a new chart.png|600x600px]]<br />
<br />
A new page showing the chart configuration will be shown. The next step is to choose the [[Analytics Data Model|data source]] and visualisation type.<br />
<br />
In the ‘Choose a datasource’ drop down, the user will be able to see all the datasources available in his/her account.<br />
<br />
In the ‘visualisation type’ the user can select a chart from a vast variety of chart types.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
=== Example video for creating a chart ===<br />
Here is an example video of how you can create a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/k3nuNbrJLL8}}<br />
<br />
=== Chart creation example ===<br />
<br />
The below shows a step-by-step way to create a chart.<br />
<br />
Clicking on the ‘Table’ button (default selection of Table) will pop up a screen showing all the supported visualisations. The user will have to select one and then click on ‘Create New Chart’.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
A new page with two sections will open. The section on the left is the chart type configuration and the section on the right is the chart data rendering section (marked in Red and Blue respectively).<br />
<br />
[[File:Chart page options.png|600x600px]]<br />
<br />
The left section is used to configure the settings like Time column, Metrics, Series etc. which are dependent on the visualisation type the user chooses.<br />
<br />
The example shown in this case is for a Bar Chart. The bar chart will have a Categorical variable on the X- axis and a Numeric variable on the Y-axis.<br />
<br />
On top of the left section, there are 2 tabs:<br />
<br />
1. '''Data -''' This tab contains the configuration related to the data being viewed in the chart.<br />
<br />
2. '''Customise -''' This tab contains the look and feel settings for the selected visualisation type.<br />
<br />
<br />
Some of the features are explained in the example below.<br />
<br />
==== Create a chart showing average OEE by Workcenters ====<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter<br />
<br />
'''Note –''' In metrics, you will need to provide an aggregation function amongst the list already provided. Check below image for more details.<br />
<br />
[[File:Chart page options - aggregate functions.png|600x600px]]<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Rendering the chart.png|600x600px]]<br />
<br />
==== Segregate the average OEE by Shift ====<br />
<br />
Let us say, you want to identify which Shift contributed to what OEE percent? Also, we want to use bar values and stacked bars.<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter, Breakdowns: Shift Name<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Changing some configuration of the chart.png|600x600px]]<br />
<br />
This completes the first requirement of Avg OEE by Workcenter and Shift. The second requirement is more of a look-and-feel change which can be done using the 'Customize' tab.<br />
<br />
In Customize tab, we need to tick options: Bar Values and Stacked Bars. The final output looks like this:<br />
<br />
[[File:Rendering the chart with changes in the configuration section.png|600x600px]]<br />
<br />
'''Note -''' Each visualisation type will have different Data and Customize selections.<br />
<br />
Once you are satisfied with the chart and its look and feel, the chart needs to be saved by clicking on the 'Save' button on the top left side of the screen.<br />
<br />
Once you click on the Save button, a popup will be shown. The chart needs to be given a name by which it will be visible on the Dashboard.<br />
<br />
There are 2 ways to add a Chart to a Dashboard.<br />
<br />
1. Directly from the Save menu saying, ‘Add chart to existing dashboard’ or ‘Add to new dashboard.’<br />
<br />
2. Create a dashboard from the Dashboards page, open the dashboard and then add a Chart to it.<br />
<br />
[[File:Saving a chart.png|600x600px]]<br />
<br />
Once you save the dashboard, it will be visible as a row in the Charts page list.<br />
<br />
[[File:Chart List.png|600x600px]]<br />
<br />
If you select 'Add to new Dashboard', a dashboard will also be created, and this chart will be added in the newly created dashboard.<br />
<br />
<br />
== Creating a Dashboard ==<br />
Here is an example video of how you can create a dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/dxU1pTMXG8A}}<br />
<br />
<br />
The below shows a step-by-step way to create a dashboard.<br />
<br />
Click on the 'Dashboards' Tab at the top left of the screen.<br />
<br />
To create a new dashboard, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
A configuration page will open. On this page, the user has to enter the Title, Owners (if multiple people need to edit the dashboard) and select/unselect 'Published' checkbox and then click on 'Save'. By selecting Published checkbox, all users having access to the underlying data source can view the dashboard.<br />
<br />
The dashboard will be visible as a row in the Dashboards page list.<br />
<br />
[[File:Dashboard List.png|600x600px]]<br />
<br />
Click on the Dashboard name to access the dashboard.<br />
<br />
[[File:Open the created Dashboard.png|600x600px]]<br />
<br />
You can see that a blank dashboard has been created. Now we need to add our created chart into this Dashboard. To do this, click on ‘Edit dashboard’ button on the top right of the screen.<br />
<br />
This will open an 'Insert Components' tab in which you need to select your charts and filters.<br />
<br />
[[File:Insert Components Tab.png|600x600px]]<br />
<br />
This will list all the charts that have been created using this account.<br />
<br />
[[File:Chart List in components tab.png|600x600px]]<br />
<br />
Select the chart we created and drag it to the blank screen.<br />
<br />
[[File:Adding a chart to the dashboard.png|600x600px]]<br />
<br />
This will add the chart to the dashboard. You can resize the chart by using the arrow at the bottom right of the chart. <br />
<br />
[[File:Resizing the chart.png|600x600px]] <br />
<br />
Once you are satisfied with the layout, click on ‘Save changes’ and the dashboard will be ready.<br />
<br />
[[File:Final Dashboard.png|600x600px]]<br />
<br />
== Adding a Filter ==<br />
A filter is a chart type that is used to narrow down the data selection based on user selection. E.g. Shift Filter can be used to specify which shifts to consider, Workcenter Filter specifies which workcenters' data to consider etc.<br />
<br />
Similar to any other chart, the chart to use here is 'Filter Box'. Rest of the steps for adding it to the dashboard are the same as mentioned in the 'Creating a Chart' section.<br />
<br />
Here is an example video of how you can create a filter.<br />
<br />
{{#ev:youtube|https://youtu.be/fFWRQGXfsMQ}}<br />
<br />
== Publishing a Dashboard ==<br />
Once you create a dashboard, for other users to view the dashboard it needs to be published. To do that, go to the Dashboard tab and click on the 'Edit Record' button on the actions tab. Scroll down to the selection of 'Published'. Tick the Published checkbox and save your changes.<br />
<br />
Here is an example video of how you can publish a Dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/DOb6dsaPfBA}}<br />
<br />
== Customizing the look and feel ==<br />
For all of the chart types as mentioned above, there is a 'Customize' Tab in each of the charts. This tab is used to customize the look and feel of the chart.<br />
<br />
Some of the customizations include: <br />
* Changing the color scheme<br />
* Sorting the data by a column<br />
* Adding Data Labels<br />
* Changing the X/Y Axis labels<br />
* Changing the X/Y Axis Data Formats<br />
* Filtering the data by a condition<br />
<br />
'''Note -''' Each chart will have its own Customize options. Not all charts will have all the customisations listed above.<br />
<br />
Here is an example video of how you can customise the look and feel of a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/V5RGvZywKtU}}</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Create_your_own_custom_dashboards&diff=1369Create your own custom dashboards2020-07-23T10:02:25Z<p>Amit: </p>
<hr />
<div>== Getting started with Datonis BI ==<br />
The tool can be accessed by logging into the following link: <u><nowiki>https://bi.datonis.io/</nowiki></u><br />
<br />
The same Datonis MInt credentials can be used to log into the tool. If you have already logged into Datonis MInt, the tool will automatically load by visiting the above-mentioned link.<br />
<br />
[[File:Altizon BI Homepage.png|600x600px]]<br />
<br />
A page showing Dashboards will come up. These are all the dashboards that are already created on this account.<br />
<br />
'''Note –''' The account used in this manual is our sales demo account which already has some dashboards created. If you are a new user, the list will be blank.<br />
<br />
== Basic Concepts ==<br />
<br />
There are 2 elements to remember while creating a Dashboard in Datonis BI:<br />
# '''Charts''' – A chart is a visualisation element (e.g. bar chart, pivot table, pie chart, filter box).<br />
# '''Dashboards''' – Dashboard is a collection of one or many charts which together provide some business value.<br />
The workflow to create a dashboard is as follows:<br />
<br />
[[File:Steps to create Dashboard.png|498x498px]]<br />
<br />
== Creating a Chart ==<br />
Click on the 'Charts' Tab at the top left of the screen.<br />
<br />
[[File:Create a chart.png|600x600px]]<br />
<br />
Similar to the Dashboard page, a page showing the list of charts is shown.<br />
<br />
To create a new chart, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
[[File:Create a new chart.png|600x600px]]<br />
<br />
A new page showing the chart configuration will be shown. The next step is to choose the [[Analytics Data Model|data source]] and visualisation type.<br />
<br />
In the ‘Choose a datasource’ drop down, the user will be able to see all the datasources available in his/her account.<br />
<br />
In the ‘visualisation type’ the user can select a chart from a vast variety of chart types.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
=== Chart Types ===<br />
Altizon BI has a rich set of data visualisation components. Some of them are explained below.<br />
# '''Line Chart''' - A line chart displays information as a series of data points connected by a line. This chart can be used to plot a quantity that varies over a time range. E.g. The trend of energy consumption over a period of a week.<br />
# '''Dual Line Chart''' - A dual-axis line chart uses two axes to display the relationship of two differently scaled components. E.g. The trend of Production and Rejection quantity.<br />
# '''Table''' - A table lets you select the data from a set of components and displays in a tabular form. <br />
# '''Pivot Table''' - A pivot table allows you to summarise your data easily. This chart helps you to answer your questions with minimal effort.<br />
# '''Bar Chart''' - A bar/ column chart displays categorical information with vertical bars showing the value of the categorical component.<br />
# '''Time Series Bar Chart''' - Similar to a bar chart, this displays categorical information with it's value over a time range.<br />
# '''Pie Chart''' - A pie chart is used to show relative sizes of data.<br />
# '''Histogram''' - A histogram shows the shape and spread of the data being visualized.<br />
# '''Treemap'''- A treemap shows categorical component magnitude as a colour difference. E.g. Part Cycle Time Ratio - The values <=1 show a GREEN color while the values >1 show RED; meaning that the Cycle Times falling in RED are taking more time the standard cycle times.<br />
# '''Big Number''' - This chart just shows a component value. E.g. to monitor the total number of alerts generated for the selected duration.<br />
# '''Box Plot''' - The box plot shows the distribution of data using 5 metrics ( min, first quartile, median, third quartile, and max).<br />
# '''Bubble Chart''' - Bubble/ Scatter chart plots a series of data points to see if there is any correlation between 2 components.<br />
# '''and others...'''<br />
<br />
Here is an example video of how you can create a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/k3nuNbrJLL8}}<br />
<br />
The below shows a step-by-step way to create a chart.<br />
<br />
Clicking on the ‘Table’ button (default selection of Table) will pop up a screen showing all the supported visualisations. The user will have to select one and then click on ‘Create New Chart’.<br />
<br />
[[File:Create a chart page.png|600x600px]]<br />
<br />
A new page with two sections will open. The section on the left is the chart type configuration and the section on the right is the chart data rendering section (marked in Red and Blue respectively).<br />
<br />
[[File:Chart page options.png|600x600px]]<br />
<br />
The left section is used to configure the settings like Time column, Metrics, Series etc. which are dependent on the visualisation type the user chooses.<br />
<br />
The example shown in this case is for a Bar Chart. The bar chart will have a Categorical variable on the X- axis and a Numeric variable on the Y-axis.<br />
<br />
On top of the left section, there are 2 tabs:<br />
<br />
1. '''Data -''' This tab contains the configuration related to the data being viewed in the chart.<br />
<br />
2. '''Customise -''' This tab contains the look and feel settings for the selected visualisation type.<br />
<br />
<br />
Some of the features are explained in the example below.<br />
<br />
'''1.''' Let us say, we want to create a chart showing average OEE by Workcenters.<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter<br />
<br />
'''Note –''' In metrics, you will need to provide an aggregation function amongst the list already provided. Check below image for more details.<br />
<br />
[[File:Chart page options - aggregate functions.png|600x600px]]<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Rendering the chart.png|600x600px]]<br />
<br />
<br />
'''2.''' Let us say, you want to segregate the average OEE by Shift to identify which Shift contributed to what OEE percent? Also, we need bar values and stacked bars.<br />
<br />
In this case, the configurations will be Metrics: OEE, Series: Workcenter, Breakdowns: Shift Name<br />
<br />
When you select the configuration, click on 'Run Query' button on the top left for the chart to render in the right section.<br />
<br />
[[File:Changing some configuration of the chart.png|600x600px]]<br />
<br />
This completes the first requirement of Avg OEE by Workcenter and Shift. The second requirement is more of a look-and-feel change which can be done using the 'Customize' tab.<br />
<br />
In Customize tab, we need to tick options: Bar Values and Stacked Bars. The final output looks like this:<br />
<br />
[[File:Rendering the chart with changes in the configuration section.png|600x600px]]<br />
<br />
'''Note -''' Each visualisation type will have different Data and Customize selections.<br />
<br />
Once you are satisfied with the chart and its look and feel, the chart needs to be saved by clicking on the 'Save' button on the top left side of the screen.<br />
<br />
Once you click on the Save button, a popup will be shown. The chart needs to be given a name by which it will be visible on the Dashboard.<br />
<br />
There are 2 ways to add a Chart to a Dashboard.<br />
<br />
1. Directly from the Save menu saying, ‘Add chart to existing dashboard’ or ‘Add to new dashboard.’<br />
<br />
2. Create a dashboard from the Dashboards page, open the dashboard and then add a Chart to it.<br />
<br />
[[File:Saving a chart.png|600x600px]]<br />
<br />
Once you save the dashboard, it will be visible as a row in the Charts page list.<br />
<br />
[[File:Chart List.png|600x600px]]<br />
<br />
If you select 'Add to new Dashboard', a dashboard will also be created, and this chart will be added in the newly created dashboard.<br />
<br />
<br />
== Creating a Dashboard ==<br />
Here is an example video of how you can create a dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/dxU1pTMXG8A}}<br />
<br />
<br />
The below shows a step-by-step way to create a dashboard.<br />
<br />
Click on the 'Dashboards' Tab at the top left of the screen.<br />
<br />
To create a new dashboard, click on the (+) sign on the top right or click on '+ New' button on the page and select Chart.<br />
<br />
A configuration page will open. On this page, the user has to enter the Title, Owners (if multiple people need to edit the dashboard) and select/unselect 'Published' checkbox and then click on 'Save'. By selecting Published checkbox, all users having access to the underlying data source can view the dashboard.<br />
<br />
The dashboard will be visible as a row in the Dashboards page list.<br />
<br />
[[File:Dashboard List.png|600x600px]]<br />
<br />
Click on the Dashboard name to access the dashboard.<br />
<br />
[[File:Open the created Dashboard.png|600x600px]]<br />
<br />
You can see that a blank dashboard has been created. Now we need to add our created chart into this Dashboard. To do this, click on ‘Edit dashboard’ button on the top right of the screen.<br />
<br />
This will open an 'Insert Components' tab in which you need to select your charts and filters.<br />
<br />
[[File:Insert Components Tab.png|600x600px]]<br />
<br />
This will list all the charts that have been created using this account.<br />
<br />
[[File:Chart List in components tab.png|600x600px]]<br />
<br />
Select the chart we created and drag it to the blank screen.<br />
<br />
[[File:Adding a chart to the dashboard.png|600x600px]]<br />
<br />
This will add the chart to the dashboard. You can resize the chart by using the arrow at the bottom right of the chart. <br />
<br />
[[File:Resizing the chart.png|600x600px]] <br />
<br />
Once you are satisfied with the layout, click on ‘Save changes’ and the dashboard will be ready.<br />
<br />
[[File:Final Dashboard.png|600x600px]]<br />
<br />
== Adding a Filter ==<br />
A filter is a chart type that is used to narrow down the data selection based on user selection. E.g. Shift Filter can be used to specify which shifts to consider, Workcenter Filter specifies which workcenters' data to consider etc.<br />
<br />
Similar to any other chart, the chart to use here is 'Filter Box'. Rest of the steps for adding it to the dashboard are the same as mentioned in the 'Creating a Chart' section.<br />
<br />
Here is an example video of how you can create a filter.<br />
<br />
{{#ev:youtube|https://youtu.be/fFWRQGXfsMQ}}<br />
<br />
== Publishing a Dashboard ==<br />
Once you create a dashboard, for other users to view the dashboard it needs to be published. To do that, go to the Dashboard tab and click on the 'Edit Record' button on the actions tab. Scroll down to the selection of 'Published'. Tick the Published checkbox and save your changes.<br />
<br />
Here is an example video of how you can publish a Dashboard.<br />
<br />
{{#ev:youtube|https://youtu.be/DOb6dsaPfBA}}<br />
<br />
== Customizing the look and feel ==<br />
For all of the chart types as mentioned above, there is a 'Customize' Tab in each of the charts. This tab is used to customize the look and feel of the chart.<br />
<br />
Some of the customizations include: <br />
* Changing the color scheme<br />
* Sorting the data by a column<br />
* Adding Data Labels<br />
* Changing the X/Y Axis labels<br />
* Changing the X/Y Axis Data Formats<br />
* Filtering the data by a condition<br />
<br />
'''Note -''' Each chart will have its own Customize options. Not all charts will have all the customisations listed above.<br />
<br />
Here is an example video of how you can customise the look and feel of a chart.<br />
<br />
{{#ev:youtube|https://youtu.be/V5RGvZywKtU}}</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Analytics_Data_Model&diff=1368Analytics Data Model2020-07-23T09:32:46Z<p>Amit: </p>
<hr />
<div>== Data Model ==<br />
The Analytics Data Model is divided into 3 sections:<br />
# '''Workcenter Shift Productivity Data Model'''<br />
# '''Part Shift Productivity Data Model'''<br />
# '''Hourly Data Model'''<br />
<br />
<br />
=== Workcenter Shift Productivity Data Model ===<br />
MInt Productivity data, that is data about performance. This data is rolled up at the shift level for shift level productivity analysis.<br />
<br />
Here is a diagram that represents the data model. <br />
<br />
[[File:MINT Analytics Data Model - WorkCenterShiftFact.jpg|600x600px]] <br />
<br />
The main tables are: <br />
<br />
'''WorkcenterShiftFact'':''''' Productivity data is centred around a 'workcenter' (essentially a machine that is performing the task). This table contains the primary shift-level productivity parameters.<br />
<br />
'''WorkcenterShiftDownTimeReasonsFact''': Downtime represents the time duration for which the machine was non-operational. This table contains information about durations and reasons for the downtimes of a workcenter for a given shift.<br />
<br />
'''WorkcenterShiftRejectionsFact''': Rejections are the quality defects that occurred on a workcenter. The table contains information about these quality rejections for a workcenter for a shift and the reasons for it.<br />
<br />
'''WorkcenterShiftOperatorsFact''': This table contains information about the operators working on the workcenter for a given shift.<br />
<br />
'''WorkcenterShiftProductivityDownTimeReasonsFact''': Performance loss is the metric to highlight the less-than-ideal rate at which the machine was working. If the machine is working slower than the expected (ideal) rate, the user can book a performance loss and associate a reason for it. This table contains the performance loss downtime information.<br />
<br />
'''WorkcenterShiftProductionParametersFact''': The table contains Production parameter data at a shift level. Production parameters are used to store the production quantity in different units based on customer requirements.<br />
<br />
e.g. Some customers want to measure production quantity in Batch Counts but for their internal assessment, they need Batch Weight. In such cases, MInt will show Batch Count and Batch Weight will be sent to their internal system (say the customer's ERP system).<br />
<br />
Please refer to the following link for [[Data Model Column Descriptions|description of each table column]].<br />
<br />
<br />
'''Examples of using the object model to create a chart:'''<br />
<br />
Here is an example video of how you can use the data model to analyze [[Create your own custom dashboards|average OEE by Workcenters]].<br />
<br />
{{#ev:youtube|https://youtu.be/faSzdxPDy8s}}<br />
<br />
<br />
<br />
=== Part Shift Productivity Data Model ===<br />
MInt Part Productivity data gives insights about your part level performance. This data is rolled up at the shift level for doing shift level part productivity analysis.<br />
<br />
Here is a diagram that represents the data model.<br />
<br />
[[File:MINT Analytics Data Model - WorkcenterPartRoutingShiftFact.jpg|600x600px]]<br />
<br />
The main tables are:<br />
<br />
'''WorkcenterPartRoutingShiftFact:''' The Part Productivity data is centred around a part that is being produced on the workcenter. This table contains the primary shift level part productivity parameters.<br />
<br />
'''WorkcenterPartRoutingShiftDownTimeReasonsFact:''' Downtime represents the time duration for which the machine was non-operational. This table contains information about the downtimes that occurred throughout the duration for which a part was booked within a shift and the reasons for those downtimes.<br />
<br />
'''WorkcenterPartRoutingShiftRejectionsFact:''' Rejections are the quality defects that occurred on a workcenter. The table contains information about these quality rejections for a part for a shift and the reasons for it.<br />
<br />
'''WorkcenterPartShiftProductionParametersFact:''' The table contains Production parameter data at a part and shift level. Production parameters are used to store the production quantity in different units based on customer requirements.<br />
<br />
e.g. Some customers want to measure production quantity in Batch Counts but for their internal assessment, they need Batch Weight. In such cases, MInt will show Batch Count and Batch Weight will be sent to their internal system (say the customer's ERP system).<br />
<br />
<br />
'''Examples of using the object model to create a chart:'''<br />
<br />
Here is an example video of how you can use the data model to analyze Part Cycle Times by Shift.<br />
<br />
{{#ev:youtube|https://youtu.be/JyZc0Y8lWfk}}<br />
<br />
<br />
<br />
=== Hourly Data Model ===<br />
MInt Hourly Data is aggregation of Condition Based Monitoring (CBM), Part Process Quality, and Performance. This data is rolled up at an hourly level.<br />
<br />
Here is a diagram that represents the data model.<br />
<br />
[[File:MINT Analytics Data Model - WorkcenterHourlyFact.jpg|600x600px]]<br />
<br />
The main tables are:<br />
<br />
'''WorkcenterHourlyFact:''' Productivity data is centred around a 'workcenter' (essentially a machine that is performing the task). This table contains the primary hourly level productivity parameters.<br />
<br />
'''WorkcenterHourlyCbmParamsFact:''' Condition Based Monitoring (CBM) is the process of monitoring a key parameter in a workcenter (vibration, temperature etc.). This helps in locating a significant change which may be indicative of a developing fault in a machine. The table contains information about the CBM parameters, their control limits and details of violations.<br />
<br />
'''WorkcenterHourlyProcessParamsFact:''' Process parameters are the parameters dependant on the part (temperature of Part-1, temperature of Part-2 etc.). This helps in identifying a significant change that may be indicative of developing a quality defect. The table contains information about the Process parameters, their control limits and details of violations.<br />
<br />
'''WorkcenterHourlyProcessRoutingFact:''' The table contains Part - Operation information for each part at an hourly level.<br />
<br />
'''WorkcenterPartHourlyProdParamsFact:''' The table contains production parameter data at a part and hourly level. Production parameters are used to store the production quantity in different units based on Customer requirements.<br />
<br />
e.g. Some customers want to measure production quantity in Batch Counts but for their internal assessment, they need Batch Weight. In such cases, MInt will show Batch Count and Batch Weight will be sent to their internal system (say the customer's ERP system).<br />
<br />
<br />
'''Examples of using the object model to create a chart:'''<br />
<br />
Here is an example video of how you can use the data model to analyze CBM Parameter Violations by Hour.<br />
<br />
{{#ev:youtube|https://youtu.be/IifqrIOofP4}}</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Data_Model_Column_Descriptions&diff=1367Data Model Column Descriptions2020-07-23T09:12:26Z<p>Amit: </p>
<hr />
<div>== Workcenter Shift Productivity Data Model ==<br />
<br />
=== WorkcenterShiftFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|license_key<br />
|Unique ID for the account<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|is_primary<br />
| -<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|cycles<br />
|Number of strokes of the machine<br />
|-<br />
|production_quantity<br />
|Cycles * Parts per cycle<br />
|-<br />
|actual_production_time<br />
|The time required to produce X parts in given time T<br />
|-<br />
|available_time<br />
|Maximum time available for production<br />
|-<br />
|downtime<br />
|Total time for which the machine was idle<br />
|-<br />
|unplanned_downtime<br />
|Time during which the machine had an Unplanned downtime reason booking<br />
|-<br />
|planned_downtime<br />
|Time during which the machine had a Planned downtime booking<br />
|-<br />
|expected_production_time<br />
|Standard/ Target Time required to produce X parts in given time T<br />
|-<br />
|idle_slot_count<br />
|The count of total idle slots<br />
|-<br />
|major_stoppages<br />
|The count of downtimes for major stoppages (threshold defined in MInt Workcenter Configuration)<br />
|-<br />
|minor_stoppages<br />
|The count of downtimes for minor stoppages (threshold defined in MInt Workcenter Configuration)<br />
|-<br />
|rejection_quantity<br />
|Total Rejected Part Quantity<br />
|-<br />
|availability<br />
|Availability metric for OEE Calculation<br />
|-<br />
|performance<br />
|Performance metric for OEE Calculation<br />
|-<br />
|quality<br />
|Quality metric for OEE Calculation<br />
|-<br />
|capacity_utilization<br />
|The metric to identify planned downtimes<br />
|-<br />
|oee<br />
|Overall Equipment Effectiveness (A * P * Q)<br />
|-<br />
|teep<br />
|Total Effective Equipment Performance (OEE * CU)<br />
|-<br />
|compressed_air<br />
|Utilities Air Compression Details<br />
|-<br />
|electricity<br />
|Utilities Electricity Details<br />
|-<br />
|steam<br />
|Utilities Steam Details<br />
|-<br />
|gas<br />
|Utilities Gas Details<br />
|}<br />
<br />
=== WorkcenterShiftDownTimeReasonsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|reason_key<br />
|Unique ID for the downtime reason<br />
|-<br />
|license_key<br />
|Unique ID for the account<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|duration<br />
|Machine Downtime duration in seconds<br />
|-<br />
|idle_slot_count<br />
|The count of total idle slots<br />
|-<br />
|name<br />
|Downtime Reason Name<br />
|-<br />
|code<br />
|Downtime Reason Code<br />
|-<br />
|category_key<br />
|Unique ID for Downtime Category<br />
|-<br />
|category_code<br />
|Downtime Category Code<br />
|-<br />
|category_name<br />
|Downtime Category Name<br />
|-<br />
|is_reason<br />
|If Downtime Reason is a reason<br />
|-<br />
|is_planned<br />
|If Downtime Reason is a Planned reason<br />
|-<br />
|key<br />
|Unique ID for Downtime Reason<br />
|}<br />
<br />
=== WorkcenterShiftOperatorsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|operator<br />
|Operator Name<br />
|-<br />
|license_key<br />
|Unique ID for the account<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|Shift_name<br />
|Shift Name in MInt<br />
|}<br />
<br />
=== WorkcenterShiftRejectionsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|rejection_key<br />
|Unique ID for the Rejection Code<br />
|-<br />
|license_key<br />
|Unique ID for the account<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|rejection_name<br />
|Rejection Name<br />
|-<br />
|rejection_code<br />
|Rejection Code<br />
|-<br />
|rejection_quantity<br />
|Rejection Quantity<br />
|}<br />
<br />
=== WorkcenterShiftProductionParametersFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|parameter_key<br />
|Unique ID for the Parameter<br />
|-<br />
|license_key<br />
|Unique ID for the account<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|parameter_name<br />
|Parameter Name on MInt<br />
|-<br />
|parameter_count<br />
|Count of Parameters<br />
|-<br />
|metric_name<br />
|Datonis Metric Name<br />
|-<br />
|unit<br />
|Unit of measure of the parameter<br />
|}<br />
<br />
=== WorkcenterShiftProductivityDownTimeReasonsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|reason_key<br />
|Unique ID for Downtime Reasons<br />
|-<br />
|license_key<br />
|Unique ID for the account<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|duration<br />
|Machine Downtime duration in mins<br />
|-<br />
|loss_slot_count<br />
|The count of slots which are idle<br />
|-<br />
|name<br />
|Downtime Reason Name<br />
|-<br />
|code<br />
|Downtime Reason Code<br />
|-<br />
|category_key<br />
|Unique ID for Downtime Category<br />
|-<br />
|category_code<br />
|Downtime Category Code<br />
|-<br />
|category_name<br />
|Downtime Category Name<br />
|-<br />
|is_reason<br />
|If Downtime Reason is a reason<br />
|}<br />
<br />
== Part Shift Productivity Data Model ==<br />
<br />
=== WorkcenterPartRoutingShiftDownTimeReasonsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|part_key<br />
|Unique ID for the Part/ SKU<br />
|-<br />
|routing_key<br />
|Unique ID for the Operation<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|reason_key<br />
|Unique ID for the Downtime Reason<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|part_name<br />
|Part Name<br />
|-<br />
|routing_name<br />
|Operation Name<br />
|-<br />
|duration<br />
|Machine Downtime duration in seconds<br />
|-<br />
|idle_slot_count<br />
|The count of total idle slots<br />
|-<br />
|name<br />
|Downtime Reason Name<br />
|-<br />
|code<br />
|Downtime Reason Code<br />
|-<br />
|category_key<br />
|Unique ID for Downtime Reason Code<br />
|-<br />
|category_code<br />
|Downtime Category Code<br />
|-<br />
|category_name<br />
|Downtime Category Name<br />
|-<br />
|is_reason<br />
|If Downtime Reason is a reason<br />
|-<br />
|is_planned<br />
|If Downtime Reason is a Planned reason<br />
|}<br />
<br />
=== WorkcenterPartRoutingShiftFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|part_key<br />
|Unique ID for the Part/ SKU<br />
|-<br />
|routing_key<br />
|Unique ID for the Operation<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|part_name<br />
|Part Name<br />
|-<br />
|routing_name<br />
|Operation Name<br />
|-<br />
|parts_per_cycle<br />
|The quantity of parts produced in one cycle of the machine<br />
|-<br />
|cycles<br />
|Number of strokes of the machine<br />
|-<br />
|production_quantity<br />
|Cycles * Parts per cycle<br />
|-<br />
|acutal_production_time<br />
|The time required to produce X parts in given time T<br />
|-<br />
|available_time<br />
|Maximum time available for production<br />
|-<br />
|downtime<br />
|Total time for which the machine was idle<br />
|-<br />
|unplanned_downtime<br />
|Time during which the machine had an Unplanned downtime reason booking<br />
|-<br />
|planned_downtime<br />
|Time during which the machine had a Planned downtime booking<br />
|-<br />
|expected_production_time<br />
|Standard/ Target Time required to produce X parts in given time T<br />
|-<br />
|standard_cycle_time<br />
|The standard time required to produce one Part (only machine working time)<br />
|-<br />
|standard_loading_time<br />
|The standard time required to load one Part<br />
|-<br />
|standard_unloading_time<br />
|The standard time required to unload one Part<br />
|-<br />
|standard_autocycle_time<br />
|This is the addition of Standard Cycle Time, Standard Loading Time and Standard Unloading Time.<br />
|-<br />
|actual_cycle_time<br />
|The actual time required to produce one Part (only machine working time)<br />
|-<br />
|actual_loading_time<br />
|The standard time required to load one Part<br />
|-<br />
|actual_unloading_time<br />
|The standard time required to unload one Part<br />
|-<br />
|actual_autocycle_time<br />
|This is the addition of Actual Cycle Time, Actual Loading Time and Actual Unloading Time.<br />
|-<br />
|compressed_air<br />
|Utilities Air Compression Details<br />
|-<br />
|electricity<br />
|Utilities Electricity Details<br />
|-<br />
|steam<br />
|Utilities Steam Details<br />
|-<br />
|gas<br />
|Utilities Gas Details<br />
|-<br />
|is_last_routing<br />
|If an operation is the last in that particular routing, this flag will be True.<br />
|-<br />
|rejection_count<br />
|Count of Quality Rejections<br />
|}<br />
<br />
=== WorkcenterPartRoutingShiftRejectionsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|part_key<br />
|Unique ID for the Part<br />
|-<br />
|routing_key<br />
|Unique ID for the Operation<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|rejection_key<br />
|Unique ID for the Rejection Code<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|part_name<br />
|Part Name<br />
|-<br />
|routing_name<br />
|Operation Name<br />
|-<br />
|quantity<br />
|Rejection Quantity<br />
|-<br />
|name<br />
|Rejection Name<br />
|-<br />
|code<br />
|Rejection Code<br />
|}<br />
<br />
=== WorkcenterPartShiftProductionParametersFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|part_key<br />
|Unique ID for the Part<br />
|-<br />
|parameter_key<br />
|Unique ID for the Parameter<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|part_name<br />
|Part Name<br />
|-<br />
|parameter_name<br />
|Parameter Name on MInt<br />
|-<br />
|parameter_count<br />
|Count of Parameters<br />
|-<br />
|metric_name<br />
|Datonis Metric Name<br />
|-<br />
|unit<br />
|Unit of measure of the parameter<br />
|}<br />
<br />
== Hourly Data Model ==<br />
<br />
=== WorkcenteHourlyFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|pph_from<br />
|Hour Start Time<br />
|-<br />
|pph_to<br />
|Hour End Time<br />
|-<br />
|idle_slot_count<br />
|The count of total idle slots<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|job_count<br />
|Number of strokes of the machine<br />
|-<br />
|actual_qty<br />
|Cycles * Parts per cycle<br />
|-<br />
|actual_production_time<br />
|The time required to produce X parts in given time T<br />
|-<br />
|downtime<br />
|Total time for which the machine was idle<br />
|-<br />
|planned_downtime<br />
|Time during which the machine had a Planned downtime booking<br />
|-<br />
|unplanned_downtime<br />
|Time during which the machine had an Unplanned downtime reason booking<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|rejection_count<br />
|Rejection Quantity<br />
|-<br />
|scrap_count<br />
|Scrap Quantity (Custom metric if Scrap is monitored for that Customer)<br />
|-<br />
|operators<br />
|Operator Name (List of operator working in that hour)<br />
|-<br />
|part_names<br />
|Part Name (List of Parts produced in that hour)<br />
|-<br />
|part_keys<br />
|Unique IDs for the Parts<br />
|-<br />
|electricity<br />
|Utilities Electricity Details<br />
|-<br />
|gas<br />
|Utilities Gas Details<br />
|-<br />
|steam<br />
|Utilities Steam Details<br />
|-<br />
|compressed_air<br />
|Utilities Air Compression Details<br />
|-<br />
|_created_at<br />
|Internal metric, not to be used by User<br />
|-<br />
|_updated_at<br />
|Internal metric, not to be used by User<br />
|}<br />
<br />
=== WorkcenteHourlyRoutingEnergyFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|pph_from<br />
|Hour Start Time<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|routing_key<br />
|Unique ID for the Operation<br />
|-<br />
|part_key<br />
|Unique ID for the Part/ SKU<br />
|-<br />
|pph_to<br />
|Hour End Time<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|part_name<br />
|Part Name<br />
|-<br />
|part_code<br />
|Part Code<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|utility_name<br />
|Utility Name<br />
|-<br />
|metric_name<br />
|Metric Name in Datonis<br />
|-<br />
|consumption_value<br />
|Consumption Value<br />
|-<br />
|_created_at<br />
|Internal metric, not to be used by User<br />
|-<br />
|_updated_at<br />
|Internal metric, not to be used by User<br />
|}<br />
<br />
=== WorkcenteHourlyProcessRoutingFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|pph_from<br />
|Hour Start Time<br />
|-<br />
|parameter_key<br />
|Unique ID for the Parameter<br />
|-<br />
|routing_key<br />
|Unique ID for the Operation<br />
|-<br />
|parent_part_key<br />
|Unique ID for the Part/ SKU<br />
|-<br />
|pph_to<br />
|Hour End Time<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|parameter_name<br />
|Parameter Name<br />
|-<br />
|metric_name<br />
|Metric Name in Datonis<br />
|-<br />
|status<br />
|1 being Good (points inside warning limits), 2 being Warning (points outside warning limits and below control limits) and 3 being Problem (points outside control limits)<br />
|-<br />
|points_between_lcl_lwl<br />
|Count of Points Between Lower Control Limit and Lower Warning Limit<br />
|-<br />
|lwl<br />
|Lower Warning Limit for the selected parameter/s<br />
|-<br />
|max<br />
|Max value for the selected parameter/s<br />
|-<br />
|points_below_lcl<br />
|Count of Points Below Lower Control Limits<br />
|-<br />
|cpk<br />
|Process Capability Index (CpK)<br />
|-<br />
|uwl<br />
|Upper Warning Limit for the selected parameter/s<br />
|-<br />
|lcl<br />
|Lower Control Limit for the selected parameter/s<br />
|-<br />
|ucl<br />
|Upper Control Limit for the selected parameter/s<br />
|-<br />
|cp<br />
|Process Capability (Cp)<br />
|-<br />
|count<br />
|Count for the selected parameter/s<br />
|-<br />
|avg<br />
|Average value for the selected parameter/s<br />
|-<br />
|points_between_uwl_ucl<br />
|Count of Points Between Upper Warning Limit and Upper Control Limit<br />
|-<br />
|min<br />
|Minumum value for the selected parameter/s<br />
|-<br />
|sum<br />
|Addition for the selected parameter/s<br />
|-<br />
|median<br />
|Median value for the selected parameter/s<br />
|-<br />
|expected_value<br />
|Expected/ Target value for the selected parameter/s<br />
|-<br />
|stddev<br />
|Standard Deviation for the selected parameter/s<br />
|-<br />
|points_above_ucl<br />
|Count of Points above the Upper Control Limit<br />
|-<br />
|points_out_of_warning_limit<br />
|Count of Points out of Warning Limits<br />
|-<br />
|operators<br />
|Operator Name (List of operator working in that hour)<br />
|-<br />
|part_names<br />
|Part Name (List of Parts produced in that hour)<br />
|-<br />
|part_keys<br />
|Unique IDs for the Parts<br />
|-<br />
|_created_at<br />
|Internal metric, not to be used by User<br />
|-<br />
|_updated_at<br />
|Internal metric, not to be used by User<br />
|}<br />
<br />
=== WorkcenteHourlyProcessParamsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|pph_from<br />
|Hour Start Time<br />
|-<br />
|parameter_key<br />
|Unique ID for the Parameter<br />
|-<br />
|pph_to<br />
|Hour End Time<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|parameter_name<br />
|Parameter Name on MInt<br />
|-<br />
|metric_name<br />
|Metric Name in Datonis<br />
|-<br />
|status<br />
|1 being Good (points inside warning limits), 2 being Warning (points outside warning limits and below control limits) and 3 being Problem (points outside control limits)<br />
|-<br />
|points_between_lcl_lwl<br />
|Count of Points Between Lower Control Limit and Lower Warning Limit<br />
|-<br />
|max<br />
|Max value for the selected parameter/s<br />
|-<br />
|points_below_lcl<br />
|Count of Points Below Lower Control Limits<br />
|-<br />
|cpk<br />
|Process Capability Index (CpK)<br />
|-<br />
|cp<br />
|Process Capability (Cp)<br />
|-<br />
|count<br />
|Count for the selected parameter/s<br />
|-<br />
|avg<br />
|Average value for the selected parameter/s<br />
|-<br />
|points_between_uwl_ucl<br />
|Count of Points Between Upper Warning Limit and Upper Control Limit<br />
|-<br />
|min<br />
|Minumum value for the selected parameter/s<br />
|-<br />
|sum<br />
|Addition for the selected parameter/s<br />
|-<br />
|median<br />
|Median value for the selected parameter/s<br />
|-<br />
|stddev<br />
|Standard Deviation for the selected parameter/s<br />
|-<br />
|points_above_ucl<br />
|Count of Points above the Upper Control Limit<br />
|-<br />
|points_out_of_warning_limit<br />
|Count of Points out of Warning Limits<br />
|-<br />
|part_keys<br />
|Unique IDs for the Parts<br />
|-<br />
|part_names<br />
|Part Name (List of Parts produced in that hour)<br />
|-<br />
|operators<br />
|Operator Name (List of operator working in that hour)<br />
|-<br />
|_created_at<br />
|Internal metric, not to be used by User<br />
|-<br />
|_updated_at<br />
|Internal metric, not to be used by User<br />
|}<br />
<br />
=== WorkcenteHourlyCbmParamsFact ===<br />
{| class="wikitable"<br />
!Column Name<br />
!Description<br />
|-<br />
|machine_key<br />
|Unique ID for the Workcenter<br />
|-<br />
|shift_key<br />
|Unique ID for the Shift<br />
|-<br />
|pph_from<br />
|Hour Start Time<br />
|-<br />
|working_day<br />
|Day for which the shifts are planned<br />
|-<br />
|parameter_key<br />
|Unique ID for the Parameter<br />
|-<br />
|pph_to<br />
|Hour End Time<br />
|-<br />
|parameter_name<br />
|Parameter Name on MInt<br />
|-<br />
|metric_name<br />
|Metric Name in Datonis<br />
|-<br />
|status<br />
|1 being Good (points inside warning limits), 2 being Warning (points outside warning limits and below control limits) and 3 being Problem (points outside control limits)<br />
|-<br />
|points_between_lcl_lwl<br />
|Count of Points Between Lower Control Limit and Lower Warning Limit<br />
|-<br />
|lwl<br />
|Lower Warning Limit for the selected parameter/s<br />
|-<br />
|max<br />
|Max value for the selected parameter/s<br />
|-<br />
|points_below_lcl<br />
|Count of Points Below Lower Control Limits<br />
|-<br />
|cpk<br />
|Process Capability Index (CpK)<br />
|-<br />
|uwl<br />
|Upper Warning Limit for the selected parameter/s<br />
|-<br />
|ucl<br />
|Upper Control Limit for the selected parameter/s<br />
|-<br />
|lcl<br />
|Lower Control Limit for the selected parameter/s<br />
|-<br />
|cp<br />
|Process Capability (Cp)<br />
|-<br />
|count<br />
|Count for the selected parameter/s<br />
|-<br />
|avg<br />
|Average value for the selected parameter/s<br />
|-<br />
|points_between_uwl_ucl<br />
|Count of Points Between Upper Warning Limit and Upper Control Limit<br />
|-<br />
|min<br />
|Minumum value for the selected parameter/s<br />
|-<br />
|expected_value<br />
|Expected/ Target value for the selected parameter/s<br />
|-<br />
|sum<br />
|Addition for the selected parameter/s<br />
|-<br />
|median<br />
|Median value for the selected parameter/s<br />
|-<br />
|stddev<br />
|Standard Deviation for the selected parameter/s<br />
|-<br />
|points_above_ucl<br />
|Count of Points above the Upper Control Limit<br />
|-<br />
|points_out_of_warning_limit<br />
|Count of Points out of Warning Limits<br />
|-<br />
|shift_name<br />
|Shift Name in MInt<br />
|-<br />
|machine_name<br />
|Workcenter Name in MInt<br />
|-<br />
|dept_name<br />
|Department Name in MInt<br />
|-<br />
|cell_line_name<br />
|Cell/ Line Name in MInt<br />
|-<br />
|plant_name<br />
|Plant Name in MInt<br />
|-<br />
|_created_at<br />
|Internal metric, not to be used by User<br />
|-<br />
|_updated_at<br />
|Internal metric, not to be used by User<br />
|}</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Datonis_Business_Intelligence&diff=1366Datonis Business Intelligence2020-07-22T12:36:13Z<p>Amit: </p>
<hr />
<div>== Introduction to Datonis Business Intelligence ==<br />
Datonis BI is a web based business intelligence tool. It provides an easy-to-use interface for exploring and visualizing data. It provides a rich set of data visualization components and the ability to build custom dashboards for analysing your data. <br />
<br />
Datonis BI has been built on top of [https://superset.incubator.apache.org/ Apache Superset], an open-source enterprise-ready business intelligence web application. Superset users will find the interface very familiar. Any differences will be called out in this documentation. <br />
<br />
To help plant users get started quickly, Datonis BI comes pre-built with data models that are built on top of Datonis MInt. If you are an existing Datonis MInt user, please refer to the [[Datonis Manufacturing Intelligence Beta|MInt data model documentation]] to understand MInt concepts in more detail.<br />
<br />
== Getting started with Datonis BI ==<br />
Datonis BI documentation is structured into the following main modules:<br />
<br />
* Data Model - This has information regarding the table structure and entity-relationship diagrams. <br />
:'''[[Analytics Data Model|Learn more about the data model]]'''<br />
* Dashboard Builder- A user manual to help the user create his/her own custom dashboards<br />
:'''[[Create your own custom dashboards|Learn more about creating custom dashboards]]'''</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Datonis_Manufacturing_Intelligence&diff=1005Datonis Manufacturing Intelligence2019-06-20T09:28:23Z<p>Amit: Fixed a few typos and extra spaces. No content change.</p>
<hr />
<div>==Getting started with Datonis Manufacturing Intelligence==<br />
Datonis Manufacturing Intelligence is a cloud based hosted software used to bring the organizations (Plant) manufacturing related data together from many sources spreading across the multiple dimensions. Many BI tools are very mature in data presentation and flexible in adaptation, but this doesn’t help those working on the shop floors that need to contextualize their analysis of data with the actions they are performing. Propagation of the information between systems and people (including shop floor operators) is the real need of the manufacturing industry. Following are the different aspects of Datonis Manufacturing Intelligence.<br />
*This includes Productivity, Quality, Energy, Work order.<br />
*This is intended mainly for reporting, analysis, visual summaries, and passing data between enterprise level and plant floor systems.<br />
*Datonis Manufacturing Intelligence greatly depicts the manufacturing process covering the different segments of Industrial manufacturing.<br />
*Ability to present data in the context of the end user activities.<br />
Datonis Manufacturing Intelligence is been structured in following main modules.<br />
<br />
==Productivity with Datonis Manufacturing Intelligence==<br />
Productivity is the important aspect of Datonis Manufacturing Intelligence. It is one of the basic variables governing economic production activities. However, at the same time as productivity is seen as one of the most vital factors affecting a manufacturing company’s competitiveness. Datonis Manufacturing Intelligence covers the Productivity at the Plant, Department, Cell/Line and at Work center level. A Cell is a logical un-ordered set of work centers where as Line is an ordered set of work centers. This means that there is a sequential work that happens when producing a part. The Line can be considered as subset of Cells.<br />
*'''Productivity at Plant Level''': Productivity workspace captures the productivity elements at all the Organization level. This includes Plant, Cell/Line and Work center. Under this workspace, Productivity at a Plant level is covered as a landing screen. This view gives the productivity at the selected Plant from the filter. This has broadly following sections:<br />
*# Cells: This shows the cell-wise distribution of Uptime, Down Time, Production Quantity for all the Work centers falling in each Cell.<br />
*# Lines: This shows the Line-level Uptime, Down Time, Production Quantity. This also shows if each line will be active or inactive.<br />
*# Work orders: Work order section depicts the status of all the work orders running in the plant. This essentially covers following aspects:<br />
*## This shows the overview of the Work orders that are finished , orders which are on target ,work orders which are lagging in the schedule and the number of work orders which need attention.<br />
*## This also gives the further drill down view of all the running work orders with the Part and its progress of production. This drill down view is helpful to see the information related to each work order to track its progress with the planned quantity and its actual quantity produced<br />
*## There is a link provided the further drill down of each of the work order if we hover on the Work order Number.<br />
*## There is also a link provided for the Part analysis if we hover on the Part name. This link shows the quality aspects of the selected part and its rejections as well. (Covered in detailed in the Quality section)<br />
*'''Productivity at the Cell level''' ''':''' When user clicks on the VIEW LIVE link from the Cells/Lines, this shows the Time line chart of all the work centers under that Cell/Line. The Time line Cell level view is the Live Dashboard view showing the current status of each work center. This also shows the productive and idle slot in the current shift till the time. This also shows live production quantity, total uptime and down time of each work center. There is also a link provided on each work center on the live dashboard to drill down further at a work center level.<br />
*'''Productivity at the Line level''': From the productivity workspace if the Organization is comprised of the Line, the Line view will be shown. When the user clicks on the VIEW LIVE, this is actually showing th live dashboard of the selected line for which the VIEW LIVE link is clicked. The Live Dashboard of the selected Line will show the Highlights section. This shows the status of the Line. This will be the status of the last work center in the sequence configured in the Line definition. (Line configuration by design). This also shows the production of the last work center in the Line definition. There is also the Production Time line section which shows the time line (productive and idle) of the last work center configured under the Sequence Work center under Line configuration. Under the Work centers section individual work center performance (Production Quantity, Up Time, Planned Down Time, Availability, Performance, OEE, CU, Operator assigned on that work center) is bee shown. There is also a link provided if user clicks on the Work center. This is navigated to the Work center Analysis report.<br />
*'''Drill down with Work center Level:''' Work center Analysis is the report showing the performance of the work center for the selected date and shift. This mainly depicts OEE, availability, performance, Quality. This also shows the Total Production, Capacity Utilization (CU), Up Time and Down Time. This also shows the Productive and Idle Time line view of the Work center. This report also shows the Parts per Hour distribution of the selected date for the selected shift. The Work center Analysis report can be also navigated from the Reports menu under the sub menu as Productivity.<br />
*'''Reports (Productivity)''': There are different reports covered under this.<br />
<br />
'''[[Productivity Reports|Learn more about Productivity reports]]'''<br />
==Quality Workspace with Datonis Manufacturing Intelligence==<br />
Quality is another important aspect of Datonis Manufacturing Intelligence. The continuous efforts to deliver the quality products while balancing optimal throughput is an important measure to help manage manufacturing processes. The effects of quality bottlenecks can be reflected across the entire line or cell. Datonis Manufacturing Intelligence tries to cover the quality aspects of it from the rejection bookings and its impact can be also represented in the application in its reports.<br />
<br />
'''[[Quality Workspace|Learn more about Quality workspace and its reports]]'''<br />
<br />
==Condition Based Monitoring (CBM) Workspace with Datonis Manufacturing Intelligence==<br />
Condition Based Monitoring is the process of monitoring a parameter of condition in work center (vibration, temperature etc.), in order to identify a significant change which is indicative of a developing fault. Condition monitoring has a unique benefit in that conditions that would shorten normal lifespan can be addressed before they develop into a major failure. Datonis Manufacturing Intelligence has added a separate workspace in this release and will be having more advancements in this module in the upcoming releases. Although there are few master data configuration related changes for CBM module. Those will be covered in the Master Data Configuration Section.<br />
<br />
'''[[Condition Based Monitoring|Learn more about Condition based monitoring reports]]'''<br />
==Energy Workspace with Datonis Manufacturing Intelligence==<br />
<br />
Datonis Manufacturing Intelligence also covers the Energy workspace. This gives an overview of the Utilities configured in the Plant. There are 3 out of the box utilities that are targeted in this version of Datonis Manufacturing Intelligence. These include electricity,Compressed Air and Steam.<br />
# Energy Dashboard: This is the Plant level utilities consumption view. This covers the Highlights covering all the configured Utilities. It shows Kilowatt Hour consumption (Kwh) for Electricity, amount of compressed air for Compress Air and Steam consumed (Kg). This report also shows the Cell Summary which is nothing but the utilization of these metrics in each cell. There is a link provided for the further drill down on the Cell. <br />
# Cell Analysis: This report shows the utilities consumption for Electricity, Steam and Compressed Air for a Cell under Highlights. There is also a detailed section showing this data for the each work center for that Cell. There are out of the box three utilities supported in Datonis Manufacturing Intelligence. One can configure it from these. The cell analysis also shows the work center level resource consumed and we can get the details of it by further clicking on the link provided on the work center name.<br />
# Workcenter Analysis: This shows the overview of configured utilities consumed under the Highlights Section. This also shows the hourly electricity Consumption, Hourly Compressed Consumption and Hourly Steam consumption in a bar chart. <br />
# Energy Configuration: Datonis Manufacturing Intelligence has introduced the Energy as a separate workspace capturing the utilities consumption. We can configure these utilities for the Workcenter under Configure Workcenter Parameters. Here we can add a Parameter and map into a metric from the Thing associated to that Workcenter on Datonis. When we select the metric and map it to thing, we can map it to the type of Energy from Electricity, Steam etc. Selecting the Parameter Type as Energy allows it to select it from the Utilities supported in Datonis Manufacturing Intelligence.<br />
<br />
==Workorder with Datonis Manufacturing Intelligence==<br />
A Work order is another workspace added in Datonis Manufacturing Intelligence. This captures the overall production happened for a Part for the planned work order. This workspace gives the detailed view of the work order progress. Datonis Manufacturing Intelligence also allows to create the Work order entities for a Plat and for a Part. This basically describes the deliverables planned for the given time-frame. Work order also maintains its life cycle in terms of when it is planned vs when it is completed and other aspects of it.<br />
* Work order Configuration: Under the Actions there is a Work order option to create the Work order. The Work order can be created for the selected Part. There has to be planned quantity to be added in the Work order. The work order also has the time duration for which this work order is planned. When the production user is making the production booking he will be able to associate this work order with the actual production done in that time. Apart from creating the work orders, this is also used to get the overall insight of all the work orders in that plant for the selected time/date frame. This gives a tabular view of the production done for each of the work order. This gives the insight of Planned Start and Planned End along with the Actual Start and Actual End based on the Production booking done. This view also allows certain operations/actions which can be performed on each work order. This includes deleting a Work order, Marking the work order as a finished work order.<br />
<br />
* Workorders Dashboard:This view shows a detailed insight of a work order in a Plant. This mainly captures following:<br />
* Planned vs Completed Quantity : This gives the pictorial view of each work order and its planned/completed count. Planned vs Actual time line: This view gives the details of how each work oder is performing. This is helpful to check which are the lagging work orders in their completion and which are on track work orders. The gantt chart representation helps to track this.<br />
* There is also a tabular view of each of the work order showing its performance. This gives a detailed insight of each work order. There is also a link provided to get into further details of the Workorder Analysis.<br />
* Workorder Analysis: This view shows the Planned vs Completed count of each work order.<br />
<br />
'''[[Workorders|Learn more about Workorders reports]]'''<br />
<br />
==Actions ==<br />
The Bookings are added under the Actions menu. There are two kinds of Bookings.<br />
# The Production Booking allows to associate the Part, Operation from the Routing to the actual Parts produced from the slots. This also allows to associate the Work order to the batch/lot produced in actual data which is represented in Time line. The Production booking is an important process which is required to be followed when to need to see the Planned vs actual production. The steps for the Production booking are captured in the video.<br />
'''[[Production Booking|Learn how to perform Production Booking]]'''<br />
<br />
# The Loss Code booking can be also done under the Production menu from the Bookings option. Here also we need to select the slots for which the down time reason code is required to be added. For an operator this an important booking which will calculate the availability in the OEE calculations. The steps for this are captured in the video. <br />
'''[[Reason Code (Loss) Booking|Learn how to perform Loss Code Booking]]'''<br />
<br />
# Rejection Booking: The Rejection Booking at the Shift level can be done. There is a setting which we need to apply at a Shift level while creating a Workcenter. If this is set at Shift level and we have done the Production booking for time frame , we can do the quality booking of it and associate the Rejection Code and Rejected Quantity for same. If a Slot level configuration setting is been provided for a workcenter option for booking the rejection at the Shift level under this menu is not possible. <br />
'''[[Rejection Booking|Learn how to perform Rejection Booking]]'''<br />
<br />
# Failure Mode:The manner in which an equipment or machine failure can occur. The typical failure modes can be premature operation, failure to operate at the prescribed time, failure to cease operation at the prescribed time, failure during operation. The CBM failure modes which are added in Datonis Manufacturing Intelligence can be booked under this. We can take a look at the CBM parameters data for the time period for which this Failure Mode is been booked. This helps to look at the consequences of the failures and the parameters causing those.<br />
<br />
==Do It Yourself ReportsIntegration for Analytics with Datonis Manufacturing Intelligence==<br />
MInt supports the analytics application with the reports which the user can create on their own. This helps to show the descriptive analytical reports covering the Productivity Workspace from MInt. This helps in creating a rich set of data visualizations. It also provides an easy-to-use interface for exploring and visualizing data. This allows to create and share dashboards to the users. This is the DIY framework (Do It with Yourself) which will allow the user to create their own reports. There are out of the box following reports created:<br />
* Production Insight By Workcenter : This will show the Production KPIs like Uptime, Down Time, Availability, Performance, Quality , OEE, Planned vs Unplanned Time for each workcenter.<br />
* Production Trend : This report will show the Production trend across the days for all the Workcenters in the Organization.<br />
* Loss Insight : Loss Insight report will help to see the details about the losses happened. This helps to see which are the Losses having more time booked and also helps to see the losses per workcenter.<br />
* MTBF and MTTR : For the selected Loss/ Reason code this reports shows the Mean Time Between Failure and Mean Time To Recover.</div>Amithttps://docs.datonis.io/mediawiki/index.php?title=Edge_Gateway_Installation_and_Basic_Configuration&diff=995Edge Gateway Installation and Basic Configuration2019-06-19T07:09:46Z<p>Amit: Setup instructions for Linux had a copy-paste error.</p>
<hr />
<div> [[Datonis Edge Gateway|Edge Gateway Home]] > '''Installation and Basic Configuration'''<br />
<br />
== Purpose ==<br />
This document describes the procedure to employ the revised Datonis Edge Gateway in your environment.<br />
<br />
== System Requirements ==<br />
<br />
=== Operating System ===<br />
The Datonis Edge Gateway is certified to run on:<br />
* Windows 7 or above<br />
* Linux 3.x kernel or above<br />
<br />
=== Memory Requirements ===<br />
Recommended free memory requirement to run Edge Gateway is 256 MB. Available free memory can be checked on Linux using command 'free -m'.<br />
<br />
Edge gateway can be started with minimum 64 MB available free memory in the constrained environments.<br />
<br />
=== Datonis Cloud Connectivity Protocols ===<br />
* HTTP (80)<br />
* HTTPS (443)<br />
* MQTT (1883)<br />
* MQTTS (8883)<br />
<br />
=== Internet Connectivity ===<br />
Internet connectivity is required so that the gateway can do outbound connections to either of the ports (80 - HTTP, 443 - HTTPS, 1883 - MQTT, 8883 - MQTTS).<br />
<br />
For HTTP/HTTPS, you can also configure a HTTP proxy if there is no direct internet connectivity available.<br />
<br />
=== Java ===<br />
Gateway needs Java 1.8 or higher to work. Please download Java from [http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html Oracle site].<br />
<br />
== Supported Data Sources ==<br />
The Datonis Edge Gateway supports following data sources (via configurable adapters) to collect data and push it to the Altizon’s Datonis Platform.<br />
<br />
==== [[Edge Gateway Modbus Adapter|Modbus Adapter]] ====<br />
<br />
==== [[Edge Gateway OPC UA Adapter|OPC UA Adapter]] ====<br />
<br />
==== [[Edge Gateway OPC DA Adapter|OPC DA Adapter]] ====<br />
<br />
==== [[Edge Gateway Http Adapter|HTTP Adapter]] ====<br />
<br />
==== [[Edge Gateway MTConnect Adapter|MTConnect Adapter]] ====<br />
<br />
==== [[Edge Gateway CSV adapter|CSV Adapter]] ====<br />
<br />
==== XML Adapter ====<br />
<br />
==== EtherNet/IP Adapter ====<br />
<br />
==== MQTT Adapter ====<br />
<br />
==== PROFINET Adapter ====<br />
<br />
==== Script Adapter (Push) ====<br />
<br />
==== Script Adapter (Pull) ====<br />
<br />
== Package Structure ==<br />
<br />
=== Before Install ===<br />
datonis-edge-x.x.x<br />
|--- bin<br />
|--- commons-daemon-1.0.15<br />
|--- scripts<br />
|--- config<br />
|--- plugins<br />
|--- altizon<br />
|--- common<br />
|--- equinox_3.8.1<br />
|--- kura<br />
* '''bin''' directory contains all the scripts required to install/run the Datonis Edge Gateway. '''install_edge_service.bat''' will install gateway as a windows service. '''uninstall_edge_service.bat''' will uninstall windows service, note that it does not delete copied files.<br />
* config directory contains initial configuration of the gateway, these config files will be copied and modified in various directories during installation. Gateway will refer to the copied files further. You may not need to update any configuration as configuration changes can be done via browser UI. '''log4j.properties''' can be modified to control logging of the gateway.<br />
* plugins directory contain all the plugin jars required for gateway to run<br />
<br />
=== After Install ===<br />
datonis-edge-x.x.x<br />
|--- bin<br />
|--- config<br />
|--- plugins<br />
|--- data<br />
|--- db<br />
|--- keystore<br />
|--- paho-persistence<br />
|--- snapshots<br />
|--- tmp<br />
|--- log<br />
|--- packages<br />
* '''data''' directory contains the application database (db), saved configurations (snapshots), ssl configurations (keystore) and transport data (paho-persistence)<br />
* '''log''' directory contains gateway logs and service logs<br />
* '''tmp''' directory contains the modfiied config files that are specific to the current installation, this directory will be used by running gateway to refer to initial configuration<br />
* '''packages''' directory holds the runtime plugin packages installed via console ui<br />
<br />
== Installation ==<br />
<br />
=== Windows ===<br />
On windows, below scripts are present in the bin directory<br />
* '''install_edge_service.bat''' Runnning this batch file will install gateway as Windows service that will have automatic start-up and will run in the context of localsystem account. The name of the installed service is DatonisEdge (display name: Datonis Edge)<br />
* '''uninstall_edge_service.bat''' Running this batch file will stop and uninstall DatonisEdge service.<br />
* '''start_edge_debug.bat''' This batch file will start gateway as a console OSGi application where debug commands can be sent to OSGi console to check which plugins are loaded.<br />
* '''stop_edge_debug.bat''' This batch file will kill gateway service and should be used in rare circumstances. Windows service can be stopped from Service Manager application (services.msc). Console application can be stopped by typing Ctrl+C in the application window or typing Close command.<br />
<br />
=== Linux ===<br />
On linux, below bash scripts are present in bin directory<br />
* '''install_edge_service.sh''' This sh script will start gateway as a linux service. The service will run in context of root user. Java must be installed on that system in root context. The name of the installed service is datonis-edge.<br />
* '''uninstall_edge_service.sh''' Running this script will stop and uninstall datonis-edge service.<br />
* '''start_edge_service.sh''' This will start installed datonis-edge service.<br />
* '''stop_edge_service.sh''' This will stop datonis-edge background service<br />
* '''start_edge_debug.sh''' This script will start gateway as a console OSGI application, where user can interact with OSGI console for advanced activities.<br />
* '''stop_edge_debug.sh''' This script will send kill signal to running gateway application. User can stop OSGI console application by using CTRL+C in terminal. This script provide same mechanism for background tasks.<br />
<br />
=== Docker ===<br />
Datonis Edge can be installed in the form of Docker container from 5.2 release onward. The Docker image is based on minimal Debian with only necessary dependencies making it lightweight. Docker container supports easy upgrade too. In order to switch to newer release, one has stop old container and run new command line. Container installation inherently eliminates the need for installing dependencies such as particular version of JRE etc. Its also easy to change default ports of web console to different ports in case default ports are used by some other service.<br />
* '''docker command line to install''' (example build no. 5.2.585) docker run --name datonis-edge-5.2.585 --mount type=volume,source=edge-vol,target=/opt/datonis-edge-data --publish 8080:8080 --publish 8443:8443 --detach altizon/linux-edge:5.2.585<br />
<br />
== Gateway Configuration ==<br />
After installation Gateway Configuration can be accessed via '''https://127.0.0.1:8443/edge''' or '''http://127.0.0.1:8080/edge'''<br />
<br />
=== Changing Web Console Credentials ===<br />
The default console username and password are '''admin/admin'''. This can be changed via '''Services → Web Console''' settings.<br />
<br />
[[File:Web-console-edge-1.png|1056x1056px]]<br />
<br />
=== Changing Access Key and Secret Key ===<br />
The gateway requires access key and secret key in order to connect to Datonis platform. These keys can be changed via '''Cloud Services → EdgeCloudService''' Service settings.<br />
<br />
[[File:Cloud-service-edge.png]]<br />
<br />
=== Changing Transport Mechanism and Data Service Settings ===<br />
By default gateway will send data using secure Mqtt transport which is recommended. The transport can be changed to Http via turning on setting '''connect.use-http-transport''' found at '''Cloud Services → EdgeDataService'''.<br />
<br />
Other EdgeDataService related settings are self documented and need to be changed in rare cases.<br />
<br />
[[File:Data-service-edge.png]]<br />
<br />
=== Using Http Proxy to connect to Datonis ===<br />
If Http Transport is selected to communicate with Datonis then its possible to use Http Proxy for Datonis Platform connectivity. Setting '''use-proxy''' has to be enabled and other '''proxy.'''* settings need to have appropriate values.<br />
<br />
These settings can be accessed via '''Cloud Services → HttpDataTransport'''.<br />
<br />
[[File:Http-transport-edge.png]]<br />
<br />
=== Device Tab ===<br />
This tab shows information about Gateway Runtime and underlying device info<br />
* '''Profile''' - lists Device information, Hardware information, Software information and Java details.<br />
* '''Bundles''' - lists OSGi bundles loaded by the gateway at that time<br />
* '''Threads''' - lists threads consumed by gateway<br />
* '''System Properties''' - lists configuration parameters of gateway jvm<br />
* '''Command''' - for future use<br />
[[File:Device-edge.png]]<br />
<br />
=== Settings Tab ===<br />
This tab allows to set system wide settings<br />
* '''Snapshots''' - this page allows to download currently applied configuration to the system in a single xml file. This also provides the facility to rollback, upload and apply kind of functionality. The '''Upload and Apply''' is particularly useful in case of upgrade or moving installation to some other directory.<br />
* '''SSL Configuration''' - this page allows details out the certificate store path used by the gateway. The default keystore password is '''changeit'''. This can be changed if needed. This certificate store (keystore) will store Server SSL certificate and Device SSL certificate.<br />
* '''Server SSL Certificate''' - this is a public certificate that will be stored as the trusted certificate. This certificate details needs to be in rfc text format i.e. '''pem file format'''.<br />
* '''Device SSL Certificate''' - the device SSL certificate is private public key pair of the gateway certificate. In adapter communication where mutual authentication is needed the required certificate with private key can be installed from this page. The Private Key and Certificate text has to be in pem file format.<br />
<br />
[[File:Setings-edge.png]]<br />
<br />
=== Other Settings ===<br />
* The '''Status''' denotes whether Datonis Platform is accessible via selected transport i.e. Mqtt or Http. Note that at present, this does not check whether valid access and secret key has been entered or not.<br />
* The '''Packages''' tab allows to deploy custom bundles/plugins in the gateway e.g. any third party adapter.<br />
<br />
== Adapter Configuration ==<br />
Refer to [[Edge Gateway Adapter Common Configuration|Adapter Common Configuration]] Page for more details</div>Amit