MuleSoft Anypoint

Support Category: Certified

About Gentrack Connector for MuleSoft

Gentrack connector for MuleSoft enables your CRM and other enterprise applications to leverage the power of the Gentrack core utility platform.

Use this connector to synchronise customer data into Gentrack, then drive customer engagement use cases through querying and updating billing, payment, and credit information. The connector allows retrieval of service point technical details and associated devices including utility meters and generation assets.

Common Use Cases

By integrating your CRM with Gentrack can you can expect to offer a superior customer experience through:

• Frictionless customer signup - Accurately qualify and propose suitable products and services to customers, getting it right the first time, based on industry utility data. Synchronising customer data in near real-time, as well as validating and actioning order fulfilment requests, lets market orchestration start quickly and provides accurate data for billing and collections.
• Improve customer enquiry resolution - Reduce the number of customer enquires, and improve agent enquiry resolution time, by presenting complete billing, payments, credit information within other applications like CRM and customer engagement platforms.
• Reduce outstanding debt - Setting up direct debit payment agreements helps customers avoid accidental non-payment. Agents can discuss and setup flexible payment arrangements in the CRM, including offering customers the ability to spread out their payments evenly.

Prerequisites

This document assumes that you are familiar with Mule, Anypoint Connectors and Anypoint Studio.

You must have access to a Gentrack system based on the g2.0 release or later. To use this connector with a previous version please contact your Gentrack customer support team.

Compatibility

Authentication

Gentrack Connector connections use the OAuth 2.0 client credentials authentication method. An application must first be registered in Integration Services which generates a client id and secret. These credentials are used to request a JWT token which is provided to Gentrack APIs on each request.

Configuring Gentrack Connector in Anypoint Studio

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:

Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1. In Studio, select File > New > Mule Project.
2. Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add Gentrack Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and to add the required dependencies to the project’s pom.xml file:

1. In the Mule Palette view, click (X) Search in Exchange.
2. In Add Dependencies to Project, type gentrack in the search field.
3. Click Gentrack Connector in Available modules.
4. Click Add.
5. Click Finish.

Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace.

Configure a Source

Source initiates a flow when a specified condition is met. You can configure a source to use with Gentrack Connector:

• HTTP Listener - Initiates a flow each time it receives a request on the configured host and port

For example, to configure an HTTP listener source, follow these steps:

1. In Mule Palette, select HTTP > Listener.
2. Drag Listener to the Studio canvas.
3. On the Listener configuration screen, optionally change the value of Display Name.
4. Specify a value for the Path field.
5. Click + next to Connector configuration to configure a global element that can be used by all instances of the HTTP Listener source in the app.
6. On the General tab, specify connection information for the connector.
7. On the TLS tab, optionally specify the TLS information for the connector.
8. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
9. Click Test Connection to confirm that Mule can connect with the specified server.
10. Click OK.

Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to perform.

To add an operation for Snowflake Connector, follow these steps:

1. In Mule Palette, select Gentrack Connector and then select the desired operation.
2. Drag the operation onto the Studio canvas to the right of the input source.

Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Gentrack system. Gentrack Connector supports the OAuth 2.0 Client Credentials Connection type to connect to Gentrack.

To configure the global element for Gentrack Connector, follow these steps:

1. Select the operation in the Studio canvas.
2. In the configuration screen for the operation, click + next to the Connector configuration field to access the global element configuration fields.
3. In the General tab for the Base Uri set the name of the Gentrack API endpoint followed by the API version /v1. There will be a default value pre-populated which will need changing as the domain name differs depending on where in the world your Gentrack instance is deployed to. Contact Gentrack if you are still unsure of the deployment region or which Base Uri to use.
4. In oauthClientCredentials enter the following required information to configure authentication:

• Client id - Client identifier that was generated when registering this Mule application with Integration Services.
• Client secret - Client secret that was generated when registering this Mule application with Integration Services.
• Token url - Endpoint that will exchange the client id and secret for a JWT token. There will be a default value pre-populated which may need changing as the domain name differs depending on where in the world your Gentrack instance is deployed to. Contact Gentrack if you are unsure of the deployment region or which Token URL to use.

5. Click OK.