APM Release Notes for the First Quarter of 2018
Alerts and Cases Release Notes for March 30, 2018
This topic provides a list of new and updated product features that are available for this release. It also provides a list of resolved and known issues in this version of Alerts and Cases
Release Information
| Module Name |
Alerts Cases |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2018 |
What's New or Changed in This Release
This section outlines the new product features that are available for this release.
- Previously, in an email notification triggered by an alert or a case, the email message contained the following details:
- User Name
- Asset Name
- Asset ID
- Asset Site Name
- Notes related to the alert or case
These details have now been removed from the template for email notification. The email about an alert or case notification will now contain only a hyperlink to the Alert or Case details in GE Digital APM.
Known Issues
This section provides a list of known issues in this release
| Tracking ID | Description |
|---|---|
| DE69850 | The alert status does not automatically change to Processed even though the condition is met, which is specified in the Automation Rules section of the Tenant Preferences page. |
APM Extensibility
This topic provides a list of product changes released for this module on the dates listed below.
| Note | Tracking ID |
|---|---|
Product designer can package extension contents into a product, which now includes the following product artifacts:
| N/A |
| Product designer can reset navigation to default settings. | N/A |
Tenant administration can upgrade specific products, including the ability to do the following:
| N/A |
| Note | Tracking ID |
|---|---|
| When migrating a product from one environment to another, contents that is packaged in the product are not automatically deployed to the tenant of the target environment. For example, migrating a product stored in the repository residing in “RC” to “Pre-Prod”, only moves the product from the “RC” repository into the “Pre-Prod” repository. It does not automatically deploy the product to the target tenant in the “Pre-Prod” environment. The workaround for this is to follow the subscription workflow to subscribe to the migrated product in the tenant that you just migrated to. | N/A |
Alerts Templates and Cases Templates Release Notes for March 30, 2018
This topic provides a list of new and updated product features that are available for this release. It also provides a list of resolved and known issues in this version of Alerts Templates and Cases Templates
Release Information
| Module Name |
Alerts Templates Cases Templates |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2018 |
What's New or Changed in This Release
This section outlines the new product features that are available for this release
- Users with administrator privileges can now view the audit logs for Alert Templates and Case Templates in the Audit Log Management page.
Analysis Release Notes for March 30, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
| Module Name | Analysis |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2016 |
New and Updated Features
- Ability to import asset classification based on analysis.
- Ability to export asset classification based on analysis.
- Ability to save SmartSignal charts as PNG images.
- Ability to export SmartSignal template data in CSV format.
- Ability to change the size of a SmartSignal chart.
- Ability to drag and drop multiple tags on to a SmartSignal card.
- Ability to toggle SmartSignal chart titles between tag name and tag path.
- Ability to view the formula of calculated tags in SmartSignal Analytics
- Ability to differentiate between external tags and calculated tags in SmartSignal Analytics
- Ability to set the permissions on Analysis templates to restrict access to Enterprises or User Groups.
- Ability to use user preferred display name in analysis for assets and tags.
- Ability to set the System of Measure and UoM for tags on a chart.
- Highlight Data Points across Cards.
- Cross Hair across Cards.
- Enabled Cross Hair on SmartSignal Charts.
- Ability to search by tag description in advanced search.
- Display gaps for filtered data points in charts.
- Cannot plot data points with bad data quality.
- Displays UoM to tag popover.
- Removed UoM restrictions on XY charts.
Limitations
- Numeric constants used in tag expressions are only supported in English format and not internationalized.
Known Issues
| Defect | Description |
| DE67005 | Zoom across charts does not work for charts that have not been loaded. |
Analytics Release Notes for February 8, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
| Module Name | Analytics |
| Release Date | February 8, 2018 |
| Documentation Build Date | February 8, 2018 |
What's New or Changed in This Release
- Bring Your Own Runtime - Ability to register, enable for a tenant, and utilize an external custom runtime with GE Digital APM Application Analytics. This feature is release with limited availability.
- Ordering of deployments in Orchestrations
- Ability to assign a priority value to individual deployments in the 3. Schedule page.
- This is enabled only for deployments associated with analytics orchestrations for a registered, external custom runtime.
Limitations and Known Issues
| Tracking ID | Description |
|---|---|
| DE62740 |
For analytics that are deployed and run in the Predix Analytic runtime, redeploying with a newer version of the analytic uploaded to the catalog results in a failed deployment with the newer version. The deployment status resets to Not Deployed and the system responds with an error invalid service task name <task id>. Workaround: For all analytics that must be deployed to the Predix Analytic runtime, make sure that you create a new deployment for every time a new version of analytics is uploaded to the catalog. All existing deployments will continue to use the older version of the analytics used to first deploy it. |
| DE62748 | The Analytics Deployment will be saved; however, the Analytic will fail to deploy or run if the Sampling Interval for interpolated data is set to 0 minutes or 0 seconds. The minimum expected value is 1 second. |
| DE63501 |
After tenant creation, default asset filters and filter fields data may not be available for the new tenant that was set up in QA2 environment. If this happens then, do the following: Note: Only a system administrator can perform these steps.
|
Resolved Issues
| 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 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, 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, and then 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. |
Analytics Release Notes for March 30, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
| Module Name | Edge Analytics |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2018 |
What's New or Changed in This Release
- Support for Analytics/Orchestrations on Spark Runtime (Limited Availability)
- Uses the Predix Insights (Beta) capabilities.
- Orchestration data flows are supported for both Java and Python based analytics in this runtime.
- Provides the ability to modify and delete orchestration deployments.
- Provides the ability to map an existing output tag as the input for the next step in the orchestration data flow. This functionality is limited to configuring already ingested tags in the asset model. It is not possible to use output tags generated by the analytic during runtime.
- Ability to Ingest, Configure and Deploy analytics to the Edge Analytics Runtime (Limited Availability - available on request only)
- Users can download and install the Edge Analytics Editor to create analytics. This is accessible from the Edge Manager repository for the (cloud) application tenant.
Limitations
- Analytics/Orchestrations on Spark Runtime has the following limitations:
- Orchestration deployments for Spark runtime can only be scheduled using the RunOnce and Streaming options.
- Orchestration deployments for Spark runtime scheduled using Streaming option limits it to one step only.
- Spark runtime does not cache the analytic outputs during analytic execution.
- No fallback supported if an orchestration deployment fails in the Spark runtime after running the deployment.
- Edge Analytics runtime has the following limitations
- Currently Edge Analytics only supports OPC UA for automated data collection and deployment.
- While most functionality is available, there is no support to modify existing Edge Analytics deployment instances.
- You must configure and set up the Edge Manager separately. For example, installation of Edge Analytics runtime and other software must be performed separately.
- Deployments are sequential: only a single Deploy or Delete operations can be done at any time. You must first complete the action before another user initiates the next Deploy or Delete operation.
- Deployment Deletion
- Failed deployments, that go from, In Progress status to Not Deployed status, must be:
- Deleted from Deployments list in Application Analytics
- All CAF_Configuration files and Analytics on each Edge Device must be manually deleted (cleaned up) using Edge Manager to ensure that Edge Device state remains consistent with Deployments listed in Application Analytics.
- Application Analytics automatically deletes deployments in the Edge Devices, when you delete deployments in Application Analytics that have successful Edge Analytics Deployments statuses of Deployed, or Scheduled.
- While a Delete operation is in progress, indicated by spinning wheel - wait/busy icon, a user must not navigate away, but just wait until busy icon disappear. The deployment is removed from Deployments, which indicates that Delete operation has been completed. After which, the user should confirm in Edge Manager that all analytics, and related configuration to this Deployment has been removed/updated on the relevant Edge Devices.
- After a deployment has been deleted, you cannot reuse the same name for another Edge Analytics Deployment.
- Failed deployments, that go from, In Progress status to Not Deployed status, must be:
Known Issues
| Tracking ID | Description |
|---|---|
| DE64497 |
For analytics deployments to Edge Analytics runtime, during the 2. I/O Mapping step in Deployment, the Deploy button remains disabled if optional input fields are not fully mapped even though it is not required. Make sure that during 2. I/O Mapping step in Deployment, all input tags are fully mapped before proceeding irrespective of whether or not they are required inputs. |
| DE67658 |
In Predix runtime, tags conforming to the expected tag nomenclature do not get listed as expected in I/O Mapping when selecting the Map for All Assets and Add Suggested Tags options. Workaround: Manually perform the I/O mapping to the correct input and output tags. |
| DE67897 |
The Delete button remains disabled for deployments with the status In-Progress for analytics deployed to the Edge Analytics runtime. Typically, even though deletion of deployments is not currently supported for Edge Analytics runtime, the Delete button is expected to remain enabled. When you select the button, an error message In-progress deployments cannot be deleted should appear. |
| DE64793 |
Even though a deployment only requires either the output definition or output event to be configured correctly in an analytic template, Application Analytics does not allow the user to create deployments using a template that does not have output definitions. Even if the Deployment tab is enabled, the user cannot create deployments and the error message: Unable to create deployment as there are no 'outputs' for the <analytic_template> analytic appears. |
| DE62724 |
For analytics deployed to SmartSignal runtime, in the rm deployment- IOMappingMetadata1.json, Application Analytics does not display a warning or error message when the configured constant value does not match the constant data type. This can potentially lead to deployment failures. Workaround: Always ensure that the constant values entered must match the data type defined in the analytic template configuration. |
| DE69377 |
For analytics deployed to the Spark runtime and scheduled to Runonce; even though the interpolated option is selected, the data always returns as raw data from timeseries instead of the expected interpolated results. |
Resolved Issues
| Tracking ID | Description |
|---|---|
| DE63501 |
After tenant creation, default asset filters and filter fields data may not be available for the new tenant that was set up in QA2 environment. If this happens then, do the following: Note: Only a system administrator can perform these steps.
|
Asset Release Notes for March 30, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
| Module Name | Asset |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2016 |
Limitations
- Support for the cascade-delete feature is limited to 2000 objects. As an alternative, you can delete a single asset instance at a time. If you are trying to move the asset instances within a hierarchy, it is recommended you use the API to change the parent object.
Resolved Issues
| Tracking ID | Description |
|---|---|
| DE62354 | When a user clicks on the asset name in the alerts detail pane, the system opens a chromeless window displaying the asset faceplate. The system by defaults opens the events tab. |
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 |
|---|---|
| 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. |
| DE57601 | Timestamp is incorrect if time zone in user preferences is set to UTC + 14(Kiritimati) |
| DE61811 | Newly created alert (count) is not seen immediately without refreshing the page (Date picker is not reflecting current time) |
| DE68896 | Users who provided malformed URLs, of the format with two // characters side by side, previously the system would process the URL as if only one / were present. If this malformed URL is presented now the system will generate an error. |
Asset Release Notes for February 28, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
| Module Name | Asset |
| Release Date | February 28, 2018 |
| Documentation Build Date | February 26, 2018 |
What's New or Changed in This Release
This section outlines the new and updated product features that are available for this release.
- Configure the equipment template with tag classifications.
- Create an equipment instance with dynamic tag instance using the equipment template.
- Event search for past alerts and cases related to the selected asset instance.
- Navigate from an Event to an Alert or Case.
Limitations
- You should limit the number of objects during ingestion to 150,000 objects per file. The ingestion will continue, however when you inspect the job on the data ingestion page, the summary will either load very slowly or not load at all.
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 |
|---|---|
| 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. |
| DE57601 | Timestamp is incorrect if time zone in user preferences is set to UTC + 14(Kiritimati) |
| DE61811 | Newly created alert (count) is not seen immediately without refreshing the page (Date picker is not reflecting current time) |
| DE62354 | When a user clicks on the asset name in the alerts detail pane, the system opens a chromeless window displaying the asset faceplate. The system by defaults opens to the attributes tab instead of the events tab. |
Asset Release Notes for January 26, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
Product: GE Digital APM Asset
Documentation Build Date: January 19, 2018
Release Date: January 26, 2018
New and Updated Features
- Display past events that affected the selected asset instance. Users will now be able to click on an asset name from te alerts detail view and see a timeline view of all the related alerts and case.
- Decommission an asset instance. By default, all asset instances in the decommissioned state will no longer be viewable without granting an explicit permission.
Limitations
- When ingesting asset JSON files, the CCOM Type is case sensitive and must be entered in capital letters.
- Users with the All resources permission can see Decommissioned Assets.
- Users with the View Decommissioned Asset policy can create an alert for a decommissioned asset.
Resolved Issues
| Tracking ID | Description |
|---|---|
| DE57037 | If no events are displayed, the count is refreshed to zero and retains last search count for All, Alerts and Cases. Zero is displayed if no data found. |
| DE56868 | When cases are updated, then Asset Events reflects last updated time stamp. |
Known Issues
| Tracking ID | Description |
|---|---|
| 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. |
| DE57601 | Timestamp is incorrect if time zone in user preferences is set to UTC + 14(Kiritimati) |
| DE61811 | Newly created alert (count) is not seen immediately without refreshing the page (Date picker is not reflecting current time) |
| DE62354 | When a user clicks on the asset name in the alerts detail pane, the system opens a chromeless window displaying the asset faceplate. The system by defaults opens to the attributes tab instead of the events tab. |
Dashboard Release Notes for March 30, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
| Module Name | Dashboard |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2018 |
New and Updated Features
- Updates to widgets.
Limitations
- No limitations at this time.
Known Issues
No known issues at this time.
Dashboard Release Notes for January 26, 2018
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Documentation Build Date:January 2018
Release Date:January 26, 2018
New and Updated Features
- No new or updated features.
Limitations
- No new or updated limitations.
Known Issues
There are no known issues in the release.
Resolved Issues
| Tracking ID | Description |
|---|---|
| DE55729 | APM Dashboards lose contact with data service and display data unavailable. |
SmartSignal
This topic provides a list of product changes released for this module on the dates listed below.
Release Date: March 30, 2018
| Note | Tracking ID |
|---|---|
| You can now take edit control of a SmartSignal deployment when another user has the deployment locked for editing. | US221821 |
| You can now synchronize an analytic instance with an analytic template version added in Application Analytics or SmartSignal Mappings. | US216796 |
| You can now manually specify which data you want to include or exclude in a training data chart. | US207633 |
| You can now modify the standard unit of measure for a tag in the workspace for a deployment in SmartSignal Maintenance. | US207621 |
| You can now modify the value in the Source Tag field for a tag in a deployment in SmartSignal Maintenance. | US207612 |
| You can now activate or deactivate a tag in the workspace for a deployment in SmartSignal Maintenance. | US207604 |
| You can no longer create APM assets from a SmartSignal Analytic instance. Note: You can still use JSON to create APM assets from an asset input file.
| US194388 |
| Note | Tracking ID |
|---|---|
| Charts displayed in GE Digital APM Analysis can contain a maximum of 200,000 data points per tag. | US241973 |
| When you modify the Source Tag field value for a tag in an analytic deployment instance, the APM Asset tag ID is not automatically updated to match the new Source Tag value. | US241973 |
| In order to use SmartSignal analytic templates in GE Digital APM, the templates must be created and maintained in a SmartSignal Classic installation. The templates are imported as files into the APM tenant. | US241973 |
| When you synchronize an analytic deployment instance with an analytic template version containing structural changes, you can no longer export the instance back to a SmartSignal Classic installation. | US241973 |
Time Series Data
Provides a list of new and updated features for this release, as well as any resolved issues, limitations, and known issues.
Release Information
| Module Name | Times Series Data |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2018 |
New and Updated Features
- In Time Series Data, the /v1 endpoints from the apm-timeseries-query-svc application have been deprecated. Consumers of the query endpoint should migrate to /v2 or above versions of the existing apm-timeseries-query-svc.
In addition, ingestion functionality from the apm-timeseries-query-svc application have been removed. Ingestion functionality will be available in the new module, apm-timeseries-ingestion-svc, which improves performance and adaptability.
Consumers of the ingestion endpoints on the existing apm-timeseries-query-svc should migrate to use the /v2 version endpoint on the new ingestion service, apm-timeseries-ingestion-svc.
You can find more information about these endpoints and the functionality they provide in the Time Series Data API documentation at https://apm-apidocs-rc.int-app.aws-usw02-pr.predix.io/.
- Partial tag data access is supported in the v5 endpoint in the query service.
- Starting in v5 endpoint, the CURRENT operation of the query service searches data 15 days back instead of a year.
Limitations
- No limitations at this time.
Known Issues
No known issues at this time.
Units of Measure Conversions Release Notes for March 30, 2018
This topic provides a list of new and updated product features that are available for this release. It also provides a list of resolved and known issues in this version of Units of Measure Conversions.
Release Information
| Module Name | Units of Measure Conversions |
| Release Date | March 30, 2018 |
| Documentation Build Date | March 22, 2018 |
What's New or Changed in this Release
This section outlines the new or enhanced product features that are available for this release.
- You can now upload multiple units of measure conversions using a template file. To facilitate this enhancement, the Upload Conversions section has been added to the Units of Measure Conversions page.
- You can now export multiple units of measure conversions to a single Microsoft Excel file. To facilitate this enhancement, the Export option has been added to the options that appear when you select
in the Units of Measure Conversions page. - You can now view the audit logs for units of measure conversions in the Audit Log Management page.