APM Release Notes v2.5

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)

Release Number: Version 2.5

Release Date: December 14, 2016

New and Updated Features

Asset Model:

  • More descriptive error messages specifically targeting the issues for assets or ingestion assets are seen when users edit those assets.
  • Extended Reserved Attributes to support range of values by classification.
  • Creating and editing custom attributes for asset instances, tag instances, asset classifications, and tag classifications.
  • Enable editing of the name and description on the user interface for asset instances, tag instances, asset classifications, and tag classifications.
  • Wildcard search by Asset ID.
  • Search, view, and edit groups. Add and remove objects from groups not supported via UI.
  • API/Ingestion to create and add or remove objects to groups.
  • Unit of measurement reserved attribute enhancements.
  • Retrieve, update, and delete location based on a list of asset instances.
  • Two dimensional (Grid) custom attribute values.
  • Tag search performance improvement.
  • View, Edit, Add and Delete a location for an asset instance.
  • Users who have been ingesting files with duplicate assets (or tags) using the same source key will now correctly receive an error message.

Alerts:

  • Sort Alerts columns in grid view.
  • Filter Alerts columns in grid view, including filtering Custom fields.
  • Supports SmartSignal attributes, including Density.
  • Supports Alert and Case ingestion.
  • Supports Bulk Edit of Alerts for Disposition, Notes, and Upload Evidence.

Cases:

  • Link to Asset Faceplate from a case.
  • View Cases in a table grid.
  • Access Case Detail from grid view.
  • Add and edit an action for a case.

Configurable Templates:

  • Add Custom sections to Case templates.
  • Generate a PDF report for a case.

Analysis:

  • The Create, Revise, Update and Delete X-Y chart, spiderweb chart, and polar chart.
  • Plot tags to the chart timeline slider.
  • Plot a reference curve on an X-Y chart.
  • Updated Time Series charts to use the new D3-based component.
  • Select chart resolution for time series, X-Y, and polar charts.
  • Change chart direction for a polar chart.
  • Zoom using the chart timeline slider.
  • Export chart data.
  • Add, edit, and delete an asset analysis view (template) for multiple assets.

Configurable Dashboard:

  • Ability to add private, public, and user group-based dashboards.
  • Designate favorite dashboards.
  • Save a card to the card library as a template or fixed card.
  • Edit and delete cards in the card library.
  • Configure and add core widgets such as time series interactive charts, time series generic charts, big number widgets, grouped bar charts, spiderweb charts, kpi overview widgets, and small list widgets.
  • Configure the MO (Maintenance Optimization) widget.
  • Add default MO widgets, such as asset criticality, maintenance kpi, open work orders, completed work orders, and recommendation widgets.

Data:

  • Provide secure service for access to Asset time series data.
  • Provide process supporting file bulk ingestion for APM.
  • Provide process supporting data streaming for APM via Predix API.
  • Improved user experience for data source configuration.
  • Beta release of integrated tag data units of measure conversion service.

Analytics:

  • Added SmartSignal to the list of analytic types. Uploads SmartSignal blueprints and support files.
  • Can delete analytic from the analytic header.
  • Can sort asset tag list.

Orchestration:

  • Orchestration list shows owner, date created/last updated, and status.
  • Can create orchestration fro orchestration header.
  • Orchestration detail page displays the Orchestration tab and Deployment Configuration tab.
  • For the Orchestration tab, Analytic Data Flow is editable and assets can be mapped.
  • *Event-based triggering of an analytic execution is available using an external data set.
  • *You can run an orchestration with an alert as an output.
  • *Create a tag using an expression editor.
  • *Create linearly linked analytics.
Note: Line items marked with an asterisk (*) are developer reference items.

Resolved Issues

Resolved issues are those defects that have been fixed for the release.

Tracking IDDescription
DE10789Resolved an issue where the spinner was missing when a user clicked on Widget Navigation icon while card was in the edit mode.
DE10884Resolved an issue where, when a user navigated to the asset instance details page from the Asset search page, the successful delete operation on the asset instance did not display a success message and the asset instance detailed page was still shown.
DE11203Resolved an issue where, if a user loaded a template and changed the date range, then the altered date range was used to display all subsequent templates for that session.
DE11218 Resolved an issue where any search using a wild card on Asset Instance or Tag Search caused inconsistent Results that ranged from Empty Array [], 403 Forbidden error, and Valid Result.
DE11376Resolved an issue where the asset search was not returning results, if the special character # was in the search text.
DE11407Resolved an issue where, on click of the asset/tag/classification link on the results, the tool tip did not hide and stayed on the page instead.
DE11629By adding additional security, fixed the ability for another tenant user to access or modify Cases or Analysis Evidence belonging to another tenant.
DE11630By adding additional security, fixed the ability for another tenant user to access or modify Alerts belonging to another tenant.
DE11814Enabled synthetic monitoring for Alerts micro services for additional reliability and monitoring.
DE11986Enabled synthetic monitoring for Cases micro services for additional reliability and monitoring.
DE12451Resolved an issue where APM time series could not get interpolated data for multiple tags from a Historian data source.
DE12934This issue will not be fixed in Vertical Grouped Bar Chart V1 widget. This widget will be deprecated in next release. Please use Vertical Grouped Bar Chart V2 for the functionality.
DE12942Resolved an issue where incorrect information was provided when navigating from the Vertical Grouped Chart for Alerts and Cases. The information in the new tab was not filtered based on the visualization in the widget.
DE13177Resolved an issue where Cases analytics information was not displayed on the APM Dashboard when a leaf node Asset was selected.

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.

FunctionLimitation
AnalyticsScheduled analytics and orchestrations can only create time series output at this time.
Asset IngestionAsset ingestion is successful for bulk payload of up to 250 assets and 200 tags per Asset. Advise ingesting with multiple files/payload if the payload is bigger than this.
AssetAsset correlation removal can be done by PUT call only.
AssetWhile there is no limitation on the number of objects associated with a group, the performance of groups with many associations is adversely affected.
Asset There are issues synching the indexes for search, such that a user cannot find the associated objects in a group immediately after the association has happened. This is due to a lag time in synching the data, which causes the newly added objects to not appear in the group.
AssetThe bigger an object is, the more adversely it affects performance, especially when retrieving asset information.
AssetYou cannot have a grid of a grid, but other datatypes are supported.
AssetThere is no support for postal address. It can be ingested but there is no validation of the postal address object.
Asset You cannot create a group from the UI, nor can you add or delete an object from the UI.

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 IDDescription
N/APolymer has a known issue with Internet Explorer, in that when the scroll bar is clicked, the drop-down disappears.

Workaround: User can still scroll down the list using the arrow keys or mouse scroll.

DE88When updating a group type with a URI for a tag type that does not exist, an inappropriate exception of 500 INTERNAL SERVER ERROR is returned instead of 404 NOT FOUND.
DE89When updating a tag group with a URI for a tag that does not exist, then an inappropriate exception of 500 INTERNAL SERVER ERROR is returned instead of 404 NOT FOUND.
DE92When creating a new tag, the drop-down to select the tag class is not rendering correctly. The drop-down does allow users to select a tag class and does not restrict users from completing the creation of a tag.
DE1186When retrieving time series data using interpolated operation, the data points of a string type are not being included in the interpolation. Instead, the last calculated data point is returned.
DE1336When modifying a deployment for an existing analytic, the Last Updated date is not being set to the new date.
DE1476When searching Asset or Tag Classifications, the performance is impacted if a Contains search is performed with less than 3 characters.

Workaround: If this occurs, increase the number of characters in the search string to more than 3 characters, and attempt the search again. If this occurs through an APM Asset API call, the return status code is 502.

DE7096When retrieving time series data using interpolated operation, zero values are returned for data points where no time series data exists at the beginning of the required time range.
DE7545When a customer ingests an asset instance without a name, the asset cannot be retrieved.
DE10184When hovering over a tag or asset name in the search results pane of the Classification window, the system will sometimes display a tool tip that does not disappear. This tool tip may block the "back" button on the window preventing the user from navigating from the current page.
DE10737When you change the datatype, the value is cleared. You have to re-enter the value before proceeding to 'Save'.
DE11132Search for tag classifications gets intermittent 403 error.
DE11223APM Asset doesn't support access control at the tag level for this release. This has been scheduled for a future release.
DE11250When using Internet Explorer and you are viewing the ingestion log status, if you change the number of rows displayed from 10 to another value, then you will encounter severe slowness in re-rendering the display. The operation may take as long as two and half minutes to display the ingestion log status.
DE11413View Alert in Grid view. Select at least one alert in ready state. Claim the alert. Mark it as processed. Now try to release the claim.

Observed: User is able to release the claim.

Expected: User should not be able to release the claim of a processed alert.

Workaround: Use the Alert details view instead of the grid view to perform any action on processed alert.

DE11442APM Analytics may intermittently report a SocketTimeoutException while running an analytic through a recurrent schedule or on-demand execution.

Workaround: This is a known issue in Predix Analytics. Impacted users of APM Analytics should retry running the analytic.

DE12739Assets created with incorrect parent or asset type URI cannot be accessed after creation.

Workaround: Make sure to provide the correct parent and asset type URI to avoid the creation of inaccessible objects.

DE14840When invoking the Search function in APM Asset, either through the API or via the UI, there are characters that, if used as a value, will cause the search to fail. Through the API all values in key=value pairs are affected. Through the API, pills take two forms: a string, or a key:value pair. In the UI, the string and the value of the key:value pair are affected. In any of these cases, if the affected element contains any of the following characters :|\[]()<>.=$ or the special string .., the query will not work.

Workaround: To avoid this problem, do not use these characters in a search.

DE15308The MO dashboard is developed using a px-data-table, which is a wrapper around aha-table. To update fixed column widths, the wrapper (px-data-table) is not providing any option. Hence, this scenario can not be accommodated in this script. This will be scheduled for a future release.
DE15351After setting up an analytic deployment, clicking Deploy does not return the application from its wait indicator (a spinning icon).

Workaround: The analytic has stalled. Re-upload the analytic artifact (jar or zip file) to restage the analytic.

DE15430Scheduled analytics and orchestrations stop firing, caused by environmental issues in Predix Platform.

Workaround: Contact Predix Support. Predix Support will work with Predix Platform to resolve.

DE15893Some ingestion users may notice slowness when ingesting a large number of tags in the same file. When viewing the task status in the asset ingestion screen, the task may appear to indicate that the tag instance is not ingested when in fact it has.

Workaround: Navigate to the tag instance detail page screen to verify.

DE15998

Users can generate a PDF with the Interpretation, Evidence, Actions, Closure and Case Info sections. Template forms aside from Interpretation are not supported at this time. This feature is a work-in-progress and, as such, users may encounter issues exporting a PDF. Known issues are:

(Very) large text entries in the Symptoms, Diagnosis and Recommendation sections may overflow without a page break. That is, text will disappear at the bottom of a PDF page.

Workaround: The best solution is to add new lines (Enter/Return) to any previous sections, or to reduce the length of those sections that are overflowing off the page.

Similar problems are encountered if long comments are entered in Action sections.

DE16283The tool tip does not show the unit of measure in parallel axis chart and spider chart.
DE16292Via API, the category field is not validated as mandatory. If a group is created without a category, group associations will not be allowed.

Workaround: Always create a group with the category field populated.