Zuora Connector
Content Type: Module
Categories: Connectors
Overview
Use the Zuora connector to integrate with your Zuora environment(s). for more information about the Zuora API, see: https://www.zuora.com/developer.
Documentation
Description
Use the Zuora connector to integrate with your Zuora environment(s). for more information about the Zuora API, see: https://www.zuora.com/developer.
Typical usage scenario
- Retrieve Zuora data for your app
- Update your Zuora objects with your Mendix Data
- Insert new records into Zuora from your Mendix App
Features and limitations
- Authenticate with Zuora
- Send ZOQL Queries to Zuora
- Perform batch actions on your Zuora data
- perform CRUD actions on your Zuora objects
- Describe your Zuora Data Model
Dependencies
- Encryption module
- CommunityCommons module
- Mendix Studio Pro 9.24.24
- Access to Zuora environment and an API User
Installation
Download the Encryption module and add a value in the EncryptionKey constant.
Download the Nanoflow Commons module.
Download the CommunityCommons module.
Do not modify this module, instead:
- Add the 'Snip_Authentication_Overview' snippet to a page accessible to you.
- Create a new module, e.g. 'Zuora_Interface'.
- Add new pages, copy and reuse snippets and microflows from the _USE_ME folder in this module into the 'Zuora_Interface' module.
- If you want to import objects as Persistent Entities, create new entities in one of your own modules
Configuration
Releases
Version: 3.0.1
Framework Version: 9.24.24
Release Notes: changes
- zObject updated_time and created_time are now date time attributes
- minor improvements to domain model
Version: 3.0.0
Framework Version: 9.24.23
Release Notes: Changes:
- BREAKING CHANGE: Migrated majority of domain model and actions to V2 API. This version of the API has different naming conventions, so some entities and attributes have been renamed. some entities and attributes that are not needed in V2 API have been deleted. Please upgrade with Caution. There are still some actions available in the module that only exist in the V1 API (specifically, SUB_Order_Update and SUB_Subscription_Renew).
- Upgrade to 9.24.23
Version: 2.3.0
Framework Version: 9.24.14
Release Notes: Changes
- Split V1 and V2 API References in app explorer
- Various improvements to domain model
- Added CustomFields_zObject association so that it can be reused more easily for different zObjects with custom fields
- json-20200518.jar.zuoraconnector.RequiredLib is no longer required as of version 2.2.0 and higher, so this can be deleted in the userlib folder. If json-20200518.jar is not used by any other modules, that file can be deleted from the userlib folder as well
Version: 2.2.2
Framework Version: 9.24.14
Release Notes: Removed wrapper entities to simplify domain model
Deleted OrderActions, Subscriptions, CustomField, SubscriptionRatePlan entities.
Renamed OrderActionWrapper entity to Array
Changed return value for SUB_Contact_Create and SUB_Contact_Update to Contact instead of ZuoraResponse
renamed some microflow actions to better reflect the objects involved
Version: 2.1.2
Framework Version: 9.24.12
Release Notes: added additional attributes to Account
Version: 2.1.1
Framework Version: 9.24.12
Release Notes: added additional attributes to Account entity
Version: 2.1.0
Framework Version: 9.24.12
Release Notes: added additional example microflows
Version: 2.0.1
Framework Version: 9.24.1
Release Notes: - added the Zuora SQL Data Query functionality
- upgraded to 9.24.1
Version: 2.0.0
Framework Version: 9.18.4
Release Notes: WARNING: Refactored module and logic. Upgrading can break existing implementation
upgraded to 9.18.4
Version: 1.3.0
Framework Version: 9.6.14
Release Notes: - Added encryption to Authorization Token and removed read access for improved security
- Applied several modelling and notation best practices. Renamed some microflows and other items to be more consistent.
- exposed microflows for easy use