Install Zuora Collect Features

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

Install Zuora Collect Features

The functionality of Zuora Collect is divided into several different features. Use the following procedure to install the features:

  1. 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.

  2. Link your Zuora tenant with your Zuora Connect account. To do this, see Link Your Zuora Tenant and Connect. You must perform this step in Zuora Connect.

  3. Create an OAuth login for your Zuora tenant. To do this, see Create an OAuth Login in Zuora Connect.

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

    • Workflow
    • Configurable Payment Retry
    • Notes
    • Statement Generator
    • Collections Window
    • Advanced Payment Manager

    The Configurable Lockbox feature does not use OAuth to authenticate to your Zuora tenant.

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

    Install_Feature_1.png

  5. Locate a Zuora Connect login that stores OAuth authentication details for you Zuora tenant, then hover over the Zuora Connect login and click Apps.

    Install_Feature_2.png

  6. Select the Apps tab.

    Install_Feature_3.png

  7. On the Apps tab, install the following Zuora Collect features:

    1. Workflow - Click New, then select Workflow.

      Install_Feature_4.png

      The New Configuration dialog box opens. Complete the configuration of the Workflow feature, then click Create. See Configuration Settings (below) for more information.

    2. Configurable Payment Retry - Click New, then select "Advanced Payment Retry - Collect". The New Configuration dialog box opens. Complete the configuration of the Configurable Payment Retry feature, then click Create. See Configuration Settings (below) for more information.

    3. Notes - Click New, then select Notes. The New Configuration dialog box opens. Complete the configuration of the Notes feature, then click Create. See Configuration Settings (below) for more information.

    4. Statement Generator - click New, then select Statement Generator. The New Configuration dialog box opens. Complete the configuration of the Statement Generator feature, then click Create. See Configuration Settings (below) for more information.

    5. Collections Window - Click New, then select Collections Window. The New Configuration dialog box opens. Complete the configuration of the Collections Window feature, then click Create. See Configuration Settings (below) for more information.

    6. Advanced Payment Manager - Click New, then select Advanced Payment Manager. The New Configuration dialog box opens. Complete the configuration of the Advanced Payment Manager feature, then click Create. See Configuration Settings (below) for more information.

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

  9. Locate a Zuora Connect login that stores the username and password of a user account in your Zuora tenant, then hover over the Zuora Connect login and click Apps.

  10. Select the Apps tab.

  11. To install the Configurable Lockbox feature, click New, then select "Lock box - Ruby". The New Configuration dialog box opens. Complete the configuration of the Configurable Lockbox feature, then click Create. See Configuration Settings (below) for more information.

After installing the features of Zuora Collect, set up the features according to the following instructions:

  1. Set Up the Workflow Feature
  2. Set Up the Configurable Payment Retry Feature
  3. Set Up the Statement Generator Feature
  4. Set Up the Advanced Payment Manager Feature
  5. Set Up the Configurable Lockbox Feature

Configuration Settings

The following table shows the configuration settings that you need in steps 7 and ?? of the installation procedure (above).

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 OAuth authentication details for you Zuora tenant

    After choosing the Zuora Connect login, click Edit, then check whether the WSDL version at the end of the URL is 89.0. For example, https://www.zuora.com/apps/services/a/89.0

    If the WSDL version is not 89.0, change the WSDL version to 89.0, then click Save Login. See Zuora WSDL for information about WSDL versions.

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

    After choosing the Zuora Connect login, click Edit, then check whether the WSDL version at the end of the URL is 89.0. For example, https://www.zuora.com/apps/services/a/89.0

    If the WSDL version is not 89.0, change the WSDL version to 89.0, then click Save Login. See Zuora WSDL for information about WSDL versions.

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

    After choosing the Zuora Connect login, click Edit, then check whether the WSDL version at the end of the URL is 89.0. For example, https://www.zuora.com/apps/services/a/89.0

    If the WSDL version is not 89.0, change the WSDL version to 89.0, then click Save Login. See Zuora WSDL for information about WSDL versions.

Statement Generator

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

    After choosing the Zuora Connect login, click Edit, then check whether the WSDL version at the end of the URL is 89.0. For example, https://www.zuora.com/apps/services/a/89.0

    If the WSDL version is not 89.0, change the WSDL version to 89.0, then click Save Login. See Zuora WSDL for information about WSDL versions.

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

    After choosing the Zuora Connect login, click Edit, then check whether the WSDL version at the end of the URL is 89.0. For example, https://www.zuora.com/apps/services/a/89.0

    If the WSDL version is not 89.0, change the WSDL version to 89.0, then click Save Login. See Zuora WSDL for information about WSDL versions.

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

    After choosing the Zuora Connect login, click Edit, then check whether the WSDL version at the end of the URL is 89.0. For example, https://www.zuora.com/apps/services/a/89.0

    If the WSDL version is not 89.0, change the WSDL version to 89.0, then click Save Login. See Zuora WSDL for information about WSDL versions.

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

    After choosing the Zuora Connect login, click Edit, then check whether the WSDL version at the end of the URL is 89.0. For example, https://www.zuora.com/apps/services/a/89.0

    If the WSDL version is not 89.0, change the WSDL version to 89.0, then click Save Login. See Zuora WSDL for information about WSDL versions.

What's Next?

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

As you set up each Collect feature, Zuora creates the following custom fields in your tenant. It may take several minutes for custom fields to be created.

Object Custom Field Label Custom Field Type

Account

APM

Picklist

Account

Collections Agent

Text

Account

In Collections

Picklist

Account

Retry Status

Text

Account

StatementTemplate

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)