Product Notices

On this page:

Breaking Changes

The following are breaking changes for the 2019.3 distribution.

app-workflow_engine

Removed the deprecated APIs for startJob, getCompletedJobs and getJobById. For replacement information, go to the Deprecations guide in Product Notices and see the Methods > Workflow Engine page.

app-workflow_builder

Removed the deprecated APIs for getWorkflowsFiltered and getWorkflowsList. For replacement information, go to the Deprecations guide in Product Notices and see the Methods > Workflow Builder page.

Updated Interface

The interface for both the workflow builder and list of workflows is now accessed through Automation Studio. There is no longer a shortcut icon on the IAP dashboard for this application. Go to Automation Studio to enjoy the exciting changes for automation creation!

app-form_builder

Updated Interface

The interface for both form builder and the list of forms is now accessed through Automation Studio. There is no longer a shortcut icon on the IAP dashboard for this application. Be sure to check out Automation Studio for form creation!

app-mop

Updated Interface

The interface for both command templates and analytic templates is now accessed through Automation Studio. There is no longer a shortcut icon on the IAP dashboard for this application. Automation Studio is now your go-to for command and analytic template creation!

app-template_builder

Updated Interface

The interface for viewing and building templates is now accessed through Automation Studio. There is no longer an icon on the IAP dashboard for this application. We're confident you'll enjoy the exciting changes in Automation Studio for template creation!

app-array

This application has been completely removed, and all tasks previously within this application have been moved inside of app-workflow_engine (which appears under the 'WorkFlowEngine' heading within the Workflow Builder Task list). The previous routes inside app-array will not exist, and no new routes have been created to replace them. Tasks will still appear under the Array tab.

The 'toString' task previously within app-array now also takes in two additional parameters and may perform slightly differently. Previous tasks will be automatically migrated.

app-json

This application has been completely removed, and all tasks previously within this application have been moved inside of app-workflow_engine (which appears under the 'WorkFlowEngine' heading within the Workflow Builder Task list). The previous routes inside app-json will not exist, and no new routes have been created to replace them. The JSON tab has also now been removed. Stringify has been moved to the Object tab and renamed to toString. Parse has been moved to the String tab. Please update any workflows that use these tasks to their new equivalents.

app-number

This application has been completely removed, and all tasks previously within this application have been moved inside of app-workflow_engine (which appears under the 'WorkFlowEngine' heading within the Workflow Builder Task list). The previous routes inside app-number will not exist, and no new routes have been created to replace them. Tasks will still appear under the Number tab.

app-object

This application has been completely removed, and all tasks previously within this application have been moved inside of app-workflow_engine (which appears under the 'WorkFlowEngine' heading within the Workflow Builder Task list). The previous routes inside app-object will not exist, and no new routes have been created to replace them. Tasks will still appear under the Object tab.

app-string

This application has been completely removed, and all tasks previously within this application have been moved inside of app-workflow_engine (which appears under the 'WorkFlowEngine' heading within the Workflow Builder Task list). The previous routes inside app-string will not exist, and no new routes have been created to replace them. Tasks will still appear under the String tab.

The concat task previously within app-string now only takes in an array of strings as its second parameter (stringN), as opposed to previously taking in a string or an array of strings. Previous tasks as well as strings will be automatically migrated to an array including just that string parameter. Please ensure any imported workflows are modified to accomodate this change.

app-tools

This application has been completely removed, and all tasks previously within this application have been moved inside of app-workflow_engine (which appears under the 'WorkFlowEngine' heading within the Workflow Builder Task list). The previous routes inside app-tools will not exist, and no new routes have been created to replace them. The one exception to this is diffToHTML, which has changed its route from /tools/diffToHTML to /workflow_engine/diffToHTML and has been deprecated. Tasks will still appear under the Tools tab. Please update any workflows that use these tasks to their new equivalents.

app-configuration_manager

Changed getDevicesFiltered to now require the 'limit' property. Previously if the 'limit' property was not provided or if 'limit=0' then the result would yield all devices. If there were a high number of devices, then this would cause timeouts or exception errors. For system integrity, we have removed the capability to list all.

Tags Application

Updated Interfaces

Both createTag and createTags were updated to handle additional cases not previously covered. Both functions now return an error object for negative cases.

Error Object Returned

{
   code,
   message: {
     error,
     [dataName]: data,
   },
 }
Error Object Part Description
code The error code when an error is processed (presently set to 422 for all errors).
error A string containing the reason for the error.
[dataName] The particular data element related to the error.

Rules for createTag

  1. A tag name must have four (4) characters or more, or an error object is returned.
  2. If the tag object contains an ID, the ID is stripped away and a new one is created if all previous and remaining tag creation rules pass.
  3. A tag with the same name will cause an error object to be returned.

Rules for createTags

  1. The interface now checks for the object type to be an array of tag objects or it will return an error object.
  2. All tag names must be four (4) characters or more, or an error object is returned.
  3. If a tag object contains an ID, the ID is stripped away and a new one is created if all previous and remaining tag creation rules pass.
  4. The submitted tags array is examined for duplicates. Only the non-duplicates are added after passing the previous rules.