APM Release Notes for v2.9.0
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
Product: Predix APM (Asset Performance Management)
Documentation Build Date: September 21, 2017
Release Date: See the individual module for its production release date.
Alerts – Release Date: September 30, 2017
New and Updated Features
- Internationalization of the following Alert modules in German, French, Polish and Russian languages:
- Alert Grid View
- Alert Details
- Alert Inbox
- Alert Timeline View
Known Issues
Known issues are those issues that are documented in the defect tracking system that affect this release, and may be fixed in a future release.
| Tracking ID | Description |
|---|---|
| DE44609 | When a template name has special chars such as '&' or '/' or '\' or '^', then when an alert is created using the template name, invoking Alert Details from the grid will not work. Users can see the alert details from the Alerts Inbox. Workaround: When creating a template, do not include any of the special chars |
| DE47053 | During alert ingestion, if a user has an attachment with special chars '&' or '/' or '\' or '^' in the name, then the ingested alert does not show the attachment name on the UI.Workaround: During alert ingestion, do not include any of the special chars |
| DE44634 | After claiming an alert, a user cannot add a Recommendation to the alert, as the Plus icon does not appear. Workaround: Refresh the Alerts page or reload the page by clicking another alert and then clicking back to this alert after claiming the alert. The Plus (+) icon for creating a new recommendation appears. |
Analysis – Release Date: September 30, 2017
New and Updated Features
- Added color binning to parallel axis chart.
- Updated color binning when time range and data resolution are changed on the parallel axis chart.
- Added ability to export chart as an image.
- Provided support for internationalization.
- Upgrade to use the V3 endpoint from APM Time Series.
- Support for Spider, Parallel, and Time Series charts over the XY Line, XY Scatter and Polar charts.
- Added the ability to set the default analysis view for a class of assets.
- Tags that are created as a part of the asset model support the ability to configure the tags to display data in the user-configured Units of Measure.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE33529 | Resolved an issue where a user had to first claim an alert before exporting to PDF. Now, a user can export an alert to PDF without having to claim the alert. |
| DE33786 | Resolved an issue where plotting tags from multiple assets in adhoc view showed the tags as NC in the plotted tag tree. With the fix, assets are added first and then the tags are plotted from the different assets. |
| DE33787 | Resolved an issue where users could not navigate to the New Timeseries Analysis after adding multiple assets in the Tag Tree. With the fix, users are navigated to the New Timeseries Analysis. |
| DE34014 | Resolved an issue where users using advanced search to find tags and then plot charts for those tags, were not able to plot charts for the tags that do not have an alias value set. With the fix, tags are now capable of being dragged from the Advanced Search results panel without throwing a console error. |
Known Issues
Known issues are those issues that are documented in the defect tracking system that affect this release, and may be fixed in a future release.
| Tracking ID | Description |
|---|---|
| DE39147 | In the Analysis module, users will see a tag name being replaced when they add an asset, plot a tag for the asset, delete the asset, and then add the asset back again. The plotted tags section is updated with the tag being replaced. Expected Behavior: After deleting and then re-adding an asset, tags should not be replaced. |
| DE46891 | Exporting charts as an image from an analysis view does not work when you navigate from a dashboard to an analysis view. Workaround: To export a chart as an image, open up the analysis template directly and export the view as an image or images. |
| DE49195 | String or numeric condition-based filtering is not reflected on plotted chart data. It is not working and will be fixed in a future release. |
Analytics – Release Date: September 30, 2017
New and Updated Features
- User can configure an Orchestration's analytic steps and associated iterations to use a discrete number of points during deployment and executions.
- Ability to generate an Analytic Output Alert with custom attributes, which can be populated with key/value pairs specified by the analytics user:
- Ability to pass through custom attributes from an analytic to the analytic output, including passing through to a generated alert.
- Requires developer implementation and custom analytics files with pass-through capability.
- Consolidation and optimization of data storage with APM for access and use during Analytic and Orchestration creation, configuration, and deployment.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| None | Windows Internet Explorer (IE) 11 and Windows 7 are supported in this release. |
| None | Synchronization time required for ingestion of Asset data is optimized to require less time for access to this data (less than 15 minutes). |
Limitations
Limitations are issues that document performance or system behaviors that may pertain to things such as the APM application, the operating system, or the browser.
| Function | Description |
|---|---|
| Analytic Orchestration | For users of the newly implemented feature, enabling users to generate an Alert (Analytic Output) with custom attributes (key/value pairs), the following limitations exist.
|
| Analytic Orchestration | About configuring a range of data by discrete number of points provided to an analytic step:
|
| Analytic Orchestration | Predix runtime-based analytics are supported only in this release.
|
| Analytic Orchestration | Exception handling within orchestration – Analytic (step) failure will end execution of the orchestration.
|
| Analytic Orchestration | Analytic Versioning – Impact of updating analytic version on existing orchestration:
|
| Analytic Orchestration | For users of the resolveAndExecute API to trigger Orchestration execution, updates to Required Input tag mappings for a previously deployed Orchestration may cause an exception to occur.
|
Known Issues
Known issues are those issues that are documented in the defect tracking system that affect this release, and may be fixed in a future release.
| Tracking ID | Description |
|---|---|
| DE34272 | Following deployment of an Orchestration and subsequent editing of its IO Map, an Orchestration's Deployment Configuration tab may not remain open after selection, and the users view may revert to the Orchestration tab. |
| DE45420 | For the newly added Data Points capability, accessible on the IO Map page for an analytic step or iteration of an Orchestration: If the user adds an iteration to a step (step possesses two or more iterations), and then deletes an iteration from the step; Then any subsequently added iterations may retain any previous data point settings from the deleted iteration and will not automatically inherit any analytic step level data point value. |
| DE47475 | Any attempt to delete an analytic that contains more than one version in the analytic catalog will fail. The analytic will remain in the catalog and cannot be deleted. |
Asset – Release Date: September 30, 2017
New and Updated Features
- Reserved attributes Lifecycle Stage (formerly State) and Status are now supported at the Enterprise, Site, and Segment levels. The values for Lifecycle Stage and Status are the same as asset instances. Existing tenants in APM are migrated with Status and Lifecycle Stage values for Enterprise, Site, and Segment. The default values are set as follows:
- Status as 03 (Normal)
- Lifecycle Stage as 06 (Operate)
- Tag instances will now be supported at the Enterprise level. Tag instances are already supported at the site, segment, and asset level.
- A group can now be associated (and disassociated) with any business functional hierarchy object. A single group can be associated with multiple business functional hierarchy objects.
- Basic equipment template functionality is provided in this release. A user can create, update, and delete equipment templates as well as instantiate equipment instances which are derived from the equipment template.
- Users can search for and delete equipment templates from the UI and API.
- Users can search for and delete asset and tag classifications from the UI and API.
- Users can search for asset and tag instances using reserved attributes on the UI and API.
- Users with administrator permissions can now perform a cascade delete by specifying the starting point in the hierarchy. The system will permanently delete all of the objects from the starting point all the way down the hierarchy. Deleted objects cannot be restored.
- Support for associating assets and business functional hierarchy objects in a network model is available only by using the API.
- There are four new reserved attributes for tag instances to capture the high and low watermark values as well as the maximum and minimum threshold values.
- Current delete functionality when the asset instance is the leaf node (the last object in the hierarchy) has been enhanced. Instead of requiring that associated tags, tag correlations, and group memberships be removed first, the system will automatically remove all associations as well as the asset instance. This new functionality is available using both the API and UI.
- Users can retrieve all the assets from a starting point in the business functional hierarchy using a single API call.
Changes in Behavior
- For the Q3 2017 release, the top-level attributes unit and unitGroup fields in tags instances are deprecated. Customers are recommended to use the “source unit of measure” (uom), which is a reserved attribute on tag instances.
- For the 2016 Q4 release, the reserved attribute fault mode was converted from a single value to an array. The Asset APIs supported backward compatibility when setting the value as either a single value or an array using Ingestion and API. However, for the Q3 2017 release, backward compatibility is removed. Customers setting a fault mode as a single value using Ingestion or API will receive an error. Change the value for fault mode in your ingestion file to an array (for example,
faultMode: [ “value”]instead offaultMode: “value”. - For the Q3 2017 release, all collection endpoints, such as
/enterprises,/assets, or/sites, validate that the type query parameter is a URI and return an error if the parameter is incorrectly formed. For example,/assets?type=/assetTypes/{{uuid}} ) - For the Q3 2017 release, a name is required when creating and updating all business objects, such as asset classifications, asset instances, tag classifications, tag instances, or groups.
- For all undocumented Asset APIs that are not found here: https://apm-asset-apidoc-svc-prod.app-api.aws-usw02-pr.predix.io/docs/index.html, the team reserves the right to remove support at any time without prior notification.
Known Issues
Known issues are those issues that are documented in the defect tracking system that affect this release, and may be fixed in a future release.
| Tracking ID | Description |
|---|---|
| DE44840 | When a user creates an equipment template containing one or more embedded templates, there is a specific order in which the equipment instances should be instantiated. The innermost template needs to be instantiated first, followed by each of the next innermost template(s). The root equipment template should be instantiated last. |
| DE33938 | API developers who use the collection APIs (e.g. /assets , /enterprises , etc.) may encounter issues where one or more values in the result set may appear more than once. As a workaround, API developers should use a large page size such as 500-1000 to reduce the occurrence of an item appearing more than once. A fix for this issue may be included in a future release. |
| DE47489 | In the data ingestion module, German and French users will see the label "Rows per page" displayed in English. |
Cases – Release Date: September 30, 2017
New and Updated Features
- Users can add and remove columns in Cases grid view by using the Show/Hide button.
- When a filter is applied to Cases grid view, the filter selection persists after leaving the Cases module (logging out/in or navigating to another module in APM).
- Users can search for a case using Global Search.
- When a case is assigned to a user, asset permission validation is performed.
- Users can generate a multi-case PDF report using bulk action in the Cases grid view.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE28802 | Resolved an issue in which the list of users available when assigning a case to a user did not have a scroll bar so not all users were visible. With the fix, the list of users is now scrollable. |
No Limitations or Known Issues in this release.
Dashboards – Release Date: September 30, 2017
New and Updated Features
- Audit log support for configuration dashboard.
- Widget Repository Administration allows to search, add, and modify content in the repository. Feature only available for APM administrators.
- Web HMI widget now available.
- Scatter chart widget now available.
- Enhanced the tag tree browser with easier tag selection and added filtering. Available for Time Series Interactive chart and Time Series Generic chart.
- Enhanced widgets to limit of 10 tags on the time series widget.
- Enhanced tag tree browser to use drag-and-drop capability for all widgets.
- Localization available.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE39043 | Resolved an issue where the APM Dashboard was not loading after an APM upgrade due to a browser caching issue. Users must clear their cache once the code is pushed to production. It is a one-time operation that users must perform, and thereafter everything should work as expected. |
Known Issues
Known issues are those issues that are documented in the defect tracking system that affect this release, and may be fixed in a future release.
| Tracking ID | Description |
|---|---|
| DE43690 | If a phrase is not translated, the user may see a message: dictionary does not contain key plus the English word. This will be fixed in the Q4 release. |
| DE45774 | The calendar objects on the time control are not localized. This will be fixed in the Q4 release. |
Data – Release Date: September 30, 2017
New and Updated Features
- APM Time Series Data has introduced a new module that supports time series ingestion to improve adaptability and performance. The existing ingestion API in the time series service will be supported for the next 2 quarters and deprecated in Q2 2018. Customers must migrate ingestion functionalities before deprecation to use the new ingestion service.
- Standardized the APM Time Series Data error codes to help uniquely identify errors and display meaningful error messages on the UI.
- Added the ability to audit changes to time series data and data source.
- Updated the time series data source module to enable the usage of Internationalization (i18n). This feature translates various languages that include: German (de-DE), French (fr-FR), Polish (pl) & Russian (ru).
Limitations
| Function | Description |
|---|---|
| Predix Time Series | When a tag has more than 1 million data points, Predix time series is not returning interpolated data. |
Known Issues
Known issues are those issues that are documented in the defect tracking system that affect this release, and may be fixed in a future release.
| Tracking ID | Description |
|---|---|
| DE10048 | When a tag name contains special characters, APM Time Series cannot retrieve data. Users are facing issues while using these tags in charts. |
| DE36429 | Data points are displaying the value from the last valid data points. Instead, it should display zero on the chart for tags that have data in the past. Currently, the tags are representing incorrect data for the range where no data is ingested. |
SmartSignal – Release Date: September 30, 2017
New and Updated Features
- Leveraged new automatic data selection algorithm for creating models.
- Improved APM SmartSignal Runtime Engine performance.
- Exposed additional analytic deployment editing capabilities.
- Introduced view into analytic processing status for troubleshooting.
No Limitations or Known Issues for this release.
Templates – Release Date: September 30, 2017
New and Updated Features
- For Case Templates, a user can:
- Set the visibility of the component in the case form.
- Create a mandatory field in the case form.
- See a scrollbar when the number of items in a drop-down is greater than eight.
- See an error message when deleting a case template that is associated with an alert template.
- Create a text field in the case form.
- Added the following permissions for Case Templates:
- View Case Detail
- Edit Case Detail
No Limitations or Known Issues for this release.
Tenant and User Administration – Release Date: September 30, 2017
New and Updated Features
On the Tenant Preferences page, a tenant admin can:
- Configure the disposition, type, and source for an alert in the Alert Configuration tab.
- Deprecate the disposition, type, or source for an alert in the Alert Configuration tab.
- Configure German, French, Polish, or Russian as the preferred language.
On the My Preferences page, a user can:
- Configure German, French, Polish, or Russian as the preferred language.
No Limitations or Known Issues for this release.
Alerts – Release Date: August 10, 2017
New and Updated Features
- Internationalization of Alert Details for Create Case and Linked Cases
- Internationalization of Alerts Grid View. including Bulk Actions.
- Internationalization of Alert PDFs.
- Filter modifications to the "Is Consumable" property in Alerts, where an analyst can now filter on the Consumable/Non-consumable value, including for recurring alerts.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE32654 | Resolved an issue where not all time zones listed in the Time Zone list for user preferences were supported. Now all listed time zones are supported. |
Known Issues
Known issues are those issues that are documented in the defect tracking system that affect this release, and may be fixed in a future release.
| Tracking ID | Description |
|---|---|
| DE32656 | Users without limited visibility permission can set a rule to send a notification email when an alert is created. However, since all alerts that are newly created have limited visibility, users cannot see them without permission. Therefore, when a new alert is created, a user without limited visibility permission should not receive an email notification nor should they be able to access the alert from the email. |
| DE33348 | Alerts list is not displaying the Alert Name; instead the Asset Name is highlighted. |
| DE33526 | When selecting Site Local as the time zone, Site Local is shown in UTC time, rather than the local time zone for the site. |
| DE33529 | Currently, when a user exports an alert to a PDF report, the user must first claim the report. However, the expectation is that any user can export to PDF without claiming an alert. |
Cases – Release Date: August 10, 2017
New and Updated Features
- Internationalization of Case Details
- Internationalization of Cases Inbox
- Internationalization of Cases Grid View
- An analyst can create a case at any level of the asset hierarchy, including Enterprise, Site, Segment, and Asset levels.
- Fault Mode feature for the associated asset for a case has been added to the Interpretation section of the Case Details page.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE33669 | When a case name is changed, the name change is now reflected in Linked Cases. |
Known Issues
No known issues for Cases in this release.
Configurable Templates (for Alerts and Cases) – Release Date: August 10, 2017
New and Updated Features
- Internationalization of Alert Templates
- Internationalization of Case Templates
- Internationalization of Notification Rules for Alert Rules and Case Rules
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE33528 | Resolved an issue in which the user had to have the Alert Templates permission to view Alert Templates. |
Known Issues
No known issues for Templates in this release.