Fuse Online Sample Integration Tutorials
How business users can share data among different applications
Abstract
Preface
Fuse Online lets you obtain data from an application or service, operate on that data if you need to, and then send the data to a completely different application or service. You can do all this without writing code.
Explore Fuse Online by creating the sample integrations. The comparison table can help you decide which sample integration to create first. Then see the instructions for creating the sample integrations.
A user guide for Fuse Online is also available.
To obtain support, in Fuse Online, in the upper right, click and then select Support.
Chapter 1. Choosing the sample integration to create first
You can create the sample integrations in any order. To help you decide which one to try first, the following table compares them.
| |||
What it does | Captures and filters tweets that mention a particular Twitter user. For tweets that contain specified text, the integration passes data related to the tweet to Salesforce and Salesforce creates a new contact. | Captures updates in Salesforce and then calls a database stored procedure to synchronize a particular database table with the Salesforce updates. | Obtains delivery records from a Red Hat AMQ broker, executes a custom step to identify any items that were damaged when they were received, and connects to a REST API to provide contact information for vendors of damaged items. |
What you learn about | Connecting to Twitter and Salesforce, how Fuse Online interfaces with applications that use the OAuth protocol, mapping data fields received from one application to fields that the next connected application in the integration can operate on, filtering data to determine whether to continue integration execution. | Connecting to Salesforce and a SQL database, OAuth support, data mapping, how to update a SQL database as part of an integration. | Connecting to a Red Hat AMQ broker and a REST API, data mapping, uploading extensions for a step and for a REST API client connector, using a custom step and a custom API client connection. |
Average minutes to complete | 25 | 20 | 25 |
Notes about the time | This includes the time needed to obtain Twitter and Salesforce accounts. It does not include 5 - 12 minutes of waiting for Salesforce registration to take effect and for Fuse Online to start running the integration. | 20 minutes includes the time needed to obtain a Salesforce developer account but not the time spent waiting. If you already created the Twitter to Salesforce sample then it takes 10 minutes to create this integration. | This does not include the time it takes for Fuse Online to start running the integration. |
Prerequisites | Twitter developer account, Salesforce developer account | Salesforce developer account | None |
Chapter 2. What to expect when using Fuse Online for the first time
To enable access to Fuse Online on OpenShift Online, Red Hat provides a link. Clicking this link displays the Red Hat OpenShift Online Log In page, which prompts you to log in by using your Red Hat account. Logging in prompts you to authorize access from Fuse Online to your OpenShift Online account:
Click Allow selected permissions. You need to do this only once. The next time you click the Fuse Online access link that is in your "Welcome to the Red Hat Fuse Online Evaluation" email message, Fuse Online immediately appears.
To use Fuse Online on OpenShift Container Platform, follow the installation instructions, which are at the end of Integrating Applications with Fuse Online.
Red Hat supports using Fuse Online in the following browsers:
- Chrome
- Firefox
- Microsoft Edge
Chapter 3. Implementing the Twitter to Salesforce sample integration
This sample integration watches Twitter for tweets that mention a particular Twitter user. When the integration finds such tweets, it filters them so that only those tweets that contain the text that you specify cause the integration to continue.
For tweets that contain the specified text, the integration passes data related to the tweet, including the Twitter user name, to Salesforce and Salesforce creates a new contact.
Prerequisites
-
You need a Twitter developer account. If you do not already have one, go to https://apps.twitter.com, sign in to Twitter, and click Apply for a developer account. Obtaining the developer account is quick when you provide a professional email address, such as
me@redhat.com
rather than a personal address such asyou@gmail.com
. - You need an account in a Salesforce installation that is used for development. This account must have Salesforce API access, which is available in a Salesforce Enterprise account or a Salesforce Developer account. To obtain a free developer account, visit https://developer.salesforce.com/signup. It takes less than two minutes to obtain a Salesforce account.
- You must be logged in to your Fuse Online environment. If you are not already logged in, see What to expect the first time that you use Fuse Online.
To implement, deploy, and test this sample integration, the main steps are:
- Section 3.1, “Registering Fuse Online as a Twitter client application”
- Section 3.2, “Creating a Twitter connection”
- Section 3.3, “Registering Fuse Online as a Salesforce client application”
- Section 3.4, “Creating a Salesforce connection”
- Section 3.5, “Creating and deploying the Twitter to Salesforce sample integration”
- Section 3.6, “Confirming that the Twitter to Salesforce integration works”
- Section 3.7, “Cleaning up your integration”
3.1. Registering Fuse Online as a Twitter client application
In an integration, to connect to Twitter, the first thing you must do is register your Fuse Online environment as a client application that can access Twitter. This lets you create any number of integrations that connect to Twitter. In other words, you need to register a particular Fuse Online environment with Twitter only once.
In each Fuse Online environment, there can be only one registration of Fuse Online as a Twitter client application. However, while each Twitter connection uses the same registration, it can use different user credentials.
Prerequisite
You are logged in to Fuse Online. The URL for accessing Fuse Online is in the email message that welcomed you to the Red Hat Fuse Online Evaluation program.
Procedure
In Fuse Online:
- In the left panel, click Settings.
- On the Settings page, near the top, to the right of the callback URL, click to copy the callback URL for your installation of Fuse Online to the clipboard. You will need this URL later in this procedure.
- To the right of the Twitter entry, click Register to display the Consumer API Key and ConsumerAPI Secret Key fields.
In another browser tab, go to your Twitter developer account, sign in if you need to, and do the following:
- In the upper right, next to the name of your developer project, click the down caret and click Apps.
- In the upper right, click Create an app.
- In the App name field, enter a name such as My Fuse Online Client.
- In the Application description field, enter a tip such as For leveraging tweets.
-
In the Website URL field, paste the URL that you copied at the beginning of this procedure and remove
api/v1/credentials/callback
from the end of the URL. - Select Enable Sign in with Twitter.
-
In the Callback URLs field, paste the URL again. It should be something like this:
https://app-proj912876.7b63.fuse-ignite.openshiftapps.com/api/v1/credentials/callback
. -
A 100-character description of how you plan to use this app is required. For convenience, you can copy and paste:
This is a demo application so that I can evaluate how to integrate Twitter with my enterprise applications.
- Click Create.
- Click Create again to confirm that you reviewed the developer terms.
- At the top of the page for the app you just created, click the Keys and tokens tab.
- Copy the consumer API key.
- Return to your Fuse Online Settings page and paste the Twitter consumer API key into the Fuse Online Twitter Consumer API Key field.
- Return to the Twitter Keys and tokens tab and copy the consumer API secret key.
- Return to your Fuse Online Settings page and paste the Twitter consumer API secret key into the Fuse Online Twitter Consumer API Secret Key field.
- Click Save and then click Ok.
3.2. Creating a Twitter connection
To create an integration that obtains data from Twitter, you must first create a Twitter connection. After you create a Twitter connection, you can use it in any number of integrations.
Prerequisites
- You are logged in to Fuse Online. The URL for accessing Fuse Online is in the email message that welcomed you to the Red Hat Fuse Online Evaluation program.
- Fuse Online is open in a web browser.
- You registered your Fuse Online environment as an application that can access Twitter.
- You added the Twitter consumer API key and consumer API secret key that you received after registration to the Fuse Online Settings page.
Procedure
- In Fuse Online, in the left panel, click Connections to display any available connections.
- In the upper right, click Create Connection to display the available connectors. A connector is a template that you use to create one or more connections.
- Click the Twitter connector.
Click Connect Twitter to display a Twitter authorization page. You might need to log in to Twitter before you see the authorization page.
If Connect Twitter does not appear, then your Fuse Online environment is not registered as a Twitter client application. See Registering with Twitter. When you try to create a Twitter connection and your Fuse Online environment is not registered as a Twitter client application, then Fuse Online displays multiple fields that prompt for authorization information. While you can create a Twitter connection by entering values in these fields, it is not recommended.
- Click Authorize app to return to Fuse Online.
-
In the Connection Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, enter
Twitter Connect 1
. -
In the Description field, optionally enter any information that is helpful to know about this connection. For example, enter
Sample Twitter connection that uses my Twitter login credentials.
- In the upper right, click Create to see that the connection you created is now available. If you entered the example name, you would see that Twitter Connect 1 appears as a connection that you can choose to add to an integration.
3.3. Registering Fuse Online as a Salesforce client application
In an integration, to connect to Salesforce, the first thing you must do is register your Fuse Online environment as a client application that can access Salesforce. This lets you create any number of integrations that connect to Salesforce. In other words, you need to register a particular Fuse Online environment with Salesforce only once.
In each Fuse Online environment, there can be only one registration of Fuse Online as a Salesforce client application. However, while each Salesforce connection uses the same registration, it can use different user credentials.
If you already registered Fuse Online as a Salesforce client and created a Salesforce connection, skip to Creating Twitter to Salesforce integration.
Prerequisite
You are logged in to Fuse Online. The URL for accessing Fuse Online is in the email message that welcomed you to the Red Hat Fuse Online Evaluation program.
Procedure
In Fuse Online:
- In the left panel, click Settings.
- On the Settings page, near the top, to the right of the callback URL, click to copy the callback URL for your Fuse Online environment to the clipboard. You will need this URL toward the end of this procedure.
- To the right of the Salesforce entry, click Register to display the Client ID and Client Secret fields.
In another browser tab, log in to your Salesforce account and follow the steps below to create a connected app. These instructions assume that you are using the Salesforce Classic user interface. To switch from the Salesforce Lightning Experience interface, click your profile icon and select Switch to Salesforce Classic. For additional information, see the Salesforce documentation for Create a Connected App.
- In Salesforce, in the upper right, click Setup.
- In the left panel, select Build > Create > Apps.
- Scroll down to Connected Apps and click New.
- Enter the required information and then select Enable OAuth Settings.
-
In the Callback URL field, paste your Fuse Online URL, which you copied at the beginning of this procedure. For example:
https://app-proj912876.7b63.fuse-ignite.openshiftapps.com/api/v1/credentials/callback
. For OAuth Scopes, add:
- Access and manage your data (api)
- Allow access to your unique identifier (openid)
- Perform requests on your behalf at any time (refresh_token, offline_accesss)
- Select Configure ID token and then Include Standard Claims.
- Scroll down and click Save.
- Scroll up to see that Salesforce indicates a short wait:
- Click Continue.
- Copy the consumer key that Salesforce provides.
- Return to your Fuse Online Settings page and paste the Salesforce-provided consumer key into the Fuse Online Salesforce Client ID field.
- Return to Salesforce and copy the consumer secret that Salesforce provides.
- Return to your Fuse Online Settings page and paste the Salesforce-provided consumer secret into the Fuse Online Salesforce Client Secret field.
- Click Save and then click Ok.
3.4. Creating a Salesforce connection
To create an integration that accesses data in Salesforce, you must first create a Salesforce connection. After you create a Salesforce connection, you can use it in multiple integrations.
Prerequisites
- You are logged in to Fuse Online. The URL for accessing Fuse Online is in the email message that welcomed you to the Red Hat Fuse Online Evaluation program.
- Fuse Online is open in a web browser.
- You must have already registered your Fuse Online environment as an application that can access Salesforce.
You added the Salesforce client ID and client secret that you received after registration to the Fuse Online Settings page.
If you did not already register Fuse Online, see Registering Fuse Online as a Salesforce client application.
Be sure to wait 2 - 10 minutes after registering your Fuse Online installation as a Salesforce client before you try to create a Salesforce connection.
Procedure
- In Fuse Online, in the left panel, click Connections to display available connections.
- In the upper right, click Create Connection to display the available connectors. A connector is a template for creating one or more connections.
- Click the Salesforce connector.
Click Connect Salesforce to display a Salesforce authorization page. You might need to log in to Salesforce before you see the authorization page.
If Connect Salesforce does not appear, then your Fuse Online environment is not registered as a Salesforce client application. See Registering Fuse Online as a Salesforce client application. When you try to create a Salesforce connection and your Fuse Online environment is not registered as a Salesforce client application, then Fuse Online displays multiple fields that prompt for authorization information. While you can create a Salesforce connection by entering values in these fields, it is not recommended.
NoteThe following error indicates that Salesforce does not have the correct Fuse Online callback URL:
error=redirect_uri_mismatch&error_description=redirect_uri%20must%20match%20configuration
If you get this error message, then in Salesforce, ensure that the Fuse Online callback URL is specified according to the instructions in Registering Fuse Online as a Salesforce client application.
- Click Allow to return to Fuse Online.
-
In the Connection Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, enter
SF Connect 1
. -
In the Description field, optionally enter any information that is helpful to know about this connection. For example, enter
Sample Salesforce connection that uses my Salesforce login credentials.
- In the upper right, click Create to see that the connection you created is now available. If you entered the example name, you would see that SF Connect 1 appears as a connection that you can choose to add to an integration.
3.5. Creating and deploying the Twitter to Salesforce sample integration
To create and deploy an integration that uses the Twitter and Salesforce connections that you created, the main steps are:
Prerequisites
- You registered your Fuse Online environment as a Twitter client and created a Fuse Online Twitter connection.
- You registered your Fuse Online environment as a Salesforce client and created a Fuse Online Salesforce connection.
- Fuse Online is open and you are logged in.
3.5.1. Choosing the start connection
In Fuse Online, to create the sample Twitter to Salesforce integration, the first task is to choose the start connection.
Prerequisites
- You created a Twitter connection.
Procedure
- On the left, click Integrations.
- In the upper right, click Create Integration.
- On the Choose a Start Connection page, click the Twitter connection that you created. If you gave it the example name, you would click Twitter Connect 1. When the integration starts, it uses the credentials defined in this connection to connect to Twitter.
- On the Choose an Action page, click Mention.
Next step
When the integration is running, after connecting to Twitter, the integration monitors Twitter for mentions that include your Twitter screen name. A match triggers the next step in the integration. However, before you add steps that operate on data between connections, you choose the connection that the integration uses to finish its work.
3.5.2. Choosing the finish connection
In Fuse Online, to continue creating the Twitter to Salesforce sample integration, after you add the start connection, you add the finish connection to the integration.
Prerequisites
- You added the Twitter connection to the integration as the start connection.
- Fuse Online is prompting you to add the finish connection.
- You created a Salesforce connection.
Procedure
- On the Choose a Finish Connection page, click the Salesforce connection that you created. If you gave it the example name, you would click SF Connect 1. This integration finishes by using the credentials defined in this connection to connect to Salesforce.
- On the Choose an Action page, click New record.
- On the New record page, click in the Object name field and select Contact as the Salesforce record to create.
- Click Next to add the finish connection to the integration.
3.5.3. Adding a basic filter step
In Fuse Online, to continue creating the Twitter to Salesforce sample integration, add a basic filter step that checks tweets that mention you for particular content. At integration execution time, processing continues only if that content is present.
Prerequisites
- You added the Twitter connection as the integration’s start connection.
- You just added the Salesforce connection as the integration’s finish connection.
Procedure
- In the visualization panel on the left, click the plus sign, which displays the steps that you can add to the integration.
- Click Basic Filter.
-
In the first field (The data you want to evaluate), start to enter
text
and whentext
appears below the field, click it. This indicates that the content to filter for is in the Twittertext
field, which contains the text of the tweet. - Accept contains as the condition to be met for the integration to continue.
-
In the last field, enter
#RedHatIsGreat
or some other text that you choose for the value to check for. A tweet that mentions you must contain the text you enter here for the integration to continue operating on this data. - Click Done to complete the basic filter step.
3.5.4. Adding a data mapping step
To continue creating the Twitter to Salesforce sample integration, add a data mapping step that correlates Twitter mention fields to Salesforce contact fields.
Prerequisites
- The integration’s start connection is to Twitter.
- The integration’s finish connection is to Salesforce.
- You just added the filter step between the two connections.
Procedure
- In Fuse Online, in the visualization panel on the left, click the plus sign that is between the filter step and the finish connection.
- On the Choose a Step page, click Data Mapper and wait a few moments. When the data fields appear, the Sources panel on the left displays the Twitter fields and the Target panel on the right displays the Salesforce fields.
Map the Twitter
name
field to the SalesforceFirstName
andLastName
fields:-
In the Sources panel, click the magnifying glass
to display the search field and enter
name
. -
Under the
user
folder, click thename
field. - In the Target panel, scroll down and click FirstName. The data mapper displays a line from the source name field to the target FirstName field.
In the Target panel, scroll down, hover over LastName, press CTRL-Mouse1 (CMD-Mouse1 on MacOS) and select LastName. The data mapper displays another line from the Twitter name field, but this time it goes to the Salesforce LastName field. The blue lines indicate the current focus.
In the Mapping Details panel, you can see that the data mapper automatically changed the action from Map to Separate.
NoteIf you accidentally map the wrong fields then delete the incorrect mapping by selecting one of its fields to make it the current mapping. Then click the trash can icon in the top right of the data mapper.
-
In the Sources panel, click the magnifying glass
to display the search field and enter
Map the Twitter
screenName
field to the SalesforceTitle
field:- In the Sources panel, click the screenName field.
-
On the right, at the top of the Target panel, click the magnifying glass
to display the search field and enter
Title
. - Click the Title field. The data mapper displays a line from the Twitter screenName field to the Salesforce Title field.
Map the Twitter
text
field to the SalesforceDescription
field:-
In the Sources search field, enter
text
and click the text field. Be sure to click the toplevel text field. Do not click one of the text fields that is contained in the user field. -
In the Target search field, enter
description
. - Click the Salesforce Description field to create the mapping.
-
In the Sources search field, enter
- In the upper right, click the grid icon to display the list of mappings, which should look like this:
- In the upper right, click Done.
3.5.5. Giving the integration a name and deploying it
When the Twitter to Salesforce sample integration is complete then you can deploy it and see how it works.
Prerequisites
- The integration’s start connection is Twitter.
- The integration’s finish connection is Salesforce.
- The integration has a filter step.
- You just added a data mapping step to the integration.
Procedure
- In the upper right corner, click Publish.
-
In the Integration Name field, enter a name of your choice that distinguishes this integration from any other integrations. For example:
Twitter to Salesforce Sample Integration
. - In the Description field, optionally enter some information about the integration.
In the upper right corner, click Publish.
Fuse Online starts to deploy the integration and then displays the list of integrations in this environment. In the entry for your Twitter to Salesforce integration, you can see a progress indicator that shows the publishing stages. Fuse Online is generating the runtime for the integration and will start it when the runtime is ready. This takes a few minutes.
A Fuse Online account is limited to a specific number of integrations that can be running at one time. For details, see the pricing plan. If you are already running the maximum number of integrations, then you must stop an integration before you can start running another one.
If you are using a Fuse Online evaluation account, then only one integration at a time can be running. If you already created one of the other sample integrations and that integration is running then this integration is automatically in the Stopped state. You must stop the running integration and then you can then publish this integration.
If you are already running the maximum number of integrations, follow these steps to stop an integration:
- In the left panel, click Integrations.
- In the entry for the integration that you want to stop, click on the far right.
- In the popup, click Stop.
After stopping an integration, start another integration as follows:
- In the left panel, click Integrations.
- In the entry for the integration that you want to start, click on the far right.
- In the popup, click Publish.
3.6. Confirming that the Twitter to Salesforce integration works
To confirm that the Twitter to Salesforce sample integration is working, create some tweets and check for results in Salesforce.
Prerequisites
- In Fuse Online, Running appears next to the name that you specified for the Twitter to Salesforce sample integration when you published it.
- You can access your Twitter and Salesforce accounts.
Procedure
- In Fuse Online in the panel on the left, click Integrations to see that the integration you created is a Running integration. If you entered the example name, you would see that Twitter to Salesforce Sample Integration is running.
Confirm that the integration does not create a contact record when a tweet does not contain the text you specified in the basic filter step:
In Twitter, send a tweet that:
- Mentions your Twitter handle
Does not contain the text that you specified in the basic filter step
For example:
@Aslan #likesRedHat.
- Wait for the polling interval to elapse, which can be 30 - 60 seconds.
- In Salesforce, confirm that there is not a new contact record for the name that is associated with the Twitter account that you used to tweet.
Confirm that the integration creates a new contact record when it should:
In Twitter, send a tweet that:
- Mentions your Twitter handle
Contains the text that you specified in the basic filter step
For example:
@Aslan knows #RedHatIsGreat.
- Wait for the polling interval to elapse.
In Salesforce, do the following:
- Log in to your regular Salesforce account, not your Salesforce developer account.
- On your home page, under Recent Items you should see your new contact.
Click on it to view the details.
The new contact record should have the name that is associated with the Twitter account that you used to tweet. The text of your tweet should be in the Description field, and your Twitter screen name should be in the Title field.
Optionally, view the integration log to troubleshoot an unexpected result or to learn more about integration execution:
- In Fuse Online, in the left panel, click Integrations.
- Click the entry for your Twitter to Salesforce integration.
- In the integration’s summary page, click the Activity tab.
- Click the integration execution for which you want to view activity information.
3.7. Cleaning up your integration
When you are done working with a sample integration, you should stop it and delete it so that you can use the resources for another integration.
Prerequisites
- You are finished working with a sample integration that you published.
Procedure
- In Fuse Online, in the left panel, click Integrations.
- In the main panel, identify the entry for the sample integration that you want to stop.
- In that entry, to the right, click and then click Stop.
- Click Stop to confirm that you want to stop running the integration.
- In the entry for the integration that you just stopped, to the right, click and then click Delete.
- Click Delete to confirm that you want to delete the integration.
Chapter 4. Implementing the Salesforce to database sample integration
This sample integration captures updates in Salesforce and then calls a database stored procedure, which synchronizes that database with the Salesforce updates.
Prerequisites
You need an account in a Salesforce installation that is used for development. This account must have Salesforce API access, which is available in a Salesforce Enterprise account or a Salesforce Developer account. To obtain a free developer account, visit https://developer.salesforce.com/signup. It takes less than two minutes to obtain a Salesforce account.
If you already created the Twitter to Salesforce sample integration:
- Fuse Online is already registered as a Salesforce client. You do not need to do this again.
- You already have a Salesforce connection, which you can reuse in this sample integration.
If you did not already create the Twitter to Salesforce sample integration, then you must register Fuse Online as a Salesforce client and create a Salesforce connection in order to complete the Salesforce to database sample integration.
- You must be logged in to your Fuse Online environment. If you are not already logged in, see What to expect the first time that you use Fuse Online.
To implement, deploy, and test this sample integration, the main steps are:
- Section 4.1, “Registering Fuse Online as a Salesforce client application”
- Section 4.2, “Creating a Salesforce connection”
- Section 4.3, “Creating and deploying the Salesforce to database sample integration”
- Section 4.4, “Confirming that the Salesforce to database integration works”
- Section 4.5, “Cleaning up your integration”
4.1. Registering Fuse Online as a Salesforce client application
In an integration, to connect to Salesforce, the first thing you must do is register your Fuse Online environment as a client application that can access Salesforce. This lets you create any number of integrations that connect to Salesforce. In other words, you need to register a particular Fuse Online environment with Salesforce only once.
In each Fuse Online environment, there can be only one registration of Fuse Online as a Salesforce client application. However, while each Salesforce connection uses the same registration, it can use different user credentials.
If you already registered Fuse Online as a Salesforce client and created a Salesforce connection, skip to Creating Salesforce to database integration.
Prerequisite
You are logged in to Fuse Online. The URL for accessing Fuse Online is in the email message that welcomed you to the Red Hat Fuse Online Evaluation program.
Procedure
In Fuse Online:
- In the left panel, click Settings.
- On the Settings page, near the top, to the right of the callback URL, click to copy the callback URL for your Fuse Online environment to the clipboard. You will need this URL toward the end of this procedure.
- To the right of the Salesforce entry, click Register to display the Client ID and Client Secret fields.
In another browser tab, log in to your Salesforce account and follow the steps below to create a connected app. These instructions assume that you are using the Salesforce Classic user interface. To switch from the Salesforce Lightning Experience interface, click your profile icon and select Switch to Salesforce Classic. For additional information, see the Salesforce documentation for Create a Connected App.
- In Salesforce, in the upper right, click Setup.
- In the left panel, select Build > Create > Apps.
- Scroll down to Connected Apps and click New.
- Enter the required information and then select Enable OAuth Settings.
-
In the Callback URL field, paste your Fuse Online URL, which you copied at the beginning of this procedure. For example:
https://app-proj912876.7b63.fuse-ignite.openshiftapps.com/api/v1/credentials/callback
. For OAuth Scopes, add:
- Access and manage your data (api)
- Allow access to your unique identifier (openid)
- Perform requests on your behalf at any time (refresh_token, offline_accesss)
- Select Configure ID token and then Include Standard Claims.
- Scroll down and click Save.
- Scroll up to see that Salesforce indicates a short wait:
- Click Continue.
- Copy the consumer key that Salesforce provides.
- Return to your Fuse Online Settings page and paste the Salesforce-provided consumer key into the Fuse Online Salesforce Client ID field.
- Return to Salesforce and copy the consumer secret that Salesforce provides.
- Return to your Fuse Online Settings page and paste the Salesforce-provided consumer secret into the Fuse Online Salesforce Client Secret field.
- Click Save and then click Ok.
4.2. Creating a Salesforce connection
To create an integration that accesses data in Salesforce, you must first create a Salesforce connection. After you create a Salesforce connection, you can use it in multiple integrations.
Prerequisites
- You are logged in to Fuse Online. The URL for accessing Fuse Online is in the email message that welcomed you to the Red Hat Fuse Online Evaluation program.
- Fuse Online is open in a web browser.
- You must have already registered your Fuse Online environment as an application that can access Salesforce.
You added the Salesforce client ID and client secret that you received after registration to the Fuse Online Settings page.
If you did not already register Fuse Online, see Registering Fuse Online as a Salesforce client application.
Be sure to wait 2 - 10 minutes after registering your Fuse Online installation as a Salesforce client before you try to create a Salesforce connection.
Procedure
- In Fuse Online, in the left panel, click Connections to display available connections.
- In the upper right, click Create Connection to display the available connectors. A connector is a template for creating one or more connections.
- Click the Salesforce connector.
Click Connect Salesforce to display a Salesforce authorization page. You might need to log in to Salesforce before you see the authorization page.
If Connect Salesforce does not appear, then your Fuse Online environment is not registered as a Salesforce client application. See Registering Fuse Online as a Salesforce client application. When you try to create a Salesforce connection and your Fuse Online environment is not registered as a Salesforce client application, then Fuse Online displays multiple fields that prompt for authorization information. While you can create a Salesforce connection by entering values in these fields, it is not recommended.
NoteThe following error indicates that Salesforce does not have the correct Fuse Online callback URL:
error=redirect_uri_mismatch&error_description=redirect_uri%20must%20match%20configuration
If you get this error message, then in Salesforce, ensure that the Fuse Online callback URL is specified according to the instructions in Registering Fuse Online as a Salesforce client application.
- Click Allow to return to Fuse Online.
-
In the Connection Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, enter
SF Connect 1
. -
In the Description field, optionally enter any information that is helpful to know about this connection. For example, enter
Sample Salesforce connection that uses my Salesforce login credentials.
- In the upper right, click Create to see that the connection you created is now available. If you entered the example name, you would see that SF Connect 1 appears as a connection that you can choose to add to an integration.
4.3. Creating and deploying the Salesforce to database sample integration
To create and deploy an integration that uses the Salesforce connection that you created and the database connection that is provided with Fuse Online, the main steps are:
Prerequisites
- You registered your Fuse Online environment as a Salesforce client.
- You created a Fuse Online Salesforce connection.
- Fuse Online is open and you are logged in.
4.3.1. Choosing the start connection
In Fuse Online, to create the sample Salesforce to database integration, the first task is to choose the start connection.
Prerequisites
- You created a Salesforce connection.
Procedure
- In Fuse Online, on the left, click Integrations.
- Click Create Integration.
- On the Choose a Start Connection page, click your Salesforce connection. If you specified the example name, you would click SF Connect 1.
- On the Choose an Action page, click On create.
- In the Object name field, select Lead.
- Click Next to add the start connection to the integration.
Next step
When the integration is running, after connecting to Salesforce, the integration watches for notifications that a Salesforce Lead record was created. When the integration finds such a notification, it passes the new lead’s data to the next step in the integration. However, before you can add the next step, you must choose the integration’s finish connection.
4.3.2. Choosing the finish connection
In Fuse Online, to continue creating the Salesforce to database sample integration, after you add the start connection, you add the finish connection to the integration.
Prerequisites
- You added the Salesforce connection to the integration as the start connection.
- Fuse Online is prompting you to add the finish connection.
Procedure
- In Fuse Online, on the Choose a Finish Connection page, click the PostgresDB connection. This integration finishes by using the credentials defined in this database connection to connect to the provided sample database.
- On the Choose an Action page, click Invoke stored procedure, which passes data to a stored procedure.
- In the Procedure Name field, accept add_lead, which is the provided stored procedure to run in the sample database. The selected procedure determines the requirements for additional steps in the integration, for example, which Salesforce data fields need to be mapped to which database fields.
- Click Next to add the finish connection to the integration.
4.3.3. Adding a data mapping step
To continue creating the Salesforce to database sample integration, add a data mapping step that correlates Salesforce lead fields to fields in the sample database.
Prerequisites
- The integration’s start connection is to Salesforce.
- The integration’s finish connection is to the PostgresDB sample database.
Procedure
- In Fuse Online, in the visualization panel on the left, click the plus sign.
- On the Choose a Step page, click Data Mapper and wait a few moments. When the data fields appear, the Sources panel on the left displays the Salesforce fields and the Target panel on the right displays the database fields.
Map the Salesforce
Company
field to the databasecompany
field:- On the left, in the Sources panel, click Company.
- On the right, in the Target panel, click company. The data mapper displays a line from the source field to the target field.
-
Map the Sources (Salesforce)
Email
field to the Target (database)email
field. Map two Salesforce fields (
FirstName
andLastName
) to the databasefirst_and_last_name
field:- In the Target panel, click first_and_last_name.
- In the Sources panel, click FirstName.
In the Sources panel, hover over LastName and press CTRL-Mouse1 (CMD-Mouse1 on MacOS).
The data mapper automatically changes the field action from Map to Combine.
When you are done you should see a line from each of the source fields to the target field.
Add the following mappings:
Map This Salesforce Field To This Database Field LeadSource
lead_source
Status
lead_status
Phone
phone
Rating
rating
- In the upper right, click Done.
4.3.4. Giving the integration a name and deploying it
When the Salesforce to database sample integration is complete then you can deploy it and see how it works.
Prerequisites
- The integration’s start connection is Salesforce.
- The integration’s finish connection is to the sample database that is provided with Fuse Online.
- You just added a data mapping step to the integration.
Procedure
- In Fuse Online, in the upper right, click Publish to give it a name.
-
In the Integration Name field, enter a name for the integration. For example,
Salesforce to Database Sample Integration
. In the upper right corner, click Publish.
Fuse Online starts to deploy the integration and then displays the list of integrations in this environment. The entry for your Salesforce to database integration displays a progress indicator that shows the publishing stages. Fuse Online is generating the runtime for the integration and will start it when the runtime is ready. This takes a few minutes.
A Fuse Online account is limited to a specific number of integrations that can be running at one time. For details, see the pricing plan. If you are already running the maximum number of integrations, then you must stop an integration before you can start running another one.
If you are using a Fuse Online evaluation account, then only one integration at a time can be running. If you already created one of the other sample integrations and that integration is running then this integration is automatically in the Stopped state. You must stop the running integration and then you can then publish this integration.
If you are already running the maximum number of integrations, follow these steps to stop an integration:
- In the left panel, click Integrations.
- In the entry for the integration that you want to stop, click on the far right.
- In the popup, click Stop.
After stopping an integration, start another integration as follows:
- In the left panel, click Integrations.
- In the entry for the integration that you want to start, click on the far right.
- In the popup, click Publish.
4.4. Confirming that the Salesforce to database integration works
To confirm that the Salesforce to database integration is working, create a new lead in Salesforce and then open the web app that Fuse Online provides for viewing updates to the sample database.
Prerequisites
- In Fuse Online, Running appears next to the name that you specified for the Salesforce to database sample integration when you published it.
- You can access your Salesforce account.
Procedure
- In the left panel, click Integrations.
- If necessary, wait until your sample integration is a Running integration. If you used the example name, you would see that Salesforce to Database Sample Integration is Running.
- In your Salesforce installation, create a new lead. Be sure to enter data in the fields that you mapped: Company, Email, FirstName, LastName, LeadSource, Status, Phone, and Rating.
In a new browser window, insert
todo-
in front of the URL for your Fuse Online environment. For example:https://todo-app-proj761432.6a63.fuse-ignite.openshiftapps.com/
.Your Fuse Online environment provides the To Do app, which has a REST API for accessing a database that contains tasks. In the AMQ to REST API sample integration tutorial, there are instructions for uploading an OpenAPI (Swagger) document for the To Do app to create an API client connector.
- In the To Do App display, you should see a notification that a new lead was created in the database.
Optionally, view the integration log to troubleshoot an unexpected result or to learn more about integration execution:
- In Fuse Online, in the left panel, click Integrations.
- Click the entry for your Salesforce to database integration.
- In the integration’s summary page, click the Activity tab.
- Click the integration execution for which you want to view activity information.
4.5. Cleaning up your integration
When you are done working with a sample integration, you should stop it and delete it so that you can use the resources for another integration.
Prerequisites
- You are finished working with a sample integration that you published.
Procedure
- In Fuse Online, in the left panel, click Integrations.
- In the main panel, identify the entry for the sample integration that you want to stop.
- In that entry, to the right, click and then click Stop.
- Click Stop to confirm that you want to stop running the integration.
- In the entry for the integration that you just stopped, to the right, click and then click Delete.
- Click Delete to confirm that you want to delete the integration.
Chapter 5. Implementing the AMQ to REST API sample integration
This sample integration connects to a Red Hat AMQ broker to obtain item delivery records for a hypothetical enterprise. The integration then executes a custom step that operates on the records to identify any items that were damaged when they were received. After a simple data mapping, the integration connects to a REST API to obtain contact information for vendors of damaged items.
The other sample integrations use connectors and data operations that are built into Fuse Online. This integration also does that, but in addition, it provides instructions for customizing and extending Fuse Online by leading you through the procedures for:
- Adding a custom data operation by uploading an extension.
- Adding a custom REST API client connector by uploading an OpenAPI (Swagger) document.
Fuse Online provides the extension file and the OpenAPI document.
Prerequisite
- You must be logged in to Fuse Online. If you are not already logged in, see What to expect the first time that you use Fuse Online.
To implement the AMQ to REST API sample integration, the main steps are:
- Section 5.1, “Creating an AMQ connection”
- Section 5.2, “Making a custom step available”
- Section 5.3, “Creating a REST API connector”
- Section 5.4, “Uploading the To Do app icon”
- Section 5.5, “Creating a REST API connection”
- Section 5.6, “Creating and deploying the AMQ to REST API sample integration”
- Section 5.7, “Confirming that the AMQ to REST API integration works”
- Section 5.8, “Cleaning up your integration”
5.1. Creating an AMQ connection
The AMQ to REST API sample integration starts by connecting to an AMQ broker (Red Hat AMQ) that is provided in your OpenShift Online project. Before you start to create the integration itself, you must start the broker and create a connection to that broker.
Procedure
Start the broker:
- In a browser, go to the OpenShift Online Web Console. Your Fuse Online environment runs on OpenShift Online.
In the console, on the right, under My Projects, click Fuse Online to display the project’s overview.
Your project’s name is something like
proj123456
.- In the overview, click the > to the left of the first entry, broker-amq, #1, to expand the entry for the provided Red Hat AMQ broker.
- On the right, click the up caret to scale up to running 1 pod. This starts the AMQ broker.
Create the AMQ connection:
- In Fuse Online, in the left panel, click Connections to display any available connections.
- In the upper right, click Create Connection to display Fuse Online connectors.
- Click the Red Hat AMQ connector.
Configure the connection by entering:
-
In the Broker URL field, enter
tcp://broker-amq-tcp:61616
as the location to obtain data from. -
In the Username field, enter
amq
as the user name for the account that accesses this AMQ broker. -
In the Password field, enter
topSecret
as the password for the account that accesses this AMQ broker. - Leave the other fields blank.
-
In the Broker URL field, enter
- Click Validate. Fuse Online immediately tries to validate the connection and displays a message that indicates whether validation is successful. If validation fails, check the values you entered and try again.
- When validation is successful, in the upper right, click Next.
-
In the Connection Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, enter
Red Hat AMQ Broker 1
. -
In the Description field, optionally enter any information that is helpful to know about this connection. For example, enter
Connection to the provided Red Hat AMQ message broker.
- In the upper right, click Create to see that the connection you created is now available. If you entered the example name, you would see that Red Hat AMQ Broker 1 is now available.
5.2. Making a custom step available
Fuse Online provides a number of steps that operate on integration data between connections. If Fuse Online does not provide a between-connections step that meets your need, a developer can code an extension that defines one or more custom steps that operate on data between connections. The developer gives you a .jar
file that contains the extension. You then upload the extension in Fuse Online to make the custom step(s) available for use in integrations.
The AMQ to REST API sample integration uses a custom step that operates on data between connections to identify items that were damaged when they were received.
Procedure
- In a new browser tab, go to https://github.com/syndesisio/fuse-online-sample-extension/releases.
-
Download the extension’s
.jar
file. - In Fuse Online, in the left panel, click Customizations.
- At the top, click Extensions.
- Click Import Extension.
-
Click Choose File and select the downloaded
.jar
file that contains the extension. Fuse Online validates the file, extracts and displays the extension’s ID, name, description, and type, and lists Damage Reporter as the custom step that the extension defines. - Click Import Extension. Fuse Online makes the custom step available and displays the list of extensions that have been imported.
Additional resources
For information about coding an extension and creating its .jar
file, see:
5.3. Creating a REST API connector
Fuse Online can create connectors for REST APIs that support Hypertext Transfer Protocol (HTTP)/1.0 or HTTP/1.1. To do this, Fuse Online requires a valid OpenAPI 2.0 document that describes a REST API that you want to connect to.
Your Fuse Online environment provides the To Do app, which has a REST API for accessing a database that contains tasks. Your environment also provides an OpenAPI (Swagger) document for this API.
Procedure
Identify the URL for your Fuse Online environment’s copy of the OpenAPI document:
- In the Fuse Online navigation panel, click Home.
- Copy the URL into a text editor.
-
At the beginning of the URL, insert
todo-
. -
At the end of the URL, remove
dashboard
if it is present. -
At the end of the URL, add
swagger.json
. Use the
http
scheme instead ofhttps
.The result is something like this:
http://todo-app-proj217402.6a63.fuse-ignite.openshiftapps.com/swagger.json
NoteSpecification of
http
rather thanhttps
avoids a runtime error if TLS certificates are not valid. In production environments, ensure that valid certificates are in place, and always specify secure URLs (https
) to obtain an OpenAPI document.- In the Fuse Online navigation panel, click Customizations.
- Click Create API Connector.
- Select Use a URL.
- In the input box, paste the URL for your OpenAPI document and click Next.
- On the Review Actions page, click Next. If you see a warning, you can ignore it.
- Click Next again to accept HTTP Basic Authorization.
On the Review/Edit Connector Details page, Fuse Online populates the fields with values from the OpenAPI document.
- If you want to, you can change the values in the Connector Name and Description fields.
-
Confirm that the value in the Host field is correct. For example, it should be something like this:
https://todo-app-proj217402.6a63.fuse-ignite.openshiftapps.com
. -
Confirm that the value in the Base URL field is
/api
.
Click Create API Connector.
Fuse Online displays the API Client Connectors tab with an entry for the Todo App API that you just created.
5.4. Uploading the To Do app icon
To show the flow of an integration, Fuse Online displays icons that identify the applications that the integration is connecting to. Your Fuse Online environment provides an icon for the To Do app. Follow these instructions to upload it.
Procedure
Display the To Do app icon:
- In a new browser tab, paste the URL for your OpenAPI document.
-
At the end of the URL, replace
swagger.json
withimages/todo_icon.png
and click Enter to display the icon. For example:https://todo-app-proj217402.6a63.fuse-ignite.openshiftapps.com/images/todo_icon.png
.
-
Save the
todo_icon.png
image. - In Fuse Online, in the API Client Connectors tab, click the entry for the Todo App API to display its details.
- On the Connector Details page, below the Base URL field, click Edit.
- Next to the default connector icon, click Choose File.
-
Navigate to
todo_icon.png
, select it, and click Open. The icon appears near the top of the connector details page. - Below the Base URL field, click Save.
5.5. Creating a REST API connection
In an integration, before you can connect to a REST API, you create a REST API client connector and then use that connector to create a connection. You already created a REST API connector for the To Do app. Follow the instructions here to use that connector to create a connection to the To Do app REST API.
Prerequisite
- You created the Todo App REST API connector.
Procedure
- In Fuse Online, in the left panel, click Connections to display any available connections.
- In the upper right, click Create Connection to display available connectors.
- Click the Todo App API connector that you just created.
- In the Todo App API Configuration, notice that Fuse Online populates the Authentication Type, Base Path, and Host fields from the connector information.
- In the Username field, enter any value. For this sample integration, user name and password values are required but they are not used.
- In the Password field, enter any value.
- Click Next.
-
In the Connection Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, enter
Todo App API Client
. -
In the Description field, optionally enter any information that is helpful to know about this connection. For example, enter
Connection to the provided Todo app REST API.
- In the upper right, click Create to see that the connection you created is now available.
5.6. Creating and deploying the AMQ to REST API sample integration
To create and deploy the AMQ to REST API sample integration, the main steps are:
Prerequisites
- You created a connection to the provided Red Hat AMQ broker.
- You created an API Client connection to the provided Todo app.
- You uploaded the extension that provides the Damage Reporter step.
5.6.1. Choosing the start connection
In Fuse Online, to create the sample AMQ to REST API sample integration, the first task is to choose the start connection.
Prerequisites
- You started the provided Red Hat AMQ broker.
- You created a connection to that message broker.
Procedure
- In Fuse Online, on the left, click Integrations.
- Click Create Integration.
- On the Choose a Start Connection page, click your AMQ connection. If you specified the example name, you would click Red Hat AMQ Broker 1.
- On the Choose an Action page, click the Subscribe for messages action to receive messages from the queue you specify.
-
In the Destination Name field, enter
inventoryReceived
for the name of the queue to obtain data from. - Click in the Destination Type field and select Queue.
- Leave the other fields blank.
- Click Next. Fuse Online prompts you to specify the output data type. This is not needed for this sample integration.
- Click Done to add the start connection to the integration.
Next step
When the integration is running, after connecting to Red Hat AMQ, the integration watches for messages on the inventoryReceived
queue. When a message is available, the integration passes it to the Damage Reporter step. However, before you can add that step to the integration, you must choose the integration’s finish connection.
5.6.2. Choosing the finish connection
In Fuse Online, to continue creating the AMQ to REST API sample integration, after you add the start connection, you add the finish connection to the integration.
Prerequisites
- You uploaded the provided OpenAPI document to create the Todo App API connector.
- You used the Todo App API connector to create a Todo App API connection.
Procedure
- In Fuse Online, on the Choose a Finish Connection page, click the To Do app connection that you created. If you assigned the example name, you would click Todo App API Client.
- On the Choose an Action page, click Create new task, which provides information about who to contact to address a particular damaged item.
5.6.3. Adding a damage reporter step
With the start and finish connections in place, you are ready to add the custom step that receives the messages from the Red Hat AMQ broker and identifies any items that were damaged when they were received.
Prerequisite
- You uploaded the extension that provides the Damage Reporter custom step.
- You added the start and finish connections to the integration.
Procedure
- In Fuse Online, in the visualization panel on the left, click the plus sign.
- On the Choose a Step page, click Damage Reporter.
5.6.4. Adding a data mapping step
To continue creating the AMQ to REST API sample integration, you need to add a data mapping step. This step correlates the task
field in the output from the damage reporter step to the task
field in the database that the REST API accesses.
Prerequisite
- You added the Damage Reporter step to the integration.
Procedure
- In Fuse Online, in the visualization panel on the left panel, click the plus sign that is between the Damage Reporter step and the finish connection.
- On the Choose a Step page, click Data Mapper. In the data mapper, the Source panel on the left displays the fields in the output from the damage reporter step. The Target panel on the right displays the fields in the database that the API accesses.
-
In the Source panel, click the
task
field. -
In the Target panel, expand the
body
field and clicktask
. - In the upper right, click Done.
Result
The integration is complete and it is ready to be published. On the left, in the integration visualization panel, you might see a Data Type Mismatch warning icon. You can ignore it.
5.6.5. Giving the integration a name and deploying it
The AMQ to REST API sample integration is complete when it has a Red Hat AMQ start connection, a Damage Reporter step, a data mapper step, and it finishes with a Todo App Client API connection. Follow the instructions here to deploy it.
Prerequisites
- You added the start and finish connections to the integration.
- You added a Damager Reporter step between the start and finish connections.
- You added a data mapper step between the Damage Reporter step and the connection to the Todo App API.
Procedure
- In Fuse Online, in the upper right, click Publish.
-
In the Integration Name field, enter a name for the integration. For example,
AMQ to REST API Sample Integration
. - Optionally, in the Description field, enter information that might be helpful to know about this integration.
In the upper right corner, click Publish.
Fuse Online starts to deploy the integration and then displays the list of integrations in this environment. In the entry for your AMQ to REST API integration, you can see a progress indicator that shows the publishing stages. Fuse Online is generating the runtime for the integration and will start it when the runtime is ready. This takes a few minutes.
A Fuse Online account is limited to a specific number of integrations that can be running at one time. For details, see the pricing plan. If you are already running the maximum number of integrations, then you must stop an integration before you can start running another one.
If you are using a Fuse Online evaluation account, then only one integration at a time can be running. If you already created one of the other sample integrations and that integration is running then this integration is automatically in the Stopped state. You must stop the running integration and then you can then publish this integration.
If you are already running the maximum number of integrations, follow these steps to stop an integration:
- In the left panel, click Integrations.
- In the entry for the integration that you want to stop, click on the far right.
- In the popup, click Stop.
After stopping an integration, start another integration as follows:
- In the left panel, click Integrations.
- In the entry for the integration that you want to start, click on the far right.
- In the popup, click Publish.
5.7. Confirming that the AMQ to REST API integration works
After you create and publish the AMQ to REST API sample integration, you can confirm that it works as defined.
Prerequisite
In Fuse Online, in the list of integrations, Running appears next to the AMQ to REST API integration that you created and deployed.
Procedure
-
In a new browser window, go to the To Do app display by inserting
todo-
in front of the URL for your Fuse Online environment. For example:https://todo-app-proj761432.6a63.fuse-ignite.openshiftapps.com/
. - In the To Do app display, click Show JMS Form to display an input box that contains an XML message.
Click Send JMS Message to send that message to the Red Hat AMQ broker in your OpenShift project.
Successful execution returns a task from the To Do app client API. The task identifies the ID of the damaged item and the contact information for its vendor. If the task does not appear in a moment or two, try reloading the page.
Edit the XML message to specify two damaged items:
- Click Show JMS Form to display the message input box again.
-
In the XML message, change the entry for the undamaged item to specify
damaged="true"
. - Click Send JMS Message. The To Do app client API returns a new task that contains IDs for two damaged items and contact information for the two vendors.
Edit the XML message to specify an ID that you make up:
- Click Show JMS Form.
-
In the XML message, for the item that has
damaged="true"
, change the item ID, for example, to1234
. - Click Send JMS Message. The To Do app client API returns a new task with the item ID that you just entered.
Optionally, view the integration log to troubleshoot an unexpected result or to learn more about integration execution:
- In Fuse Online, in the left panel, click Integrations.
- Click the entry for your AMQ to REST API integration.
- In the integration’s summary page, click the Activity tab.
- Click the integration execution for which you want to view activity information.
5.8. Cleaning up your integration
When you are done working with a sample integration, you should stop it and delete it so that you can use the resources for another integration.
Prerequisites
- You are finished working with a sample integration that you published.
Procedure
- In Fuse Online, in the left panel, click Integrations.
- In the main panel, identify the entry for the sample integration that you want to stop.
- In that entry, to the right, click and then click Stop.
- Click Stop to confirm that you want to stop running the integration.
- In the entry for the integration that you just stopped, to the right, click and then click Delete.
- Click Delete to confirm that you want to delete the integration.