Knowledge Center

Knowledge Center > Integrations and Extensions > Extension Platform > Importing and Managing Your Extension Data

Importing and Managing Your Extension Data

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.

Extension Data allows you to upload data documents to Zuora. The data can then be used by your Extensions. This article explains everything you need to get started with Extension Data. See Extension Platform Introduction to learn more about the Extension Platform feature as a whole.

You can manage Extension Data using the Zuora UI, the REST API, or the interfaces included in the Extension Development Kit (EDK). This article explains how to manage Extension Data only from the Zuora UI. Contact Zuora Global Support for information about the other options.

Prerequisites

Before you can start using Extension Data:

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

Key Concepts

You upload your data via the Zuora UI from an Excel workbook file. The workbook can contain one or more worksheets. After being uploaded to Zuora, the workbook becomes an Extension Data document, and each worksheet becomes a table within that document.

For example, the following workbook contains data for calculating car rental prices. The workbook contains two worksheets, called "Type" and "Location."

EP Data - Two Worksheets

After being uploaded as Extension Data, the workbook becomes a single Extension Data document that you could name, for example, "CarRentalData." The document contains two relational tables called "Type" and "Location". Refer to the View Extension Data Details section below to see what the data looks like after being uploaded.

View Your Extension Data

Navigate to Z-Platform > Extension Data. The page lists all of your existing Extension Data documents in descending order of most recently created.

View a List of All of Your Extension Data Documents

From the Extension Data page, you can:

  • Add Extension Data
  • View Extension Data Details
  • Delete Extension Data

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

Add Extension Data

To add a new Extension Data document, perform the following steps:

  1. Navigate to Z-Platform > Extension Data.
  2. Click add extension data. The following page is displayed.
    Add Extension Data Document
  3. Configure the fields on the New Extension Data page. The following table describes each of the fields.
Field Description

Name

Enter a name for the new Extension Data document. The name does not need to be unique.

Cannot be blank. Maximum of 32 characters.

Primary Key

Enter the primary key for the Extension Data document. Each document must have a unique primary key.

Cannot be blank. Maximum of 32 characters.

Secondary Key

Optionally enter a secondary key for the Extension Data document.

You can only specify a secondary key if you also specify the primary key. The secondary key does not need to be unique.

Maximum of 32 characters.

Description

Optionally enter a description of the document.

Maximum of 500 characters.

Data File

Upload an Excel workbook file containing the Extension Data.

File format can be .xls or .xlsx.

  1. Click save.

View Extension Data Details

You can view any of your Extension Data documents in more detail. The following figure shows an example document that contains two tables.

View Details of an Extension Data Document

From this page, you can:

  • Edit Basic Information
  • Edit Extension Data
  • Re-Import Extension Data
  • Export Extension Data

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

Edit Basic Information

After an Extension Data document has been created, you can edit its Description.

You cannot edit its Name, Primary Key, or Secondary Key. To edit those fields, you should instead create a new Extension Data document with the correct details. See the Add Extension Data section above for more information.

To edit the description of an Extension Data document, perform the following steps:

  1. Navigate to Z-Platform > Extension Data and click View to the right of the document that you want to edit.
  2. Click edit in the Basic Information section.
  3. Make changes to the Description.
  4. Click save.

Edit Extension Data

After an Extension Data document has been created, you can change the values of fields and add or delete rows of data from the Zuora UI.

You cannot change the names of tables, or change, add, or delete columns. To perform any of those actions, you should instead make the changes in the Excel file containing the data and then re-import the file. See Re-Import Extension Data below for details.

To edit Extension Data, perform the following steps:

  1. Navigate to Z-Platform > Extension Data and click View to the right of the document that you want to edit.
  2. Click edit in the Data Preview section.
  3. Make changes to the data. The following figure shows the different actions you can perform.
    Edit Extension Data
  4. Click save.

Re-Import Extension Data

When you re-import Extension Data, the existing data will be overwritten even if it is being referenced by an Extension. Make sure the existing data is not being used before you re-import.

If you want to make extensive changes to an Extension Data document, you can re-import the data from an Excel workbook. For minor changes, you can directly edit the data from the Zuora UI. See the Edit Extension Data section above for details.

To re-import the data from an Excel workbook, perform the following steps:

  1. Navigate to Z-Platform > Extension Data and click View to the right of the document whose data you want to change.
  2. Click re-import.
  3. Upload the new Data File.
  4. Click save.

Export Extension Data

To export an Excel file containing all the data from an Extension Data document, perform the following steps:

  1. Navigate to Z-Platform > Extension Data.
  2. Click View to the right of the document whose data you want to export.
  3. Click export. An Excel file containing the data is downloaded to your computer.

Delete Extension Data

When you delete Extension Data, the data will be permanently deleted even if it is being used by an Extension. Make sure the existing data is not in use before you delete it.

To delete an Extension Data document, perform the following steps:

  1. Navigate to Z-Platform > Extension Data to see a list of your Extension Data documents.
  2. Click Delete in the Actions column to the right of the Extension Data document you want to delete. A dialog box for confirmation is displayed.
  3. Click Yes.
Last modified
23:24, 27 Jan 2016

Tags

Classifications

(not set)