Knowledge Center

Knowledge Center > Integrations and Extensions > Extension Platform > Creating and Managing Your Extensions

Creating and Managing Your Extensions

The Extension Platform feature is in Limited Availability. If you wish to have access to this feature, send a request to extension-platform-request@zuora.com.

This article explains how to view, create, enable, edit, and delete Extensions, as well as how to download logs for troubleshooting. See Extension Platform Introduction to learn more about the Extension Platform feature as a whole.

Prerequisites

Before you can start creating and managing Extensions:

  • The Extension Platform feature must be enabled on your tenant.
  • You must be a Z-Platform Administrator or be logged in to a user role with the Z-Platform Extension Platform Access permission enabled.

View Your Extensions

Navigate to Z-Platform > My Extensions. The My Extensions page is displayed, as shown below.

Viewing Your Extensions

The page lists all of your existing Extensions, with the most recently updated Extension at the top.

From this page, you can:

  • Create Extensions
  • Enable Extensions
  • Edit Extensions
  • Delete Extensions
  • Download Logs

See the following sections for steps on how to perform each of these actions.

Create an Extension

To create a new Extension, perform the following steps:

  1. Navigate to Z-PlatformMy Extensions.
  2. Click add new extension. The New Extension page is displayed, as shown below.
    Create New Extension Data Instance
  3. Configure the fields on the New Extension page. The following table describes each field.
Field Description

Extension Type

Select the type of Extension you want to create. For example, if you select Charge Model, then your Extension will define a new Charge Model that you can use.

Name

Enter a name for the new Extension.

Description

Optionally enter a description of the new Extension.

Extension Profile

Select an Extension Profile. The Extension profile defines the Zuora standard functions that your new Extension will replace.

For example, if you select Multi-Attribute Pricing - Charge, the Extension will calculate the amount for any Usage Charges that are using the Per Unit Pricing Charge Model.

You can mouse-over the question mark icon to the right of the Extension Profile drop-down menu to see a list of functions for the selected profile.

See Sample Extensions for examples of Extensions you can create with each profile.

Plugin File

Upload a plugin file. The plugin file is a piece of Java code you developed to override the functions specified in the Extension Profile.

Must be a .jar file.

  1. Click save.

After you have created an Extension, you must enable the Extension before you can start using it. See the following section for instructions.

Enable an Extension

To enable an Extension, perform the following steps:

  1. Navigate to Z-Platform > My Extensions.
  2. Click Enable in the Actions column to the right of the Extension you want to enable. A dialog box is displayed.
  3. Click Confirm. The Status column now shows that the Extension is enabled.

You cannot disable an Extension once it has been enabled. However, you can delete an enabled Extension. See the Deleting an Extension section below for more details.

Edit an Extension

If you upload a new Plugin File to an active Extension, the existing Plugin File will be overwritten even if the Extension is already in use. Make sure that the Extension is not in use when you upload a new Plugin File.

To edit an Extension, perform the following steps:

  1. Navigate to Z-Platform > My Extensions.
  2. Click Configure in the Actions column to the right of the Extension name.
  3. Make changes to the Extension.
    • If the Extension is not yet enabled, you can change any field except for Name.
    • If the Extension is enabled, you can only edit Description or upload a new Plugin File. The existing Plugin File name is displayed to the right of the Plugin File field, as shown in the following figure.

Uploading a New Plugin File

  1. Click save.

Delete an Extension

You can only delete Extensions that are not in use. For example, if you create an Extension of the type Revenue Recognition Model, and then you create and activate a new Revenue Recognition Rule based on that model, you cannot delete the Extension. You must first deactivate the Revenue Recognition Rule, and then you can delete the Extension.

To delete an Extension, perform the following steps:

  1. Navigate to Z-Platform > My Extensions.
  2. Click Delete in the Actions column to the right of the Extension you want to enable. A dialog box is displayed.
  3. Click Yes to delete the Extension.

Download Logs

You can download a .zip file containing logs for all Extensions that are in use. The logs are helpful when troubleshooting.

To download logs for your Extensions, perform the following steps:

  1. Navigate to Z-Platform > My Extensions.
  2. Click download logs in the top right-hand corner. A .zip file containing the log files is downloaded to your computer.

The following figure shows the structure of the .zip file and the contents of one of the logs.

Download Extension Log Files Example

The .zip file contains two folders, log1 and log2. Each folder contains log files from a single Extension Platform server node. Extensions always run on two server nodes, which is why there are two log folders. Make sure you check both folders when troubleshooting, because the relevant log file could be in either folder.

Each folder contains a maximum of seven of the most recent log files. Contact Zuora Global Support if you require log files earlier than those included in the download. Each log file has a maximum size of approximately 10 MB.

The most recent log file in each folder is always named plugin.log. Earlier log files are named in the following format:

plugin.{date}.{number}.log

Where {date} specifies the date the log file was created, and {number} differentiates log files that were created on the same date.

Last modified
19:05, 27 Jan 2016

Tags

Classifications

(not set)