Skip to main content

Zuora Workflow Release Notes

Zuora

Zuora Workflow Release Notes

Workflow does not have a fixed schedule for product releases. We publish release notes only when a release contains user-facing changes.

June 4, 2020

We plan to roll out two changes in Workflow in this week and the next week.

  • Workflow entry points to be consolidated on June 9
  • New limit on the number of times that a task can repeat, to be effective on June 5

Starting from June 9, 2020, the Workflow menu item under Marketplace will be deprecated in all Zuora environments. After the change, Workflow can only be accessed via the menu item under Platform. The access to Workflow is now managed under the Platform role.

workflow_menu_items.png

If you can access the Workflow instance under Marketplace previously but cannot access the Workflow instance under Platform, ask your administrator to grant you the Workflow Access permission in the Platform role. For details, see Authentication for Standard Users.

platform_new_role.png

We have noticed that some customers use workflows that never end by allowing a task to repeat itself without an exit logic (see an example design below). It is not a recommended design and could waste a lot of resources. To prevent similar scenarios from happening, we will start to enforce a new configurable limit on the maximum number of times a task can repeat itself, within a loop session, to 1000. The limit will go into effect on June 5 for all Production tenants. For details, see Workflow limits.

workflow_repeat_design.png

May 15, 2020

Starting from May 15, 2020, a new limit on task payload size will apply in Workflow in all Zuora environments except Production. Each workflow task can have a maximum of 5 MB data payload. If the data payload of a workflow task exceeds 5 MB, an error will occur.

The same limit will start to apply in the Production environment on May 20.

We have contacted all customers that would have been impacted by this new limit.

The limit will replace all previous data size limits in Workflow (listed below), to reduce confusion and improve customer experience.

  • 50 KB for the text input field of workflow parameters
  • 100 KB for the JSON input field of workflow parameters
  • 300 KB for the conversion of XML documents to JSON
  • 300 KB for JSON transformations using Liquid
  • 1 MB for the total Liquid data size
  • 200 total records allowed for CSV to JSON

You can find the data payload of a workflow task and its size in the Swimlane of a task run. For details, see Workflow limits

May 2, 2020

Starting from May 2, a new cleanup policy will be introduced to Workflow in all Zuora environments except Production. The purpose of the new policy is to improve the efficiency and performance of Workflow. Under the new policy, workflow runs that have been completed without Pending, Processing, or Queued tasks for a configurable time period will be deleted. For all Zuora environments except Production, the default setting is 30 days and the configurable time range is 1-45 days. 

The cleanup policy is scheduled to be rolled out in Production on May 9. For the Production environment, the default setting is 45 days and the configurable time range is 1-90 days. 

workflow_cleanup_policy.png

Workflow run history can be used for very light auditing at maximum data volumes. In the future, Workflow will integrate with Zuora Audit Trail to store audit events for workflow runs and setup definitions changes. 

If you have any questions, please contact Zuora Global Support.

November 20, 2019

Workflow is now available in the Enhanced Production Copy Environment (ePCE) of Zuora. Same as in the Sandbox and Production environments, it is placed under Platform in the left navigation panel of Zuora UI.

The Enhanced Production Copy Environment supports features and products that are not available in the Production Copy Environment (PCE). The Enhanced Production Environment is still in Limited Availability. For the supported features and products in ePCE, as well as how to get access to it, refer to Zuora Testing Environments.

October 22, 2019

Soon we’ll implement a policy to stop workflows that have been paused for over seven days. If you have such workflows and do not want them to be stopped, please resume the processing of these workflows.

We do not recommend keeping workflows paused for too long, because the data may become out of date, which could generate inaccurate results.

To learn about how to pause and resume workflow processing, see Workflow Maintenance Utilities.

October 16, 2019

To help you calculate the number of task runs that have been used in a workflow run, we have added a new tab called Usage Summary for workflow runs.

Click a workflow run number in the Run History tab, and the Usage Summary tab will be displayed as the default tab. In this tab, the number of task runs is shown under each task.

You can also use the numbers shown in the tab to evaluate whether you need to revise the design of the workflow to achieve better efficiency.

workflow_run_number_column.png

workflow_usage_summary.png

September 6, 2019

An enhancement has been released to prevent unintentional email notifications in copies of workflows. When a workflow is exported, the email notifications upon the different status of tasks (failure, pending, or success) are turned off by default in the exported JSON data.

June 18, 2019

Workflow is now available under Platform in the left navigation panel of Zuora UI for all users having access to Zuora Production environments. You need to purchase Workflow before you can use it. 

For existing users of the Production Build of Workflow, the previously configured permissions must be updated by tenant administrators in Production environments. To learn about how to update the permissions, see Authentication for Standard Users.

June 4, 2019

Zuora Workflow is now available as a trial to all users having access to Zuora Sandbox environment. An enhancement has been implemented to improve user authentication for both Sandbox and Production environments.

The Zuora Workflow trial is only available in Zuora Sandbox environment. It includes up to 50,000 executed tasks per year. To learn more about how to configure and utilize Zuora Workflow, see Workflow.

Trial Version of Zuora Workflow

  • All users with access to Zuora Sandbox environment will be provisioned a trial of Zuora Workflow.

  • Each trial includes 50,000 tasks per year.

  • The trial will not impact customers currently using Zuora Workflow in the Sandbox environment.

Enhancements

  • Updated Workflow Authentication
    All previously configured permissions for Zuora Workflow must be updated by tenant administrators in Zuora Sandbox and Production environments.
    To learn about how to update your authentication, see Authentication for Standard Users.

Limitation of Zuora Workflow in Sandbox Environment

  • Data from an executed workflow will only be stored for 14 days.
    Effective immediately, all data stored from executed workflows older than 14 days in Zuora Sandbox environment will be purged from the Zuora Workflow database. The removal of data older than 14 days will be an automatic process that requires no configuration.

May 31, 2019

This release includes a new tab on the landing page of Workflow to provide a central place for all important information about workflows and tasks. 

New Features

A new tab called Overview has been added to the landing page of Workflow as the default tab. It contains a dashboard that shows the most important information about your workflows and tasks, including failed tasks, failed workflows, and workflows of different priorities in the queue. The dashboard will improve user experience and help customers get to the key information faster.

The layout of tabs on the landing page has also been adjusted slightly.

To learn more about the new user interface elements, see Workflow User Interface.