The Opcenter Intelligence data source for Dashboard Designer¶

The Opcenter Intelligence data source allows you to display the following data in Insights Hub Dashboard Designer:

• Opcenter Intelligence manufacturing data warehouse (MDW) data (by means of its OData interface). The MDW contains data ingested from MES systems to be used to contextualize Insights Hub OEE and Insights Hub IoT data.

• KPI calculation results to perform data analysis. In particular, you can calculate:

  • A single KPI with an applied filter.
  • A single KPI with an applied filter and a grouping criterion.
  • A single KPI with an applied filter and a target matrix.
  • Multiple KPIs with an applied filter.

To this purpose, the "Query" area includes two tabs. Depending on the selected tab, the list of selectable fields on the left changes:

• "Query": for standard OData-based queries.
• "Manufacturing KPI": for KPI calculation queries.

Prerequisites¶

• You have configured an Opcenter Intelligence solution and deployed the environment.
• The Data Exposition Service to read data from Opcenter Intelligence manufacturing data warehouse has been activated.

If you want to display KPI calculation results, the following requirements must also be met:

• You have created one or multiple KPIs in Opcenter Intelligence.
• You have configured one or more KPI filters. You can also use the "OPCIN_DEFAULT_FILTER" created automatically when you create a new custom or standard KPI.
• (Optional) You have configured one or more KPI grouping criteria.
• (Optional) You have configured one or more KPI target matrices.

Creating an Opcenter Intelligence data source query to display Opcenter Intelligence MDW data¶

1. Click "Dashboards" in the left-hand navigation menu.
2. Click "New" and select "New dashboard" from the drop-down list.
3. Click "+ Add visualization".
4. Select "Opcenter Intelligence" from the data source list.
5. On Insights Hub Dashboard Designer Query page, click "Select Opcenter Intelligence Entity" and choose an entity from the list (this is the OData entity for the query). Entities may differ depending on the configuration. The format of manufacturing data warehouse entities is "bm20_entity name", while entities configured for smart views have the "smart view name_entity name" format.
6. Choose the relevant columns of the entity by selecting the "Select Fields" option. If this field is left empty, all columns are selected.
7. (Optional) Click "Expand" to choose the entities that have a direct relationship with the entity selected in the previous step and their relevant information. For example, you can expand the site and equipment fields to further explore related data. Once you have selected a related entity, a row with the name of the entity is added where its columns can be selected. You can expand entities up to three levels.
8. Select the MDW entity: the "+ Add filter" button is enabled.
9. Set the "DateTime Column" to choose date and time entity if in your visualizations you need to filter data based on time. If no date and time is displayed, it means no datetime columns are available. For more details, see Using DateTime Columns in Opcenter Intelligence data source.
10. Click "+ Add Filter" to define one or more filters. Multiple filters are applied with the AND operator.
11. Under the "Field" column, select the fields where you want to apply the filter. You can select all fields, including those you can navigate by means of the navigation properties.
12. Under the "Operator" column, select the operator to apply to the field. Values vary depending on the field selected in the previous step. If you are using a multi-value variable, you have to select the IN operator.
13. Select a variable you have previously created. For details, see Creating an Opcenter Intelligence dashboard variable. Alternatively, you can add a custom value.
14. The final OData query is automatically generated and displayed in the Query Text area. Use the "Update Query Text" option to manually edit this query if you want to add further filters or other oData query options.
15. Click "Run Query". The requested data is shown in the panel. Proceed configuring your visualization(s) according to your requirements.

Dashboard Variables¶

You can configure query variables to fetch dynamic data from Opcenter Intelligence data source and fill in the values to be chosen in your dashboards. Variables are available for all dashboards and visualizations. You can also create and use variables from a different data source, for example Insights Hub OEE, and filter data for the data source that contains the variable.

Creating an Opcenter Intelligence dashboard variable¶

1. Select "Dashboard Settings".
2. Choose the "Variables" tab and click "Add Variable".
3. Set the parameters to configure the variable:
   • select the variable type from those available (Query, Text Box, Custom or Constant)
   • enter a suitable name for the variable
   • select "Opcenter Intelligence" as data source
4. Click "Select Opcenter Intelligence Entity" and choose an entity from the list.
5. Choose the relevant entities by selecting the "Select Fields" option: the query is automatically generated and displayed in the Query Text field.
6. (Optional) Select how to sort the variable values (disabled by default).
7. In the "Selection" options section, select either the "Multi-value" option to allow the selection of multiple values, or the "Include All" option to select all values at once: in the Preview of values area, the available values for the variable are shown.
8. Click "Apply" and save the dashboard.

Creating an Opcenter Intelligence data source query to analyze KPI calculation results¶

1. Click "Dashboards" in the left-hand navigation menu.
2. Click "New" and select "New dashboard" from the drop-down list.
3. Click "+ Add visualization".
4. Select "Opcenter Intelligence" from the data source list.
5. On the Query page, open the "Manufacturing KPI" tab.
6. Click "Select Opcenter Intelligence KPI" and choose one of the available KPIs.
7. In the "KPI Filter" drop-down menu, select a filter. The list of corresponding parameters becomes visible. Note: Selecting a filter is mandatory.
   Examples:
   • If you select a custom filter, the corresponding configured parameters will appear.
   • If you select the OPCIN_DEFAULT_FILTER, the parameters include @SiteName, @AssetKey, @FromTime, @ToTime.
8. For each parameter, you can provide values, either by entering a custom value directly in the input field or by using a variable selected from the variables menu.
   • Parameters may be pre-filled automatically if their names match those used in the standard filter (@FromTime, @ToTime).
   • If during KPI configuration, parameters were given custom names, they will not auto-fill and must be selected manually.
9. Once filters and their values are set, click "Run KPI" to execute the calculation. Results are displayed in the upper area of the page.
10. You may also select a "Grouping" criterion to aggregate results or select a "Target Matrix". Important: Grouping and Target Matrix aggregations are mutually exclusive.
11. From the panel on the right, you can select a visualization mode for the KPI(s) (for example: Gauge).
12. Targets can be added manually in the panel or retrieved from Opcenter Intelligence configuration (if available).
13. When visualizing the KPI results, you can change the value of a variable to automatically update the calculated KPI result. Variables are defined using the procedure below.
14. You can create and run multiple queries by clicking "Add Query". You can mix standard OData queries and KPI queries or use KPI-only queries.

Using DateTime columns in Opcenter Intelligence data source¶

When filtering data by time, it is recommended to use columns containing datetime in UTC format, considering the following facts:

• In the bm20 schema, all datetime columns are in UTC format, except those with "local" in their name.
• In smart views, datetime columns are in local time by default, except those with "UTC" in their name.
• Local time refers to the time zone of the site associated with the data.

If you filter data by time using a column in UTC format, the selected date is automatically converted into UTC.

Examples¶

Reference documentation for Opcenter Intelligence¶

You can refer to the Opcenter Intelligence Reference Manual for more information on:

• Opcenter Intelligence manufacturing data warehouse entities.
• Opcenter Intelligence supported OData functionalities.

For more information on how to configure and use Opcenter Intelligence and on KPIs, refer to the Opcenter Intelligence User Manual.

Opcenter Intelligence documentation is available to customers who sign in to the Support Center with Insights Hub/Siemens ID credentials.