Install Zuora Collect Features

Knowledge Center > Collect > Setup and Administration > Install Zuora Collect Features

Install Zuora Collect Features

Prerequisites

  • If you do not have a Zuora Connect account, visit https://connect.zuora.com/users/register to sign up. See Sign Up for a Zuora Connect Account for more information.

  • After you have signed up for a Zuora Connect account, you must link your Zuora tenant with your Zuora Connect account. To do this, follow the procedure in Link Your Zuora Tenant and Connect. You must perform this procedure in Zuora Connect.

  • You must also create an OAuth login for your Zuora tenant because some Collect features use OAuth to authenticate to your Zuora tenant. To do this, follow the procedure in Create an OAuth Login in Zuora Connect.

    The following Collect features use OAuth to authenticate to your Zuora tenant:

    • Configurable Payment Retry
    • Collections Window
    • Notes
    • Advanced Payment Manager

Install Each Collect Feature

The Collect features to install are:

  • Workflow
  • Configurable Payment Retry
  • Collections Window
  • Notes
  • Advanced Payment Manager
  • Configurable Lockbox

All Collect features should be created through Zuora Connect and not through your Zuora tenant. Navigate to Zuora Connect to get started.

  1. In Zuora Connect, navigate to My Connect > Tenants.

    Install_Feature_1.png

  2. Hover over the Zuora Connect login for your Zuora tenant, then click Apps.

    Install_Feature_2.png

    When you are installing each of the following features, choose a Zuora Connect login that stores the username and password of a user account in your Zuora tenant:

    • Workflow
    • Configurable Lockbox

    When you are installing each of the following features, choose a Zuora Connect login that stores OAuth authentication details for you Zuora tenant.

    • Configurable Payment Retry
    • Collections Window
    • Notes
    • Advanced Payment Manager
  3. Select the Apps tab.

    Install_Feature_3.png

  4. Click New, then select the feature to install.

    Install_Feature_4.png

    The following Collect features have different names in Zuora Connect:

    • Configurable Payment Retry - The feature is called "Advanced Payment Retry - Collect" in Zuora Connect.
    • Configurable Lockbox - The feature is called "Lock box - Ruby" in Zuora Connect.
  5. Complete the configuration of the feature, then click Create.

    Feature_Configuration_OAuth.png

    Use the following settings when configuring each feature:

    Feature Settings

    Workflow

    General settings:

    • Name - Any name that you can easily identify later
    • Run Mode - Collections
    • Execution - External
    • Target - Authentication details for your Zuora tenant. Choose a Zuora Connect login that stores the username and password of a user account in your Zuora tenant

    Advanced settings:

    • Build Mode - Production

    Configurable Payment Retry

    General settings:

    • Name - Any name that you can easily identify later
    • Run Mode - Universal
    • Execution - External
    • Build Name - Production
    • Target - Authentication details for your Zuora tenant. Choose a Zuora Connect login that stores OAuth authentication details for you Zuora tenant

    Collections Window

    General settings:

    • Name - Any name that you can easily identify later
    • Run Mode - Universal
    • Execution - External
    • Build Name - Production
    • Target - Authentication details for your Zuora tenant. Choose a Zuora Connect login that stores OAuth authentication details for you Zuora tenant

    Notes

    General settings:

    • Name - Any name that you can easily identify later
    • Run Mode - Export
    • Execution - External
    • Build Name - Production
    • Target - Authentication details for your Zuora tenant. Choose a Zuora Connect login that stores OAuth authentication details for you Zuora tenant

    Advanced Payment Manager

    General settings:

    • Name - Any name that you can easily identify later
    • Run Mode - Universal
    • Execution - External
    • Build Name - Production
    • Target - Authentication details for your Zuora tenant. Choose a Zuora Connect login that stores OAuth authentication details for you Zuora tenant

    Configurable Lockbox

    General settings:

    • Name - Any name that you can easily identify later
    • Run Mode - Configurable
    • Execution - External
    • Build Name - Production
    • Target - Authentication details for your Zuora tenant. Choose a Zuora Connect login that stores the username and password of a user account in your Zuora tenant

What's Next?

After you install each feature, Zuora starts an instance of the feature.

You are now ready to set up each Collect feature. See the following articles for more information:

As you set up each Collect feature, Zuora creates the following custom fields in your tenant:

Object Custom Field Label Custom Field Type

Account

APM

Picklist

Account

Collections Agent

Text

Account

In Collections

Picklist

Account

Retry Status

Text

Debit Memo

Only available if the Invoice Settlement feature is enabled in your tenant.

Retry Status

Text

Invoice

Retry Status

Text

Subscription

Payment Method Id

Text

If you have already created the necessary custom fields in your tenant, Zuora does not create duplicate custom fields.

Last modified

Tags

Classifications

(not set)