APM Release Notes v2.7.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)

Release Number: Version 2.7

Release Date: June 14, 2017

New and Updated Features

This release contains updates for the following modules.

Alerts:

Filter settings persist for Alerts inbox.
Filter settings persist for Alerts grid view.
Notification Rules for Alerts feature has been added to the User Preference page.
Alert Created trigger added in Notification Rules tab of User Preference page.
Email notification for changes to an alert has been added.
Timeline View for alerts showing changes made to an alert has been added.
Export PDF Report for an alert has been added.
Can customize the PDF report for an alert by selecting sections to be displayed in the report.
The auto-refresh feature for Alerts has been moved to the Alerts header in the UI.
Subscribe/Unsubscribe toggle for an alert has been added.
Limited Visibility/General Visibility toggle for an alert has been added to the Alert details view.
Visibility column has been added to the Alerts grid view table.
Notes column providing the number of notes for an alert has been added to the Alerts grid view.
Popup for Notes is provided when the link is clicked in the Notes column in Alerts grid view.
Timezone displays for Alert Received, Event, Notes Added, Evidence Added, and Timeline View actions.
Selecting "Site Local" from the Timezone drop-down list in User Preferences uses the UTC timezone.
Auto subscribe to alert changes when alert is claimed.

Cases:

Timezone update in User Preferences for Cases "Created on" date and "Updated on" date fields.
Selecting "Site Local" from the Timezone drop-down list in User Preferences uses the UTC timezone.
The Resolution Date in the Case Closure dialog can be set and edited.
Notification Rules for Cases feature has been added to the User Preference page.
Case Created trigger added in Notification Rules tab of User Preference page.
Email notificaton for changes to a case has been added.
View/Edit Case permission has been added.
Subscribe/Unsubscribe toggle for a case has been added.
Auto subscribe to case changes when case is claimed.

Configurable Templates:

Addition of 30 Days and 60 Days options to Pre-Event Time column in Alert Templates.

Data:

Tag expression feature will no longer support tags with space in Q2 and will be deprecated in upcoming releases.

Analysis:

Independently zoom on X, Y and XY axes.
Pan across chart.
Context Browser search and filter capability.
Select between new time series queries (TSQ) and event-based queries (EBQ) ad hoc analysis views.
Set asset local time or user timezone preference for a TSQ or EBQ view and save as a template.
Select a data source for a TSQ or EBQ analysis view and save to a template.
Select a data resolution for EBQ analysis views and save to a template.
Share cards, tag expressions and filters to a template.
Save tag expressions and reference curves on a template.
Add conditions, predefined functions and embedded tag expressions to a tag expression.
Include UoM information for tags and enforce matching UoMs for subsequent tags in tag expressions.
Create tag pairs for X-Y and polar charts.
Change plotted tag list to hierarchy that includes cards, charts and tags or tag pairs.
Allow muting and filtering on separate tags in tag pair.
Add preset date ranges to the Date Range Calendars.

Dashboard

Re-arrange cards on a dashboard.
Add modules as a destination in widget navigation.
Add Dashboard Summary card, layout, and summary widget library.
Filter summary card widgets to show applicable widgets only.
Export a dashboard as a PDF.
Export a card as a PDF.
Raw and interpolated data in generic graph widget.
Time span links in the footer of graph widgets.
Time span configuration for selected configurable widgets.
Time control can use the timezone set in user preferences.
Change the refresh options for all widgets.
Only latest widget version available.
Add Asset Criticality widget.
Add Completed Work Orders widget.
Add Open Work Orders widget.
Add Recommendations widget.
Widget layout uses aspect ratio.

Analytics

Add analytics to multiple analytics runtime engines.
Schedule analytic deployments to run automatically.
Add, modify, and delete analytic orchestrations for Predix analytic runtime.
Use iterations to apply multiple versions of an analytic to the same data flow orchestration by mapping different inputs.
Upload and maintain multiple analytic versions for a single analytic in the catalog.
Automatically map analytic inputs to asset tags during deployment.
Create asset filters for use in analytic orchestration and asset selection during deployment.
Search for assets to deploy analytics.

Asset

Noticeable performance improvements in response time when querying, creating, and updating asset business objects.
Support for multiple enterprises and sites in the hierarchy.
The ability to store and retrieve UTC offset for an asset instance.
Associate or Disassociate Asset or Business Functional Object onto any hierachy level.
Additional performance enhancements to the turbo-and kick-charged™ asset ingestion.
Record and view asset activities by user.
Detect and publish Asset and Tag Instance changes.
Enhanced user interface of Instance detail pages for Enterprises, Sites, and Segments.
Enhanced user interface of detail pages for Tag instances.
ALM tenant configuration.
Display of date time according to the user's preference.
The unit and unitGroup fields in tag instances will be deprecated in a future release. Users are recommended to use the "source unit of measure" field, which is a reserved attribute.

SmartSignal

Add a new Smart Signal tenant using the Tenant Management page.
Associate a SmartSignal tenant with a Host in the Tenant Management page.
Remove a Host association from a SmartSignal tenant.
View current asset mappings between SmartSignal Assets and APM assets for a tenant.
Import a legacy SmartSignal blueprint into APM as an APM analytic.
Import legacy SmartSignal assets into APM as a SmartSignal Analytic (SSA) instance.

Miscellaneous

New Tenant Preferences page provided.
New User Preferences page provided (My Preferences).
Updated User Profile page provided (My Profile).
Audit Log viewer is available.

Resolved Issues

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

Tracking ID	Description
DE15998	Resolved an issue where custom sections in the Case Detail page did not appear in the PDF Export. Now when exporting a PDF, all selected sections appear in the PDF.
DE18556	Resolved an issue where error messages were not shown in the UI when the application failed.
DE26374	Resolved an issue where, when "All Resources" was selected for a user, the user was able to create alerts but not view them.
DE26659	Resolved an issue where an error message was not shown in the UI when backend services were down.
DE27761	Resolved an issue where the context browser was empty if a user did not have permissions/access to the Asset module. An "Access denied" message now displays.
DE28249	Resolved an issue where a class template chart did not plot when a template had a Tag Expression with two configured tags but the second tag was not recognized.
DE28250	Resolved an issue where the labels for the target in parallel axis charts were incorrect. The label on the "X" axis is now Angle and the label on the "Y" axis is Distance, so the chart is plotted correctly.
DE29139	Resolved an issue where, when using the Internet Explorer browser, loading charts associated with multiple alerts took an increasingly long time, eventually causing the browser to crash.

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	Limitation
Analytic Orchestration	Internet Explorer 11 is not supported in this release for Analytic Orchestration Internet Explorer 11 will be supported in a future release.
Analytic Orchestration	Predix runtime-based analytics are supported only in this release. Orchestration application does not support any other runtime types at this time. If a user attempts to execute a non-Predix runtime-based analytic as a step in an orchestration, APM will allow the user to deploy the orchestration, but the orchestration will not execute.
Analytic Orchestration	Exception handling within orchestration – Analytic (step) failure will end execution of the orchestration. During deployment and execution of an orchestration, if an analytic (step) fails to execute properly, APM will end the orchestration and will not execute any remaining portion of the orchestration, including any remaining steps. All output data related to analytics (steps) that had successfully executed before the step failure will be saved. Any outputs related to the failed analytic (step), or any subsequent steps that were not executed will not be saved.
Analytic Orchestration	Analytic Versioning – Impact of updating analytic version on existing orchestration: Any updates to the version of an analytic will not update the corresponding analytic (step) in an existing orchestration. The orchestration will continue to use the version that existed at the time of the addition of the analytic to the orchestration. Users are required to manually modify an existing orchestration (add, delete, update steps) to update a step to the latest version of the analytic, and then re-deploy the orchestration for any change to take effect during execution. Users can view the version of an analytic on the orchestration pages by hovering over the analytic step in the Analytic Data Flow.
Analytic Orchestration	Ingestion of Asset data requires a minimum synchronization time of 15 minutes: If a user ingests new or updated Asset data, a minimum time of 15 minutes is required for all data to be fully ingested and synchronized for use with Analytics Orchestration execution. During ingestion time, Analytics Orchestration will not execute and may provide a "failed" status to the user. Users should wait at least 15-20 minutes following asset data ingestion to execute any analytic orchestrations, to ensure orchestration completion and output.
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. If the user creates and deploys (triggers) an Orchestration, and later unmaps at least one of the Required inputs on the IO Mapping page for a particular step, APM may create an exception related that step upon any subsequent execution via the resolveAndExecute API. Users will be able to unmap required inputs without causing an exception for this scenario in a future release.
APM Analytics	Latency in asset filters to show updated asset model: There is a latency of 15 minutes for the Asset filters to reflect changes to newly updated asset data, including enterprise, sites, segments, assets, and tags. If the user wants to select the newly added assets during analytic deployment, they must wait for 15 minutes before selecting assets for deployment using asset filters.
APM Analytics	I/O mapping limitations: The Tag pane lists all available tags, including tags from the root asset node to the last child asset node. For example, if the asset node A1 is selected for deployment and the asset node A1 has children B1 and B2, then in the 2. I/O Mapping page, the Tag pane lists all tags available under A1, B1, and B2. However, the user must only map tags listed for A1 (selected asset) to inputs and not tags from children B1 and B2. Mapping tag attributes to constants is not supported in the current release.
APM Analytics	Analytic Versioning – Impact of updating analytic version on existing deployments: The UI does not show the version of the analytic used to run a deployment in Analytics Deployments.
Asset	A name is not required when creating and updating any business objects (for example, asset classifications, asset instances, tag classifications, tag instances, or groups). When users are working with assets or tags for which a name is not specified, they may encounter an error or have difficulty proceeding to the next step. The system has been adjusted to accommodate in the following ways: Previously, when users navigated using the context browser to an asset with no name, they would encounter an error. In the current release 2.7.0 (Q2, 2017), users will see the asset titled as "-No Name", which will allow them to click on the asset and see it displayed in the asset instance detail page. Previously, after querying for an asset or tag using the free-text search or classification, the system displayed a list of results; however, for business objects with no name, the system was unable to display a hyperlink. In the current release 2.7.0 (Q2, 2017), users will see a hyperlink for the asset/tag titled "-No Name", which allows them to click on it to navigate to the detail page for the business object. In a future release, a name will be required when creating and updating all business objects, such as asset classifications, asset instances, tag classifications, tag instances, and groups.
Asset	In a future release, the top-level attribute unit and unitGroups will be deprecated. Users are advised to use the reserved attribute UoM (unit of measure) instead.
Asset	In the APM 2.5.0 (Q4, 2016) release, the reserved attribute fault mode was converted from a single value to an array. The ALM application continued supporting a single value via ingestion and API. In a future release, backward compatibility will be removed. Users setting a fault mode as a single value via ingestion or API will receive an error.
Asset	In a future release, for all collection endpoints (for example, /enterprises or /assets), the type query parameter will only support a URI. For example, `/assets?type=/assetTypes/{{uuid}} )`
Asset	For all undocumented APIs, the ALM team reserves the right to drop support at any time without notification.
Asset	The top-level attribute groupType was removed from asset groups as there is no longer a need to provide this functionality. For existing values stored in the groupType attribute, the value will no longer be retrieved.

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
DE31036	An error message appears in the browser console when D3 chart widgets are loaded, due to a PX component. However, it does not stop the user from adding or looking at widget data.
DE32255	When users add a new row in an analytic template for inputs, constants, and outputs, they should wait for the spinner to stop before editing that row. For example, adding a name in a new input definition and then immediately selecting a dataType before the spinner ends, which can produce an error.
DE32351	There is currently a limitation of the number of Assets that can be associated with an Analytic instance of the SmartSignal type. Performance testing has had success with up to 20 assets for a single deployment. Attempting to deploy more than 20 assets may result in an error.
DE32448	Tag source keys are being shown in the tool tips of the widgets and the legends. This will be fixed in a future release, at which time the user will see the tag names beside the source key.
DE32490	If a user has the time control option turned on, it will overwrite the time span for the widget. Currently, the time span appears while time control is turned on, but the user should know the time control will overwrite that option. In a future release, the time span options will be hidden when time control is on.
DE32654	Not all timezones listed in the TimeZone list for user preferences are supported.
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.
DE32859	Custom attributes are not displayed for all Enterprises, all Segments, or Sites if "type" is given as an additional condition. When choosing Enterprises, Sites, or Segments in asset selection and mapping attributes to inputs, users must use "Map by Asset" and map attributes to inputs using the hierarchy view.
DE33168	APM Charts are not displaying an explanation pop-up for markers in any browser. The meaning of the different chart markers should be provided, especially for charts containing an alert generated by a SmartSignal analytic.
DE33217	APM is allowing users to add the same asset filter field more than once in the search criteria field, which is misleading for the user. For example, a user enters "Asset Name=56000" and "Asset Name=56001", which the user expects the filter to act as an "or" condition. However, the actual search treats it as an "and" condition, which means nothing is returned. Workaround: Users should use an asset filter field only once as a search criteria.
DE33348	Alerts list is not displaying the Alert Name; instead the Asset Name is highlighted.
DE33526	When selecting Site Local as the timezone, Site Local is shown in UTC time, rather than the local timezone for the site.
DE33528	Alert Templates permission is required for user to see Alert Templates. However, currently when a user is granted permissions to Alerts, that user is also given access to Alert Templates.
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.
DE33669	Changes to Case Name are not reflected in Linked Cases when they should be.
DE33786	Plotted tag icon changes to "NC" after adding multiple Assets. Workaround: Add assets first and then plot the tags from different assets.
DE33787	User cannot navigate to new Timeseries Analysis after adding multiple assets in the Tag tree.
DE33830	After navigating to another dashboard, the user cannot export the dashboard or card as a PDF. This functionality is not implemented yet.
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. 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 is planned for a future release.
DE34013	Users navigating from dashboard widgets to analysis view will not be able to see the units of measure for the tags in the tag register.
DE34014	Users using the advanced search feature to search for tags and plotting charts for those tags will not be able to plot charts for those tags that do not have an alias value set. The plotting works as expected when used from the tag tree browser.
DE34155	If all inputs for an analytic step have been marked as "Not Required" in the Analytic Template, then Mapping all non-required inputs using the step's IO Mapping page does not allow users to execute the Orchestration using the APM UI.
DE88	When 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.
DE89	When 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.
DE92	When 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.
DE1186	When 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.
DE1336	When modifying a deployment for an existing analytic, the Last Updated date is not being set to the new date.
DE1476	When 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.
DE1562	When analytic has a long name (50 characters or more), the analytic template page does not load.
DE7096	When 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.
DE7545	When a customer ingests an asset instance without a name, the asset cannot be retrieved.
DE10184	When 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.
DE10602	When analytic deployment configuration is incomplete, the status displays as "In-Progress" in the summary.
DE10737	When you change the datatype, the value is cleared. You have to re-enter the value before proceeding to Save.
DE11132	Searching for tag classifications intermittently generates a 403 error.
DE11223	APM Asset doesn't support access control at the tag level for this release. This has been scheduled for a future release.
DE11250	When using Internet Explorer and viewing the ingestion log status, if you change the number of rows displayed from 10 to another value, then the display will re-render extremely slowly. The operation may take as long as two and half minutes to display the ingestion log status.
DE12739	Assets created with an 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.
DE14614	When re-ingesting time series data for the same timestamp but with different data type or quality values, a duplicate record is created for this data point.
DE14840	When 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 characters `:\|\[]()<>.=$` or the special string `..`, the query will not work. Workaround: To avoid this problem, do not use these characters in a search.
DE15351	After 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.
DE15545	Assets are not showing as mapped even though tags were mapped for the input tags.
DE15661	Pressing Enter after editing a pill for Search does not trigger the search.
DE15893	Some 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.
DE16189	If a user updates the Next Related tag as "Null" by Tag Patch, tag correlation is not removed from the tag correlation table and in the UI, the correlation still exists.
DE16292	Via 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.
DE16588	Concurrent Case Ingestion fails beyond 40 concurrent case ingestions using regular case endpoints.
DE26658	An analyst has the option to create a case from an Alert created at the Enterprise, Site, or Segment level. However, when the analyst tries to create the case, the analyst receives a 403 error. For this release, it is advised that you not create a case from an Alert that was created at the Enterprise, Site, or Segment level.
DE27456	Context browser is empty if user has permission to two different assets under the same segment and enterprise.