APM Release Notes Q4 2017
APM Release Notes for v2.10.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: December 13, 2017
Release Date: See the individual module for its production release date.
Alerts – Release Date: December 15, 2017
New and Updated Features
- Ability to manage alert visibility to multiple tenants. When an analyst dispositions an alert and sets the visibility to General, then the alert is visible to the customer/tenant, and that tenant can add notes to the alert. In turn, the analyst can view the added note from the customer.
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 |
|---|---|
| DE56850 | When an alert with default analysis is received by a remote tenant and the default analysis link is clicked, the page does not show any charts. In addition, when a user navigates to the Asset Details page from the Asset Info page, the Asset Details page does not show any information. For default analysis to work from a remote tenant, multi-tenancy must be supported by both Asset and Analysis. |
Analysis – Release Date: December 15, 2017
New and Updated Features
Resolved Issues- Ability to select tag color and line style in a chart.
- Ability to zoom in Parallel Axis, Spider, and Polar charts.
- Ability to make the Common Axis the default option in Parallel Axis charts.
- Ability to select all options in Ad hoc analysis before plotting the charts.
- Support for the crosshair pointer across all charts in a card.
- Ability to highlight data points on one chart and reflect the points on the other charts in the card.
- Ability to switch between Common Axis and Individual Axis on Parallel Axis charts.
- Ability to change the tag Unit of Measure based on the user or tenant-preferred System of Measure.
- Ability to re-order charts with multiple charts plotted.
- Any muted chart data is removed from the chart. All unmuted chart data appears on the chart.
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE54857 | Resolved an issue where users could not apply a crosshair pointer across charts after triggering from a Parallel Axis chart or Spider Web chart. |
| DE54126 | Resolved an issue where, after selecting an option from the time zone, data resolution, or data source drop-down list, the tool tip remained on the screen. With the fix, the tool tip no longer remains on screen. |
| DE53134 | Resolved an issue where the time zone offset appeared instead of the abbreviated text time zone when hovering over events in a residual chart on SmartSignal cards. |
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 |
|---|---|
| DE55631 | Chart Load failure occurs when a card has eight SmartSignal charts and a user tries to rearrange the charts. |
| DE55618 | There are multiple issues when a user navigates back and forth between SmartSignal and non-SmartSignal cards while performing various activities. |
Analytics – Release Date: December 15, 2017
New and Updated Features- Common Analytics Framework:
- Scalable extendable framework for creating and managing analytic templates and deployments using different Runtimes
- Provides logical separation between Analytics Template/Orchestration configurations and deployment of the Analytics for specific asset instances
- Support Spark Runtime – ability to execute Analytics using Spark Framework
- Support for SmartSignal RM AnalyticsNote: To import a SmartSignal Analytic blueprint into APM Analytics, the ZIP file containing it must be exported using version 6.3.2 or later of the legacy SmartSignal Blueprint Center client application.
- Ability to view details of SmartSignal Blueprint from Analytics Catalog
- Ability to create Analytic Template by uploading Analytic Definition file in JSON format
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 |
|---|---|
| DE56659 | Intermittently, during analytics deployment, even after selecting the asset in the 1. Asset Selection page, the Save, Reset and Next buttons may remain disabled. Workaround: Navigate to the main Deployment tab, then select the deployment. Select Edit to re-attempt the 1. Asset Selection and 2. I/O Mapping pages. |
| DE56646 | After selecting Deployments in the main navigation, the status of a deployment in the deployments list may not match correctly with the status listed in the Deployments details page. For example, the deployment list may show the status In Progress for the deployment Deployment1, but the Details section for the same deployment lists the status Completed. Workaround: Refer to the deployment status on the details page instead of status in the list. |
| DE56620 | In Deployments, 2. I/O Mapping page, on attempting to clear the value in the Data Points field for an analytic step or its iteration, the system may default to an older, previously saved value. Workaround: At this time, configure the affected Data Points field to a higher value than the number of points configured for the Date Range in the 3. Schedule page; the system will then update the Data Points value for the step or iteration. |
| DE56563 | This defect only applies to analytics that use the resolveAndExecute API for event-based triggering. If analytics deployments were scheduled for event-based triggering, and the 1. Asset Selection page was configured using a default asset filter such as All Assets, All Enterprises, All Segments, and All Sites, then the deployments will not run correctly. Workaround: At this time for analytics that use the resolveAndExecute API for event-based triggering, create custom asset filters and use them to configure assets in the 1. Asset Selection page in Deployments. Do not use default asset filters to configure assets selection during deployment. |
| DE57027 | In Deployments, 1. Asset Selection page, if you had previously configured assets with a custom asset filter, and later updated to select a different asset filter containing the same filter criteria (for example, both asset filters produced the same results of assets), the system may revert the filter to the older, previously selected version. Navigate to the main Deployments page, select the deployment, and then select Edit to re-attempt asset selection configuration. Alternatively, if the filter criteria are the same in both filters, use the previously configured asset filter. |
| DE56906 | In the Deployments details page and 2. I/O Mapping page, analytics that have long names appear with the name and version columns overlapping to obscure some text. Workaround: Navigate to the Deployments details page. You can note the name of the analytic orchestration heading in the deployment header. You can then navigate to the Orchestrations list, search for that specific orchestration and access it in the details page. You can then access the analytics template names and version used in the data flow. |
Asset – Release Date: December 15, 2017
New and Updated Features
- Export tenant data for classifications using APIs.
- View and access past events that affected specified asset instances.
Limitations
- When ingesting Asset JSON files, the CCOM Type is case sensitive and must be entered in capital letters.
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 |
|---|---|
| DE56868 | The timestamps associated with alerts or cases in the Events tab may not always be displayed correctly. Use the timestamp from the Alerts module as the most accurate reference. |
| DE57037 | After clicking the Asset ID of an alert in the Alerts Inbox, the system will navigate to the Asset Faceplate. If the alert is not found, then the count of alerts on the Events tab may be higher than the number displayed. |
| DE57273 | After clicking the Asset ID of an alert in the Alerts Inbox, the system will navigate to the Asset Faceplate. If the alert creation date is older than 30 days, the alert will not automatically display in the Events tab. Workaround: Customers should manually change the calendar date range to a time period that includes the alert creation date. |
Cases – Release Date: December 15, 2017
New and Updated Features
- Ability to view the audit log for Cases, which displays various actions taken for a case and the name and date of the user who made the changes.
- Tenant admins can now configure values for Category, Urgency, Closure Code, and Status in a case.
- Ability to auto-populate the Asset ID when manually creating a case.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE50762 | Resolved an issue that occurred when a user exported to PDF in Russian. Previously, the PDF was generated in unreadable format. |
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 |
|---|---|
| DE56394 | For the Customer Tenant in cross-tenancy cases, many of the update or view operations do not work for a remote case.
|
| DE56140 | When creating a Case manually, the link to browser assets to auto fill Asset ID will not be available in the Internet Explorer browser. IE does not support Java Script 1.6 and due to this limitation, the link will not be shown. Workaround: The Chrome browser does display the link to browser assets and it works as required. |
Dashboards – Release Date: December 15, 2017
New and Updated Features
- Ability to filter dashboards using asset filters and time span filters.
- Ability to change the tag Unit of Measure based on the user or tenant-preferred System of Measure.
Data – Release Date: December 15, 2017
New and Updated Features
- Support for asynchronous time series ingestion in BETA version.
- APM time series query API to support quality attributes.
- Ability for APM data services to call UoM API with system of measure parameter.
- Improvements made to the time series data source user interface.
SmartSignal – Release Date: December 15,2017
New and Updated Features
- In the SmartSignal Maintenance module and the Analytics module, you can now select a link to view the Analytic Template (i.e. SmartSignal Blueprint), which provides a view of the analytic details.
- In SmartSignal Maintenance, you can now:
- Activate or deactivate a SmartSignal deployment.
- Activate or deactivate models within a SmartSignal deployment.
- View settings for a model.
- View training data charts for models, as well as show and hides striping on the charts.
Limitations
The following limitation applies to SmartSignal for this release.
- Use of Microsoft Internet Explorer 11 is not currently recommended.
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 |
|---|---|
| DE56821 | When viewing model training data charts in Internet Explorer 11, if you use the control to pan the view of a chart, the action is not synchronized across all charts on the page. |
Templates – Release Date: December 15, 2017
New and Updated Features
No new features were added in this release.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE53485 | Resolved an issue where, when an alert template had been created and saved, the Source drop-down menu in the Basic Info section of the Alert Template was enabled. Now, users cannot edit the existing Source value even when the Source drop-down menu is enabled. |
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 |
|---|---|
| DE53526 | Users cannot edit an alert template that was originally created using a source or type that have since been made inactive. |
| DE52834 | Users are unable to retrieve the associated analytics in an alert template, with the message Failed to retrieve associated analytics displayed in the Associated Analytics section of an alert template. This section will populate when there are associated analytics available, once the Associated Analytics feature is fully operational. |
Tenant and User Administration – Release Date: December 15, 2017
New and Updated Features
- On the Tenant Preferences page, a tenant admin can:
- Configure Systems of Measure.
- Set a System of Measure as a preferred System of Measure for a tenant.
- On the My Preferences page, an APM user can:
- Set a System of Measure as a preferred System of Measure.
- Units of Measure Conversions feature is available.
- A tenant admin can configure values for Category, Urgency, Closure Code, and Status in a case.
Analysis – Release Date: November 17, 2017
New and Updated Features
- SmartSignal integration for charting ad hoc analysis.
- Ability to zoom in on Parallel Axis charts, spider charts, and polar charts.
- Ability to highlight data points on time series charts, XY charts, and polar charts.
- Ability to select all options in ad hoc analysis before plotting the charts.
- Ability to select different colors for tags in a chart.
- Ability to create and view a crosshair pointer for charts.
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 |
|---|---|
| DE53134 | When hovering over events in a residual chart on SmartSignal cards, then the time zone offset appears instead of abbreviated text time zone. |
| DE54126 | After selecting any option from the time zone, data resolution, or data source drop-down list, then the tool tip remains on the screen. |
| DE54690 | When plotting multiple series after editing the series name, you are unable to bring a series to the front on an X-Y chart . |
| DE54857 | When triggering from a Parallel Axis chart or a Spider Web chart, you are not able to apply a crosshair pointer across charts. The crosshair is limited to the specific charts in this scenario. |
Alerts – Release Date: October 30, 2017
New and Updated Features
- Internationalization of the Alert PDF, based on the language selected in the User Preferences.
- Tenant admins have the ability to set up an alert rule to automatically latch, or group, alerts.
- Ability to assign alerts.
- Ability for an analyst to reorder the columns in the Alert grid view.
- Tenant admins have the ability to set up an alert rule to automatically change the alert visibility.
- Ability for analyst to add Public Notes to Alert information.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE47053 | Resolved an issue where, during alert ingestion, when a user had an attachment with special characters in the name, the ingested alert did not show the attachment name in the UI. With the fix, the attachment name now appears in 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 ID | Description |
|---|---|
| DE44609 | When a template name has special characters such as '&' or '/' or '\' or '^', then when an alert is created using the template name, invoking Alert Details from the Alerts grid view will not work. Users can see the Alert Details from the Alerts Inbox page. Workaround: When creating a template, do not include any of the special characters '&' or '/' or '\' or '^'. |
| 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 selecting another alert and then returning to this alert after claiming the alert. The Plus (+) icon for creating a new recommendation appears. |
APM Extensibility – Release Date: November 3, 2017
New Features
- Product designer can package extension contents into a product by doing the following:
- Defining navigation routes to support Alert/Case links and Context Browser replacement.
- Configuring left navigation to support ordering, renaming, hiding and showing modules, and setting the landing module.
- Packaging extended content into a product.
- Publishing the product into a repository.
- GE Digital tenant administrator can subscribe a product for a tenant.
- A Partner or independent software vendor tenant administrator can upgrade a product for multiple tenants.
Assets – Release Date: October 30, 2017
New and Updated Features
Important: The APM Asset Instance, Group and Search documentation for navigating to a detail page does not apply for the configured custom asset faceplate or landing pages. APM does not provide custom APIs. You should see the tenant API documentation to invoke or read the custom asset faceplate and landing page configurations. See the tenant documentation for user information.
- Ability to load the custom asset faceplate for asset instance.
- Ability to load the custom asset faceplate for asset and tag instance landing pages associated with the results links in Search.
- Ability to load the custom asset faceplate for asset and tag instance landing pages associated with the results links in Group.
Cases – Release Date: October 30, 2017
New and Updated Features
- Updates to the Cases permission – View Case Detail.
- Internationalization of Case Notification content:
- Notification emails for Case Close actions
- Notification emails for Case Interpretation actions
- Notification emails for Case Notes actions
- Notification emails for Cases actions
- Internationalization of the Case PDF:
- Action section
- Evidence section
- Case Info section
- Interpretation section
- Closure section
- Section names
- Footer information
- Ability for an analyst to see the External Case ID in the Cases grid view.
- Ability for an analyst to view the audit log for a case.
- Ability for an admin to view the audit log for multiple cases.
Dashboards – Release Date: October 30, 2017
New and Updated Features
- Updated the widget repository API to support category = component.
- Updated the GET Widget API to fetch all the widgets where category = component.
- Ability to save and retrieve a component in the widget repository.
- Ability to update a component in the widget repository.
Resolved Issues
Resolved issues are those defects that have been fixed for the release.
| Tracking ID | Description |
|---|---|
| DE50316 | Resolved the issue such that navigating to a favorite dashboard now displays the asset name in the top left corner of the dashboard. |
| DE49821 | Resolved the issue so that users can search for any tags beyond the displayed 250 tags in the list. |
| DE49838 | Resolved the issue such that users will see the following message when only 250 tags are displayed and the asset contains more than those 250 tags: Search results show only up to 250 tags. Please narrow the search criteria to find additional tags. |
| DE49839 | Resolved the issue so that tags are now listed in alphabetical order when there are 250 tags. |
| DE49924 | An issue with loading the 1-month, 3-month, and 6-month data due to problems calculating the days in the month is resolved, and users should be able to see the data in all graph widgets for these time periods. |
| DE46080 | Resolved the issue so that graph widget with a Raw Data plotting option will show 1000 data points starting from the end date and going backwards. |
| DE51587 | Resolved an issue with the context browser when switching between Alerts and the Dashboard modules. |
| DE51151 | Resolved an issue such that users can now add multiple assets with more than 1000 tags in the Tag Tree browser when configuring a widget. |
Data – Release Date: October 30, 2017
New and Updated Features
- APM Time Series integrates with the new Smart Signal service to enable Smart Signal ad-hoc analysis charts in APM Analysis UI.
Templates – Release Date: October 30, 2017
New and Updated Features
- Update the View Case Details permissions.
- Ability for an analyst to view Analytics information in the Alert template.
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 |
|---|---|
| DE52834 | Users are unable to retrieve the associated analytics in an alert template, with the message Failed to retrieve associated analytics displayed in the Associated Analytics section of an alert template. This section will populate when there are associated analytics available, once the Associated Analytics feature is fully operational. |
| DE53526 | Users cannot edit an alert template that was originally created using a Source or Type that have since been made inactive. |
| DE53485 | Once an alert template has been created and saved, the Source menu in the Basic Info section of the Alert Template should not be enabled. Users should not edit the existing Source value even if the Source menu is enabled. |
Analysis – Release Date: October 30, 2017
New and Updated Features
- Ability to create custom navigation mechanism to set the context for the application. The Analysis application embeds the configured context browser in the Analysis module and replaces the existing context browser for tenants who have specified a custom context browser.
- The ability for Analysis to use the context that has been saved by another application, as well as allowing Analysis to set the context of the application in terms of the asset context.
Analytics – Release Date: October 30, 2017
New and Updated Features
- The common analytics framework (CAF) provides a new clean and scalable user experience that includes:
- Decoupled analytic configuration and deployments flows.
- Unified work flow for Analytics and Orchestration deployments.
- An easy access to deployment monitoring and history of analytic executions.
- CAF provides REST API services to upload or ingest your analytic logic, template definitions, and deployments all at once.
Resolved Issues
Resolved issues are those defects that have been fixed for the 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. |
| 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. |
Limitations
The following limitations applies to the orchestration execution in this release.
Alerts will not be generated for Analytics or related Orchestrations which utilize the Descriptive template data format.
- If a user deploys a Descriptive template-based analytic, or an Orchestration whose analytic data flow contains Descriptive template-based analytic steps (JSON data format), APM Analytics will not generate alerts from an analytic output.
- At this time, only hierarchical template-based analytics, or an Orchestration whose analytic data flow contains a hierarchical template-based analytic steps, will generate alerts as expected from an analytic output.
- Alert generation for Descriptive template-based analytics will be considered for a future release.
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 |
|---|---|
| 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. |
| DE50893 | Analytic version change should not reflect on the deployment. There is a mismatch between the displayed Version of the analytic in the Orchestration page and its deployment section.
|
| DE52119 | Asset selection should allow the ability to select more than twenty assets per deployment of analytic orchestration.
|