What's New in Historian 2024 | Proficy Historian 2024 Documentation

Description	Tracking ID
Configuration Hub Enhancements Configuration Hub provides a better user experience using an IDE model to manage systems, bringing in consistency across the portfolio to manage the configuration and administration of multiple products. The following Historian specific enhancements are made in Configuration Hub:
Ability to register and manage Configuration Hub plugin for Historian: You can manage the Configuration Hub plugin for Historian using Configuration Hub. You can register a plugin, unregister a plugin, modify a plugin, and view Historian node and plugin-specific details using the Node Manager. For more information, refer to Historian plugin management.	F69440
Ability to browse tag details when primary node is inactive: In a horizontally scaled system, when a primary server's central configuration manager is inactive, you can still browse tags by adding distributed or mirror nodes as a backup for the primary server. When you add a node as the backup, the Data Archiver of that node functions as the Configuration Manager, and sends the relevant tag information to the client manager. To facilitate this enhancement, a new Support for Browse Tags, if primary server down property has been added in the Systems > GENERAL section of the DETAILS section. For more information, refer to browse tags using distributed or mirror node servers when primary server is inactive.	F69877
Create custom templates for common configurations: You can create configuration templates for both data stores and collectors separately. To facilitate this enhancement, a new Configuration Templates section has been added in the Configuration Hub plugin for Historian. Within the Configuration Templates, you are provided with two different tabs, one tab to configure collector-specific template, and the other tab to configure data store-specific template. Note: You can apply a data store configuration template to a user-created data store, provided they are not set as the default data store. For more information, refer to Configuration templates.
Ability to reset collector overruns: You can reset overrun count of a collector instance to zero without restarting the collector. To facilitate this enhancement, a new collector action Reset Overruns has been added. For more information, refer to Reset Overruns.	F70190
Ability to be notified when a restart of collector instance is required: When you modify certain configurations of a collector instance, you will be prompted to restart the collector instance. To facilitate this enhancement, a new confirmation dialog has been added. Whenever you modify certain configuration and save, you will be prompted with an option to restart the collector instance. If you decide not to restart, a notification will be displayed in the DETAILS section, stating that the selected collector instance needs a restart. Note: The modification(s) will take effect only after you restart the collector instance. For more information, refer to Modify collector instance.
Ability to validate the destination Historian connection while adding a collector instance: You can test a destination Historian server's connection status while adding a collector instance. This will enable you to connect to a valid, and an active destination Historian server. To facilitate this enhancement, a new Test Connection button has been added in the Collector Initiation section, and also in the Update Collector Credentials: <Collector name> window for all the collectors.
Ability to validate the source Historian connection while adding a Server-to-Server Collector or Server-to-Server Distributor collector instance: You can test a source Historian server's connection status while adding a collector instance. This will enable you to connect from a valid, and an active source Historian server. To facilitate this enhancement, a new Test Connection button has been added in the Source Configuration section.
Ability to configure multiple tags at once: You can select multiple tags and configure their common configurations at once. To facilitate this enhancement, you are now enabled to select multiple tags using their corresponding check boxes, or you can select all the available tags using the check box available in the grid's header. For more information, refer to Configure multiple tags.
Ability to add and view the actual unit of measure of a tag's value: You can add the actual unit of measure of a tag's value. This will help you to view and add more context to a tag's value that you pull. To facilitate this enhancement, a new EGU Description property has been added in the SCALING section of tag's DETAILS section. The engineering unit that you provide will be displayed under the Engineering Units column in the table view, and as a tool tip in the trend view, when you view the view the last 10 values of the tag, or when you generate a query/write report in the Data page. For more information, refer to the SCALING section in Access Tags.
Ability to view Tag Creation Audit Trail: You can view the Tag Creation Audit Trail details for a tag. To facilitate this enhancement, new Created By, and Created Time properties have been added in the Tags > DETAILS > GENERAL section.
Ability to add a stale period check for data store level: You can view the number of days or the frequency for checking data store validity. To facilitate this enhancement, a new Stale Period (Days) property has been added in the MAINTENANCE section in the Data Stores DETAILS section. For more information, refer to the MAINTENANCE section in Access a Data Store.
Ability to Import/Export: You can import/export tags and their details, user defined-defined types (UDT), and Enumerated sets in a CSV format. This will enable you to export the data, modify the data, and then import them back using Configuration Hub. To facilitate this enhancement, the and buttons have been added in the corresponding sections. For more information, refer to the following sections: Import, and Export tag details. Import, and Export UDT. Import, and Export Data Attribute Enumerated sets. Import, and Export Enumerated Sets.
Ability to view the grid count and navigate through grids: You can view a grid's total and selected count, and when there are more than 100 rows in a grid, you can use the page numbers to navigate through the grid details. To facilitate this enhancement, grid count (total and selected) and page numbers have been added below a grid.
Implement Data Store-level security: Similar to tag-level security, you can also define data store-level security to protect sensitive tags. Note: However, the security settings defined at the tag level, if any, take the precedence over those at the data store-level. To facilitate this enhancement, the following properties have been added in the SECURITY section, in the data store DETAILS section. For more information, refer to Implementing data store-level security.	F70957
Ability to configure multiple data archive paths: Multiple archive paths feature extends the ability to configure a default archive path for each data store. This feature enables you to automatically store your archives in different locations based on the age of the archive. It can be useful when splitting the data for a data store across multiple hard drives, primarily for performance and cost optimization. Additionally, it could help optimize disk space constraints. To facilitate this enhancement, a Multiple Archive Paths property has been added in the ARCHIVE CREATION section in the data store's DETAILS section. For more information, refer to Multiple archive paths.	F70956
Ability to configure security groups to use Proficy Authentication: You can configure Security Group at global (system) level to use Proficy Authentication. To facilitate this enhancement, a new Use Proficy Authentication option has been added to Security Group in the System's GLOBAL SECURITY section. If you select the Use Proficy Authentication option, the system will use the groups specific to Proficy Authentication (UAA) for authorization. Only the users or groups that belong to the Proficy Authentication will have specific permissions and access rights. For more information, refer to the GLOBAL SECURITY section in Access a System. Note: To use Proficy Authentication security group, you must perform the configurations listed in the Configurations to use Proficy Authentication Security Groups section.	F69870
Ability to generate configuration reports: You can generate report to get a concise summary of tag-specific data of a specific collector. You can select a report from the available predefined templates and generate a categorized report. Note: The reports are applicable only to the Historian destination collectors. To facilitate this enhancement, a new Reports section has been added in the Configuration Hub plugin for Historian. Within the Reports section, you are provided with a list of available predefined templates. You can select a template and generate its corresponding report and export it. For more information, refer to About reports.	F66520
Ability to save data query and access it: You can save queries that you use to read tags data. You can use this option to save queries that you may frequently use to read specific tags data. This will help you in the following: Quickly gather insights of specific tags. Create and save a predefined query only once and use it as needed. You can use the Shared option to make the query visible to the other users in the same network. Note: Once you share a query, all the other users will also be able to edit, and delete it. Be mindful about making a query as a shared query. To facilitate this enhancement, a new Save Query button has been added in the New Query tab. The button will appear after generating a Read Data report. Additionally, a new Saved Queries tab has been added, which contains the list of all saved queries. For more information, refer to Save a Query. You can also update a saved query. For more information, refer to Update a saved query.
Other Enhancements
Term Licensing: In parity with other products within the Proficy portfolio, Historian licensing also supports a term license model. This will give you the flexibility to subscribe to Historian for a subscription fee based on your requirement.	F69872
Enhanced data type support for MQTT Collector: The support of Array tags has been added for the MQTT Collector.
ETL Tools Enhancement: Performance improvements are made for the eDNA extractor.
New MQTT Sparkplug B Collector: You can connect as a Primary Host application and collect data based on the MQTT Sparkplug B specification (Sparkplug 3.0.0). Specifically, you can subscribe to a topic that was published using the Sparkplug B payload and collect time-series data in a structured and understandable format. To facilitate this enhancement, a new MQTT Sparkplug B Collector has been added. You can install this collector and configure it to collect data based on the MQTT Sparkplug B specification (Sparkplug 3.0.0). For more information, refer to MQTT Sparkplug B Collector.	F73170
Ability to extensively use the Python Collector: You can now extensively use Python collector. This collector is available for use in both the Configuration Hub and the Historian Administrator. However, for a seamless user experience, it is recommended to use the collector in the Configuration Hub. To facilitate this enhancement, the following enhancements have been added in the Configuration Hub: Dedicated Python script editor. Extensive list of built-in functions that you can use in your script. For more information, refer to Available functions. Extensive list of supported data types. For more information, refer to Supported data types. Capability to import third-party, custom Python modules and use them in the script. For more information, refer to Import third-party or custom Python Modules. Capability to configure path for the newly installed Python modules using Configuration Hub. For more information, refer to Configure Python Library Path.	F63933
Support for Mutual TLS (MTLS) Protocol for Enhanced Security: You can use MTLS protocol for Historian core services and also collectors. To facilitate this enhancement, the following enhancements have been added: Generating the required root certificate for Historian and core services can be done using the installer. You do not have to manually generate and trust the root certificates. For more information, refer to Certificate-based security for MTLS. An option to Enable MTLS Security for collector specific instances has been added in Configuration Hub. For more information, refer to Enable MTLS Security for Collectors. An option to encrypt the MTLS messages sent to Historian has been added. For more information, refer to Enable MTLS Security for Collectors.	F70082
Ability to create data attribute enumerated set: You can create and define a custom text for the quality status and view it in the Attributes column instead of the value when you retrieve the tag data. For example, if your tag is receiving bit positions indicating the quality status (that is, 1 for Old data, 2 for Bad data, and 30 for Good data), you can map the bit position to a custom text and assign it to a set. So, when you view the actual values of the tag, the Attributes column will display the mapped custom text instead of the integer (the bit positions). To facilitate this enhancement, in Configuration Hub, a new DATA ATRRIBUTE ENUMERATED SET option has been added in the Manage Enumerated Sets section. To enable data attribute enumerated set, you must set the DATA ATRRIBUTE ENUMERATED SET option to True. For more information, refer to about data attribute enumerated set . Note: Once you created a data attribute enumerated set in Configuration Hub, you can use it in Historian Administrator. However, it is not recommended to modify the created Data Attribute Enumerated set in the Historian Administrator. If you modify it using the Historian Administrator, the DATA ATTRIBUTE ENUMERATED SET field will be changed to False in Configuration Hub.	F73356
Ability to visualize and interact with Historian specific REST APIs using Swagger UI: You can now access Historian REST APIs using Swagger UI. This tool enables you to visualize and interact with the API resources without having any of the implementation logic in place, establishing a fully interactive documentation experience using Swagger. For more information, refer to Swagger Documentation.	F69878
Enhancements in Historian REST APIs for Tags Taglist API: To avoid pagination related issue, you can set the pagesize parameter to 0. This will provide all tags at once without any pagination. Engineering Units: Tag Data response now includes Engineering Units. For example, `{ "ErrorCode": 0, "ErrorMessage": null, "Data": [ { "TagName": "Test2020_Simulation.Simulation00001", "ErrorCode": 0, "DataType": "Float", "EngineeringUnits": null, "HiEngineeringUnits": 200000, "LoEngineeringUnits": 0, "Samples": [ { "TimeStamp": "2023-12-04T13:04:51.000Z", "Value": "93319.5", "Quality": 3, "DataAttributes": [] },`	F70197

Configuration Hub Enhancements

Configuration Hub provides a better user experience using an IDE model to manage systems, bringing in consistency across the portfolio to manage the configuration and administration of multiple products.

The following Historian specific enhancements are made in Configuration Hub:

Ability to register and manage Configuration Hub plugin for Historian: You can manage the Configuration Hub plugin for Historian using Configuration Hub. You can register a plugin, unregister a plugin, modify a plugin, and view Historian node and plugin-specific details using the Node Manager. For more information, refer to Historian plugin management.

F69440

Ability to browse tag details when primary node is inactive: In a horizontally scaled system, when a primary server's central configuration manager is inactive, you can still browse tags by adding distributed or mirror nodes as a backup for the primary server. When you add a node as the backup, the Data Archiver of that node functions as the Configuration Manager, and sends the relevant tag information to the client manager.
To facilitate this enhancement, a new Support for Browse Tags, if primary server down property has been added in the Systems > GENERAL section of the DETAILS section.
For more information, refer to browse tags using distributed or mirror node servers when primary server is inactive.

F69877

Create custom templates for common configurations: You can create configuration templates for both data stores and collectors separately.
To facilitate this enhancement, a new Configuration Templates section has been added in the Configuration Hub plugin for Historian. Within the Configuration Templates, you are provided with two different tabs, one tab to configure collector-specific template, and the other tab to configure data store-specific template.
Note: You can apply a data store configuration template to a user-created data store, provided they are not set as the default data store.
For more information, refer to Configuration templates.

Ability to reset collector overruns: You can reset overrun count of a collector instance to zero without restarting the collector. To facilitate this enhancement, a new collector action Reset Overruns has been added. For more information, refer to Reset Overruns.

F70190

Ability to be notified when a restart of collector instance is required: When you modify certain configurations of a collector instance, you will be prompted to restart the collector instance. To facilitate this enhancement, a new confirmation dialog has been added. Whenever you modify certain configuration and save, you will be prompted with an option to restart the collector instance. If you decide not to restart, a notification will be displayed in the DETAILS section, stating that the selected collector instance needs a restart.

Note: The modification(s) will take effect only after you restart the collector instance.

For more information, refer to Modify collector instance.

Ability to validate the destination Historian connection while adding a collector instance: You can test a destination Historian server's connection status while adding a collector instance. This will enable you to connect to a valid, and an active destination Historian server. To facilitate this enhancement, a new Test Connection button has been added in the Collector Initiation section, and also in the Update Collector Credentials: <Collector name> window for all the collectors.

Ability to validate the source Historian connection while adding a Server-to-Server Collector or Server-to-Server Distributor collector instance: You can test a source Historian server's connection status while adding a collector instance. This will enable you to connect from a valid, and an active source Historian server. To facilitate this enhancement, a new Test Connection button has been added in the Source Configuration section.

Ability to configure multiple tags at once: You can select multiple tags and configure their common configurations at once. To facilitate this enhancement, you are now enabled to select multiple tags using their corresponding check boxes, or you can select all the available tags using the check box available in the grid's header.

For more information, refer to Configure multiple tags.

Ability to add and view the actual unit of measure of a tag's value: You can add the actual unit of measure of a tag's value. This will help you to view and add more context to a tag's value that you pull. To facilitate this enhancement, a new EGU Description property has been added in the SCALING section of tag's DETAILS section.

The engineering unit that you provide will be displayed under the Engineering Units column in the table view, and as a tool tip in the trend view, when you view the view the last 10 values of the tag, or when you generate a query/write report in the Data page.

For more information, refer to the SCALING section in Access Tags.

Ability to view Tag Creation Audit Trail: You can view the Tag Creation Audit Trail details for a tag. To facilitate this enhancement, new Created By, and Created Time properties have been added in the Tags > DETAILS > GENERAL section.

Ability to add a stale period check for data store level: You can view the number of days or the frequency for checking data store validity. To facilitate this enhancement, a new Stale Period (Days) property has been added in the MAINTENANCE section in the Data Stores DETAILS section.

For more information, refer to the MAINTENANCE section in Access a Data Store.

Ability to Import/Export: You can import/export tags and their details, user defined-defined types (UDT), and Enumerated sets in a CSV format. This will enable you to export the data, modify the data, and then import them back using Configuration Hub. To facilitate this enhancement, the

and

buttons have been added in the corresponding sections.

For more information, refer to the following sections:

Import, and Export tag details.
Import, and Export UDT.
Import, and Export Data Attribute Enumerated sets.
Import, and Export Enumerated Sets.

Ability to view the grid count and navigate through grids: You can view a grid's total and selected count, and when there are more than 100 rows in a grid, you can use the page numbers to navigate through the grid details.

To facilitate this enhancement, grid count (total and selected) and page numbers have been added below a grid.

Implement Data Store-level security: Similar to tag-level security, you can also define data store-level security to protect sensitive tags.

Note: However, the security settings defined at the tag level, if any, take the precedence over those at the data store-level.

To facilitate this enhancement, the following properties have been added in the SECURITY section, in the data store DETAILS section. For more information, refer to Implementing data store-level security.

F70957

Ability to configure multiple data archive paths: Multiple archive paths feature extends the ability to configure a default archive path for each data store.

This feature enables you to automatically store your archives in different locations based on the age of the archive. It can be useful when splitting the data for a data store across multiple hard drives, primarily for performance and cost optimization. Additionally, it could help optimize disk space constraints.

To facilitate this enhancement, a Multiple Archive Paths property has been added in the ARCHIVE CREATION section in the data store's DETAILS section. For more information, refer to Multiple archive paths.

F70956

Ability to configure security groups to use Proficy Authentication: You can configure Security Group at global (system) level to use Proficy Authentication. To facilitate this enhancement, a new Use Proficy Authentication option has been added to Security Group in the System's GLOBAL SECURITY section. If you select the Use Proficy Authentication option, the system will use the groups specific to Proficy Authentication (UAA) for authorization. Only the users or groups that belong to the Proficy Authentication will have specific permissions and access rights. For more information, refer to the GLOBAL SECURITY section in Access a System.

Note: To use Proficy Authentication security group, you must perform the configurations listed in the Configurations to use Proficy Authentication Security Groups section.

F69870

Ability to generate configuration reports: You can generate report to get a concise summary of tag-specific data of a specific collector. You can select a report from the available predefined templates and generate a categorized report.

Note: The reports are applicable only to the Historian destination collectors.

To facilitate this enhancement, a new Reports section has been added in the Configuration Hub plugin for Historian. Within the Reports section, you are provided with a list of available predefined templates. You can select a template and generate its corresponding report and export it. For more information, refer to About reports.

F66520

Ability to save data query and access it: You can save queries that you use to read tags data. You can use this option to save queries that you may frequently use to read specific tags data. This will help you in the following:

Quickly gather insights of specific tags.
Create and save a predefined query only once and use it as needed.
You can use the Shared option to make the query visible to the other users in the same network.
Note: Once you share a query, all the other users will also be able to edit, and delete it. Be mindful about making a query as a shared query.

To facilitate this enhancement, a new Save Query button has been added in the New Query tab. The button will appear after generating a Read Data report. Additionally, a new Saved Queries tab has been added, which contains the list of all saved queries. For more information, refer to Save a Query.

You can also update a saved query. For more information, refer to Update a saved query.

Other Enhancements

Term Licensing: In parity with other products within the Proficy portfolio, Historian licensing also supports a term license model. This will give you the flexibility to subscribe to Historian for a subscription fee based on your requirement.

F69872

Enhanced data type support for MQTT Collector: The support of Array tags has been added for the MQTT Collector.

ETL Tools Enhancement: Performance improvements are made for the eDNA extractor.

New MQTT Sparkplug B Collector: You can connect as a Primary Host application and collect data based on the MQTT Sparkplug B specification (Sparkplug 3.0.0). Specifically, you can subscribe to a topic that was published using the Sparkplug B payload and collect time-series data in a structured and understandable format. To facilitate this enhancement, a new MQTT Sparkplug B Collector has been added. You can install this collector and configure it to collect data based on the MQTT Sparkplug B specification (Sparkplug 3.0.0).

For more information, refer to MQTT Sparkplug B Collector.

F73170

Ability to extensively use the Python Collector: You can now extensively use Python collector. This collector is available for use in both the Configuration Hub and the Historian Administrator. However, for a seamless user experience, it is recommended to use the collector in the Configuration Hub. To facilitate this enhancement, the following enhancements have been added in the Configuration Hub:

Dedicated Python script editor.
Extensive list of built-in functions that you can use in your script. For more information, refer to Available functions.
Extensive list of supported data types. For more information, refer to Supported data types.
Capability to import third-party, custom Python modules and use them in the script. For more information, refer to Import third-party or custom Python Modules.
Capability to configure path for the newly installed Python modules using Configuration Hub. For more information, refer to Configure Python Library Path.

F63933

Support for Mutual TLS (MTLS) Protocol for Enhanced Security: You can use MTLS protocol for Historian core services and also collectors. To facilitate this enhancement, the following enhancements have been added:

Generating the required root certificate for Historian and core services can be done using the installer. You do not have to manually generate and trust the root certificates. For more information, refer to Certificate-based security for MTLS.
An option to Enable MTLS Security for collector specific instances has been added in Configuration Hub. For more information, refer to Enable MTLS Security for Collectors.
An option to encrypt the MTLS messages sent to Historian has been added. For more information, refer to Enable MTLS Security for Collectors.

F70082

Ability to create data attribute enumerated set: You can create and define a custom text for the quality status and view it in the Attributes column instead of the value when you retrieve the tag data. For example, if your tag is receiving bit positions indicating the quality status (that is, 1 for Old data, 2 for Bad data, and 30 for Good data), you can map the bit position to a custom text and assign it to a set. So, when you view the actual values of the tag, the Attributes column will display the mapped custom text instead of the integer (the bit positions). To facilitate this enhancement, in Configuration Hub, a new DATA ATRRIBUTE ENUMERATED SET option has been added in the Manage Enumerated Sets section. To enable data attribute enumerated set, you must set the DATA ATRRIBUTE ENUMERATED SET option to True. For more information, refer to about data attribute enumerated set .

Note: Once you created a data attribute enumerated set in Configuration Hub, you can use it in Historian Administrator. However, it is not recommended to modify the created Data Attribute Enumerated set in the Historian Administrator. If you modify it using the Historian Administrator, the DATA ATTRIBUTE ENUMERATED SET field will be changed to False in Configuration Hub.

F73356

Ability to visualize and interact with Historian specific REST APIs using Swagger UI: You can now access Historian REST APIs using Swagger UI. This tool enables you to visualize and interact with the API resources without having any of the implementation logic in place, establishing a fully interactive documentation experience using Swagger. For more information, refer to Swagger Documentation.

F69878

Enhancements in Historian REST APIs for Tags

Taglist API: To avoid pagination related issue, you can set the pagesize parameter to 0. This will provide all tags at once without any pagination.

Engineering Units: Tag Data response now includes Engineering Units. For example,

{
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": [
        {
            "TagName": "Test2020_Simulation.Simulation00001",
            "ErrorCode": 0,
            "DataType": "Float",
            "EngineeringUnits": null,
            "HiEngineeringUnits": 200000,
            "LoEngineeringUnits": 0,
            "Samples": [
                {
                    "TimeStamp": "2023-12-04T13:04:51.000Z",
                    "Value": "93319.5",
                    "Quality": 3,
                    "DataAttributes": []
                },

F70197