Contact Us 1-800-596-4880

Using Anypoint Studio to Configure Spiff Connector 1.0

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files.

To add and configure a connector in Studio:

When you run the connector, you can view the app log to check for problems in real time, as described in View the App Log.

If you are new to configuring connectors in Studio, see Using Anypoint Studio to Configure a Connector. If, after reading this topic, you need additional information about the connector fields, see the Spiff Connector Reference.

Create a Mule Project

In Studio, create a new Mule project in which to add and configure Anypoint Connector for Spiff (Spiff 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 Spiff Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s pom.xml file:

  1. In the Mule Palette view, click (X) Search in Exchange.

  2. In the Add Dependencies to Project window, type spiff in the search field.

  3. Click Spiff Connector in Available modules.

  4. Click Add.

  5. Click Finish.

Adding a connector to a Mule project in Studio doesn’t make that connector available to other projects in your Studio workspace.

Configure a Source

A source initiates a flow when a specified condition is met.

You can configure one of these sources to use with Spiff Connector:

  • HTTP > Listener, which initiates a flow each time it receives a request on the configured host and port, for example a source system that posts closed-won deals.

  • Scheduler, which initiates a flow when a time-based condition is met, for example a nightly backfill or an hourly Test Webhook health check.

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 the Display Name field.

  4. Specify a value for the Path field.

  5. Click the plus sign (+) next to the Connector configuration field 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 the 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.

Set Host to 0.0.0.0 and Port to ${http.port} so the app can also run on CloudHub and Runtime Fabric.

Add a Connector Operation to the Flow

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

To add an operation for Spiff Connector:

  1. In the Mule Palette view, select Spiff Connector and then select the operation to add, for example Put Single Record.

  2. Drag the operation onto the Studio canvas, next to the source.

  3. Select Mapping ID from the dropdown after you configure the connection. DataSense then shows the mapping’s translator fields as the input type of the record. DataSense needs a fixed Mapping ID value: if you set Mapping ID with an expression such as #[vars.mappingId], Studio can’t resolve the input metadata.

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 Spiff system.

You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see Anypoint Connector Configuration.

To configure the global element for Spiff Connector:

  1. Select the operation in the Studio canvas.

  2. In the configuration screen for the operation, click the plus sign (+) next to the Connector configuration field to access the global element configuration fields.

  3. On the General tab, in Connection, select HMAC Signed Webhook Connection and enter these values:

    Value Where to find it Notes

    Subdomain

    The host of your Spiff URL, for example us1 in https://us1.spiff.com

    Use us1 for US and eu1 for EU. For Salesforce-hosted or non-production tenants, use the full base URL.

    Connector ID

    Spiff Admin > Connectors (> Synced Objects & Fields > Webhook), or Admin > Settings > Webhook Settings

    The raw integer ID, for example 1164. The base64 ID that some Spiff pages show (for example Q29ubmVjdG9yOjExNjQ=) is rejected.

    Webhook Secret

    Shown once when you create the webhook in Spiff Admin. You can refresh it there.

    The HMAC signing key. Store it as a secure property.

    Company UUID

    Spiff Admin > Settings > Company Settings

    A UUID such as 123e4567-e89b-12d3-a456-426614174000.

    Store the webhook secret as a secure property, for example ${secure::spiff.webhookSecret}. See Secure Configuration Properties.

Configure the Other Connector Fields

After you configure the connection, optionally configure these fields:

  • On the Advanced tab, specify the default response timeout, default headers and query parameters, the connection timeout, and the HTTP client settings. The response timeout and the connection timeout must be at least 1 millisecond.

  • On the Proxy tab, configure a Default or NTLM proxy, for example host proxy.mycompany.com, port 8080, username proxyUser, and non-proxy hosts localhost,*.internal.mycompany.com.

  • On the Security tab, configure a TLS context.

Click Test Connection to confirm that Mule can connect with the specified server, and then click OK.

Test Connection Behavior

Test Connection sends a signed sample record to PUT /_webhook/connector/{Connector ID}/test?company_uuid={Company UUID}. Spiff verifies the signature and doesn’t store the sample record. The Connection Timeout is the response timeout of Test Connection. Test Connection succeeds only if Spiff answers HTTP 200, which means it accepted the signature and recognized both the Connector ID and the Company UUID. Any other status fails, including a 404 for an unknown Connector ID or Company UUID. See Troubleshooting Spiff Connector for more information.

View the App Log

To check for problems, you can view the app log as follows:

  • If you’re running the app from Anypoint Platform, the app log output is visible on the Anypoint Studio console window.

  • If you’re running the app using Mule from the command line, the app log output is visible in your operating system console.

Unless the log file path is customized in the app’s log file (log4j2.xml), you can also view the app log in the default location MULE_HOME/logs/<app-name>.log. You can configure the location of the log path in the app log file log4j2.xml.

To enable DEBUG logging for the connector, see Troubleshooting Spiff Connector.

Next Step

After configuring the connector in Studio, see Spiff Connector Examples for more configuration ideas.