Multi-entity in Workflow

Describes how Zuora Workflow supports the Multi-entity feature and how to specify the target entity when configuring Workflow tasks.

When Multi-entity is enabled for your tenant, Workflow can run tasks to interact with any entity in your multi-entity hierarchy that the Workflow OAuth user has access to. Most tasks that interact with Zuora data include an Entity selector so you can choose which entity the task operates with.

For an overview of Multi-entity, see Overview of Multi-entity.

Prerequisites

Before you use Multi-entity in Workflow, ensure the following requirements are met:

Multi-entity is enabled for the tenant.

Your Zuora tenant must have the Multi-entity feature enabled. If your tenant has only one entity, the Entity selector is not displayed in Workflow task settings.
Workflow OAuth user has access to multiple entities.

Workflow uses the OAuth credentials configured in global Workflow settings to authenticate API calls. Configure the OAuth client ID and client secret on the Workflow Settings tab. For instructions, see Configure OAuth login for Workflow.

The user associated with the OAuth client configured in Workflow settings must have access to the entities you want Workflow to operate in. Entity administrators can grant a user access to additional entities in the hierarchy. For instructions, see Grant user access to other entities.

The Entity dropdown lists the entities available to the Workflow OAuth user. If an entity does not appear in the list, verify that the OAuth user and OAuth client have access to that entity.

How entity selection works

Workflow determines the target entity for a task using the following order of precedence:

Task-level Entity setting - The entity selected in the Entity dropdown on a supported task.
Workflow-level Entity setting - The entity configured in the workflow definition settings (Entity Selection on the workflow configuration page).
Default entity - If no entity is specified, Workflow uses the default entity for the tenant.