Skip to main content

Install Zuora Collect features

Zuora

Install Zuora Collect features

The functionality of Zuora Collect is divided into several different features. You need to install the features one by one.

Ensure that you have only one active instance of each feature in the environment. Multiple instances of the same feature in the environment may cause integration issues.

Prerequisites

  1. You must have a Zuora Connect account. See Sign Up for a Zuora Connect Account for more information.

  2. Create an OAuth login for your Zuora tenant. For details, see Create an OAuth Login in Zuora Connect.

    All Collect features use OAuth to authenticate to your Zuora tenant.

Procedure

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

    Install_Feature_1.png

  2. Locate an OAuth login of you Zuora tenant, hover over the login and click Apps. You will install all features other than Configurable Lockbox using this OAuth login.

    Install_Feature_2.png

  3. Select the Apps tab.

    Install_Feature_3.png

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

    7. Configurable Lockbox - 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.

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

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

Configuration Settings

The following table shows the configuration settings that you need in step 7 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 - 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.

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

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

Disputes

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.

Payment Plans

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.

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