Browse this page for answers to some of the frequently asked questions you might have about IBM® App Connect. Click on a question to see the answer, or click the Show all button to show the answers to all questions.

If you have a question that is not answered here, check the forum, where you can also ask questions for support or general topics. For questions about this FAQ, you can add a comment to the bottom of this page.

For step-by-step examples, see Tutorials for IBM App Connect.


Getting started

What is IBM App Connect?

IBM App Connect is a business-friendly tool that you can use to integrate your cloud-based or on-premises applications to automate tedious and repetitive tasks.

For example, you might create a flow so that whenever a new lead is created in Salesforce, details of the lead are added to a row in a Google Sheets worksheet.

For more information, see Introduction to App Connect.

What is a flow?

There are two types of flow in IBM App Connect: an event-driven flow and a flow for an API.

In an event-driven flow, you identify an event that can occur in your first application (the source application), and actions that can be performed in one or more target applications. The flow links the event to the actions so that, whenever the event occurs in the source application, the action is automatically triggered in the target applications.

For example, you might create a flow so that whenever someone registers as a new attendee with Eventbrite (the event), App Connect automatically adds details of the attendee as a new contact in Salesforce and as a new task in Asana (the actions).

A multi-node flow, with the source application and 2 target applicationss
A multi-node flow, with the source application and 2 target applications

Each successfully completed action counts towards your monthly quota.

A flow for an API contains a request, one or more target application actions, and a response. The request uses a model that you define to request the creation or retrieval of data objects in your applications. When the request is submitted, each target application performs its action, and then the flow returns a response that either confirms that the actions were successful, or returns the data that was requested.

A flow for an API that creates a contact in your CRM system
A flow for an API that creates a contact in your CRM system

What applications can I connect?

Go to App Connect and click on the Applications tab to see a list of all the applications that are currently supported. Click an application to see more details about support for that application.

Support for more applications is underway. Let us know if there are other applications you want to use with App Connect.

Note: Applications that are marked Personal Plan are only available if you subscribe to the Personal plan.

What devices and browsers can I use to access App Connect?

App Connect Designer has been tested with latest versions of the following web browsers on the devices listed:

  • PCs:
    • Google Chrome
    • Mozilla Firefox
  • Apple Macs:
    • Google Chrome
    • Safari
  • Apple iPads with i/OS 10.x and above:
    • Safari
  • Android tablets:
    • Google Chrome

To use App Connect Designer, you should use the latest version of one of these web browsers. But, if you’re having problems with a different browser, let us know by posting an entry in the forum.

How do I get started for free? – I have an IBMid

Follow these simple steps to get started with IBM App Connect:

  1. Click Sign Up.
  2. Click Already have an IBMid?. (If you do not already have an IBMid, use the steps below.)
  3. Enter your IBMid and then click Continue
  4. Enter your password and then click Sign up for App Connect.
  5. Enter your company name and phone number.

Result: Your My IBM – Products and services page is displayed with a tile for IBM App Connect, which you can use to launch App Connect and start connecting your applications. The next time you want to use App Connect, you can go directly to the App Connect home page, and log in with your IBMid and password.

How do I get started for free? – I don’t have an IBMid

Follow these simple steps to create an IBMid and get started with IBM App Connect:

  1. Click Sign Up.
  2. Enter your email address and a password to use for your IBMid
  3. Complete the other required fields in the form
  4. Click Continue. A confirmation code is sent to your email account.
  5. Paste your confirmation code into the field provided, and then click Sign up for App Connect.

Result: An IBMid is created with a name (your email address), and the password that you provided. Your My IBM – Products and services page is displayed with a tile for IBM App Connect, which you can use to launch App Connect and start connecting your applications. The next time you want to use App Connect, you can go directly to the App Connect home page, and log in with your IBMid and password.

How do I configure App Connect to connect to my applications?

You must provide account details for each application that you want to connect. You can add the
account details for your applications in two ways:

Before you create a flow
Select an application from the Applications page, click Connect to app_name, and then enter the account details for the application.
While you are creating a flow
When you select an application that you want to connect, click Connect to app_name, and then enter the account details for the application.

Follow the prompts to permit App Connect to communicate with the application on your behalf.

Note: Currently, you can have only one account connected to each application. If you later want to connect a different account, or change the details of your existing account, you can choose an option to either update the account in use, or to remove that account then create a new account. (Before you can update or remove an account, you must stop all flows that use that account.)

What is the App Connect system status?

Check the following page to see if there are any current known issues with App Connect, and if there are any planned maintenance windows during which App Connect will be unavailable: https://developer.ibm.com/integration/docs/app-connect/app-connect-status/

I think I have a problem using App Connect. How do I get help?

If you think that you have a problem using IBM App Connect, use the following resources to get help:

  1. Browse this FAQ page for answers to some of the frequently asked questions you might have about IBM App Connect. For example, check the FAQ for the App Connect system status.
  2. Check the forum to see if an answer is already provided there.
  3. Ask a question about your problem in the forum, providing as much detail as possible to help answer your question. The forum is monitored by the IBM App Connect team and by other App Connect users.

Creating and managing flows

How do I create an event-driven flow?

Creating an event-driven flow takes just a few steps:

  1. On the Dashboard page in IBM App Connect Designer, click New > Create an event-driven flow
  2. Enter a name that identifies the purpose of your flow
  3. Select the source application, and the event to trigger the flow.
  4. Select and configure one or more target applications, and the actions to be performed.
  5. Click Exit and switch on to save and start your flow.

See the tutorial Creating an event-driven flow.

For more examples of creating event-driven flows, see:

How do I create a flow for an API?

If you want a developer to be able to create an app that makes use of the data in your cloud-based applications, you can provide an API. For example, you might provide an API that can create, retrieve, and update customers in your CRM system.

Creating flows for an API involves the following steps:

  1. Create one or more models that define the structure of the objects that you want to create or retrieve.
  2. Choose the create, retrieve, or update operations to perform against each model.
  3. Configure a flow that implements each operation, adding one or more target applications that hold the data.

See the tutorial Creating flows for an API.

For more examples of creating event-driven flows, see:

What does a retrieve action do?

A retrieve action gets information from an application so that you can use it in another application. For example, say you’ve organized an event in Eventbrite. When one of your existing customers sign up for the event, you want your Sales department to contact them with some personalized offers. So you choose the “New attendee” event to begin your flow. You then add the Salesforce “Retrieve contact” action, mapping the appropriate fields so that you retrieve the contact details and any other salient info for the customer that’s signed up. You can then add the Gmail “Create message” action to the flow to e-mail this important data to your Sales team.

When you choose an action to retrieve data from one of your applications, you can add one or more conditions to ensure that you’re getting the right information. For example, the following condition returns a single record where the email address of the Insightly lead matches the email address in the trigger application, and the Insightly lead comes from Ireland.

Example Retrieve action that returns a single record where the email address of the Insightly lead matches the email address in the trigger application, and the Insightly lead comes from Ireland

What does a create action do?

As the name suggests, a create action creates an object or record in an application. For example, if someone signs up to your event or submits a completed form, you might want to create a record for that person in your CRM or marketing application. Or if someone opens a ticket in your help desk application, you might want to create an email or instant message to ensure that someone deals with it straight away.

What does an update or create action do?

An update or create action changes an existing record in your target application if it exists, but creates the record if it doesn’t already exist. It’s also known as an upsert (update or insert) action.

For example, say someone has submitted a Wufoo form with a change of address. If the contact is already in your CRM system, you want to update their address; but if they’re not, you want to add them. Like the retrieve action, when you choose an action to update data in one of your applications, you can add one or more conditions to ensure that you’re updating the right information.

In the following example, if there’s a contact in Salesforce with the same first and last name as the person who’s submitted the change of address form, that contact is updated with the new details. If the contact doesn’t exist already, a new contact is created.

The diagram is described in the preceding text
An example of an update or create action in Salesforce.

If there’s more than one record in your target system that matches your criteria, you’ll see an error for the flow on the dashboard, and the flow won’t update or create any records. Returning to our example, maybe you have more than one contact with the same first and last names. So you could try to match a contact by using unique data, such as their email address.

You can find a list of available update or create actions by searching for “update or create” on the Applications page.

The graphic shows that the user has entered "update or create" in the search field on the Applications page, and a list of Salesforce update or create actions is shown
Searching for update or create actions on the Applications page.

What data can I specify to pass to a target application?

For additional information about the data relating to specific applications, see FAQ: Connecting applications.

When editing a target application in a flow, you need to specify data for any required target fields. You can also specify data for any optional fields that you want to use for the target application.

Note: In each required field for the target application, ensure that you provide a value as needed by the target application. If you map the name of a source field, you should ensure that the source application will pass a suitable value; otherwise, if a value passed is invalid the flow can’t complete successfully. In your flow, you can use conditional logic to do something appropriate if a value passed is invalid.

Tip: If a field name is truncated, hover over the field name to display the full name.

A required field with truncated name and mouse pointer used to show full name

In each target field, you can add the names of source fields to have those field values passed to the target application. For example:

Target field containing Email source field reference
Target field containing Email source field reference

adds Jane Doe@email.com to the required target field ‘Email Address’ if the source field ‘Email’ contains Jane Doe@email.com (the source application must pass such a valid email address).

You can select fields from the trigger application or from previous target applications in the flow. For example: (Select the image to view the full flow editor screen capture.)

You can apply functions to the source fields. You can also type text in the target fields.

  • You can click Auto Match Fields to populate the target fields with fields that have the same name in the source application.

    Tip: When matching fields, App Connect ignores character case and spaces; for example, the Google Sheets field First Name is matched with the Salesforce field FirstName.

  • To add source field names manually, click in the target field and then either:
    • Type part of a source field name, and then select a source field from the list offered.
    • Select source field names from the (+) menu.
  • To use a transform function to customize the value of a source field, select the field name and then select Apply a function; select a function from the list provided.

See also FAQ: What transform functions are available and how do I use them?

What transform functions are available and how do I use them?

When editing a target field in a flow, you can add a transform function to customize the value of a source field that is to be passed to the target application.

The following table lists the available transform functions, describes the purpose of each transform function, and gives an example.

Notes:

  • The syntax of the functions is JSONata, a lightweight query and transformation language. Learn more at http://jsonata.org
  • You can insert functions into a target field by several techniques (after selecting the target field):
    • Select a source field that you have already inserted into the target field, and then select Apply a function from the context menu; select a function from the list provided.
    • Select the Insert function icon (fx), then select a function to insert into the target field, and then insert source fields into the function.
    • Type the JSONata expression directly.
  • In the target field, a function is represented with curly brackets; for example:
    email_b4_function

    after applying the substringBefore function, becomes:

    email_with_function

  • You can edit a JSONata expression to apply more complex functions, including the use of regular expressions; for example:
    {{$substringBefore($substringAfter(name, "Name: "), ", Email:")}}

    adds John Smith to the target field if the source field contains ... Name: John Smith, Email: ....

  • If a JSONata expression is not valid, an error message is displayed below the target field; for example:
    JSONata expression: ?{{$uppercase(Department)}
    Use '}}' to end an expression
    
Function Description Example
length(field) Returns the number of characters in the source field. You can get the number of characters in a name. For example:

{{$length(Last Name)}}

adds 3 to the target field if the source field contains Doe.

lowercase(field) Convert the source field to lower case. You can convert a name to lower case. For example:

{{$lowercase(Last Name)}}

adds doe to the target field if the source field contains Doe.

replace(field, pattern, replacement [, limit]) Finds occurrences of pattern within the source field and replaces them with replacement. The pattern parameter can either be a string or a regular expression (regex). The replacement parameter can either be a string or a function. The optional limit parameter, is a number that specifies the maximum number of replacements to make before stopping.

For more details and examples, see the JSONata documentation

For example:

{{$replace(Name, "Jane", "Ms")}}

adds Ms Doe to the target field if the source field, Name, contains Jane Doe.


{{$replace(Name, /(\w+)\s(\w+)/, "$2, $1")}}

adds Doe, Jane to the target field if the source field, Name, contains Jane Doe.

substring(field, start[, length]) Add the substring of a source field that starts at position start (zero-offset). If length is specified, then the substring will contain the maximum length characters. If start is negative then it indicates the number of characters from the end of the source field. You can extract the first 3 characters of a name. For example:

{{$substring(Name, 0, 3)}}

adds Jan to the target field if the source field, Name, contains Jane Doe.

substringAfter(field, “string“) Add the part of a source field that occurs after a given string of characters. You can extract the mail domain from an email address, by using ‘@’ as the delimiting character. For example:

{{$substringAfter(Email, "@")}}

adds email.com to the target field if the source field, Email, contains Jane Doe@email.com.

substringBefore(field, “string“) Add the part of a source field that occurs before a given string of characters You can extract the name from an email address, by using ‘@’ as the delimiting character. For example:

{{$substringBefore(Email, "@")}}

adds Jane Doe to the target field if the source field, Email, contains Jane Doe@email.com.

trim(field) Normalizes and trims all whitespace characters in the source field by applying the following steps:

  • All tabs, carriage returns, and line feeds are replaced with spaces.
  • Contiguous sequences of spaces are reduced to a single space.
  • Trailing and leading spaces are removed.
You can trim a string field. For example:

{{$trim(Description)}}

adds Hello World to the target field if the source field, Description, contains Hello \n World .

uppercase(field) Convert the source field to upper case. You can convert a name to upper case. For example:

{{$uppercase(Last Name)}}

adds DOE to the target field if the source field, Last Name, contains Doe.

How do I add conditional logic to a flow?

If you want your flow to do different things depending on the data that it receives from the trigger application, you can add some conditional logic to your flow in the form of an “IF” node; in fact, you can add up to 10 IF nodes to a flow.

For example, say you’ve created some events in Eventbrite. You might want to treat data differently for particular events. When someone signs up for one event, you might want to add them to your CRM system as a lead. But when someone signs up for another specific event, you might want to add them to a mailing list. And if they sign up for any other event, you might not want to do anything with that data. So after you’ve added the Eventbrite “New attendee” event to trigger your flow, you can add an IF node, as shown in the following example.

The conditional logic says that if someone signs up to one of the events with the specified IDs, they’re either added as a lead in Salesforce or a subscriber to a list in MailChimp. But if they sign up to any other event, the flow won’t process any data for that sign-up, and a message that you define is written to the logs. For the actions that do continue, you can pass data from from the IF node to the rest of your flow by creating an output schema, then populating the fields with data for each branch of your IF node. When you add an action after the IF node, you can populate the target fields with data from the IF node.

In this example, when someone signs up to an event other than the 2 that you’re interested in, we’ve chosen to exit the flow with a success message, indicated by the HTTP status code “200”. No error has occurred; you just don’t want to do anything about this sign-up. Alternatively, you can choose to end a branch with an error message, indicated by the HTTP status code “400”. This situation is then flagged as an error in the logs.

This example is very simple, but you can handle more complex processing by adding more actions to your IF and ELSE branches or by adding more conditions. You can also add nested IF nodes by adding more IF nodes to branches.

Things to consider:

  • If you add an action after an IF node in a flow, you can choose to exit the flow at the end of as many branches of the IF node as you like, as long as at least one branch continues processing so that data is passed to the target application. If the IF node is at the end of an event-driven flow, the flow can exit on all branches.
  • The custom message that you define must be a maximum of 128 characters long.
  • If you exit the flow at the end of a branch, you cannot define output data for that branch.

The following steps describe how to add conditional logic to your flow.

  1. Create a flow in the usual way, and select the source application and the trigger event.
  2. Click the Logic tab and select If (conditional).

    The flow editor resizes to accommodate the IF node, and the IF node dialog box opens. You can reopen the dialog box at any time by clicking the IF icon. The icon that opens the IF dialog box

  3. Define your first IF condition by selecting a field from the source application and setting a value.
  4. (Optional) To add another IF condition, click Add condition. Define it in the same way as your first condition, and choose whether both conditions have to be matched, or just one of them by selecting All of the following are true or Any of the following are true.
  5. Add a target application for your IF branch by clicking the plus icon, and select the action to be performed. You can add more target applications in the same way.Plus icon that allows you to add an action to the IF node
  6. (Optional) Add one or more ELSE IF branches by clicking Add else if and defining one or more conditions.

    Tip: When you add IF logic to a flow, data will travel down the first branch where the conditions are matched. So pay close attention to the order of your branches. Also, target applications (and nested IF nodes) on a branch of an IF node can only see data from the preceding actions in the branch; they can’t see data from other branches.

  7. (Optional) Add one or more target applications for your ELSE branch and, if added, your ELSE IF branches.
  8. (Optional) If you want to pass the data from the actions in your IF node to the rest of the flow, create an output schema and populate the output data for each branch.
    1. Expand the Output schema section and click Add a property.
    2. Enter the name of a piece of data that you want to pass to the rest of the flow, such as Email Address or Last Name.
    3. If the property is mandatory in the output data, select Required.
    4. Repeat these steps to add as many properties as you need.
    5. For each IF and ELSE branch, click Output data and populate the fields from the output schema with the data that you want to pass to the rest of the flow.
  9. (Optional) If you want to exit the flow for a particular condition, select Exit flow at the end of this branch. Select the message code that you want to be written to the logs, and write your own message to accompany it.
  10. (Optional) Add one or more target applications and actions after the IF node. You’ll see that when you come to populate the target fields for these actions, you can map data from the source application, as well as from any preceding IF nodes and actions.

    Tip: When you’ve finished defining your IF conditions, you can collapse the IF node to create more space in the editor by clicking the Collapse icon: The icon that collapses the IF node in the flow editor

  11. When you’re ready, click Exit and switch on to start the flow.

What about advanced mode editing?

In the default edit view for an action, some applications have fields that are hidden because they are not needed for general use cases. For more advanced use cases, you can switch to advanced mode editing which provides extra capabilities:

  • You can edit fields that are hidden in the default edit view.
  • You can apply mapping and transform functions to dynamically set the value of fields that would be selected in the default edit view. For example, instead of selecting an Asana project in which to create a task you might use a preceding Retrieve action in the flow to dynamically retrieve a record from another application and then map that to the ID field of the project for the Create Task action.

To switch between default editing and advanced mode editing, use the context menu for the action; for example, when in the default edit view, select Switch to advanced mode:

Switch to advanced mode editing option of an action’s context menu

Considerations:

  • If you select a field in advanced mode, you are shown the description and data type for the field, and sample data.
  • If you specify a value for a field that is only in advanced mode, the value will be lost if you exit this mode. If you need to keep the values for such fields, you must stay in advanced mode editing for the action.
  • When in advanced mode editing, you can switch to the default edit view from the context menu. The ‘Exit advanced mode’ option also shows a message warning that you will lose any values for fields that are visible only in advanced mode.

How do I edit an existing or draft flow?

To change the configuration of an existing flow or complete a draft flow, complete the following steps:

  1. Click Dashboard in the App Connect header and locate the flow that you want to edit.

    If the flow is shown as running, stop the flow from its flow menu.

  2. To edit the flow, either select the body of the flow tile, or in the flow’s menu select Edit flow.
    Flow menu options to manage or edit the flow
  3. You can change the apps, the events and actions, the fields that are matched, and the name of the flow. Changing the name of the flow does not create a new copy of the flow.

How do I start or stop a flow?

To start or stop a flow, complete the following steps:

  1. Click Dashboard in the App Connect header and locate the flow that you want to change.
  2. In the flow’s menu, select the action that you want to take:
    Flow menu options to manage or edit the flow

How do I delete a flow?

To delete a flow, complete the following steps:

  1. Click Dashboard in the App Connect header, and then locate the flow that you want to delete.

    If the flow is shown as running, stop the flow from its flow menu.

  2. In the flow menu, select the option to delete the flow.
    Flow menu options to manage or edit the flow

Connecting applications

What should I know about connecting to Eventbrite?

In App Connect, there may be times when you want to specify the unique ID for an Eventbrite resource, like a venue, category, or format. For information about how to identify a unique ID, you can use the Eventbrite help and API Explorer, including:

  • How to find your event ID
  • Using the API Explorer to get IDs for your categories, formats, venues and other resources, see the Eventbrite API Documentation. For this, you will need your Eventbrite personal OAuth token, your_api_token, described in the Eventbrite API Documentation.

    Examples: In your web browser, you can use the following URLs with your_api_token to get IDs, and other details, for Eventbrite resources:

    • Finding your event venues: https://www.eventbriteapi.com/v3/users/me/venues/?token=your_api_token
    • Finding categories defined by Eventbrite: https://www.eventbriteapi.com/v3/categories/?token=your_api_token
    • Finding formats defined by Eventbrite: https://www.eventbriteapi.com/v3/formats/?token=your_api_token

What should I know about connecting to Google Sheets?

  • If you want to use a Google Sheets spreadsheet as your target application, you must select a worksheet that has column names in the first row. These column names are used as the target fields for your action. If your worksheet does not have the first row populated with column names, you cannot match fields between your source and target applications.

    Note: If your worksheet has duplicate column names, only the first instance of each duplicated column is used as a target field.

What should I know about invoking an HTTP method?

  • The supported HTTP methods are: GET, POST, PUT, PATCH, DELETE, or HEAD.
  • The specified HTTP URL must be fully qualified.

    Examples:
    http://www.example.com/
    https://host_name:port/path

  • Request headers must be specified as a JSON (object) representation of header field name/value pairs that are comma separated and collectively enclosed within opening and closing braces. The required format is:
    {“header_field1”: “value1”, “header_field2”: “value2”, … , “header_fieldN”: “valueN”}

    Example:
    {“Content-Type”: “text/html”, “Keep-Alive”: “300”}

What should I know about connecting to IBM Integration Bus?

You can create custom applications from IBM Integration Bus message flows. Then, you can create an App Connect flow to connect each custom application to any other application supported by App Connect, so that messages that are processed by the message flow initiate actions in another application.

For example, you might create an App Connect flow so that when a Warehouse system sends a new stock notification to an IBM Integration Bus message flow, an email is automatically sent to interested customers with details of the stock availability.

You can create custom applications from message flows that are deployed to IBM Integration Bus on-premises environments or to IBM Integration Bus on Cloud. For an example, see the following tutorial: Tutorial: IBM Integration Bus (custom application) to Gmail

What should I know about connecting to IBM Message Hub?

You can use Message Hub’s Send Message action to take streams of events from your source application and feed them, via a Message Hub topic, into an Open Whisk server-less run-time environment. For a demonstration of how to use Message Hub to connect Salesforce to Open Whisk, see Salesforce to Open Whisk via Message Hub.

What should I know about connecting to Insightly?

  • IBM App Connect uses the Insightly v2.1 API.
  • You can use Insightly unique ID numbers in some use cases in App Connect; for example, to create an Insightly Contact record with the visibility restricted to an Insightly team (specified by its unique ID number). For help finding unique ID numbers, see Accessing an item using a unique ID number in the Insightly help.

What should I know about using Marketo as a target application?

  • Before you start to use Marketo as a target application, you must find the required values for the following settings:
    • REST URL
    • Identity URL
    • Client ID
    • Client Secret

    Complete the following steps to identify the values you must enter for these settings:

    1. Log in to Marketo with an ID that has administration access (or ask your Marketo administrator to do the following steps for you).
    2. Create or identify an API Only user account. (Ref: Marketo Docs)
    3. Click the Admin tab, and then click Web Services in the Integration pane.
    4. In the REST API section, note the values in the following fields:
      • Endpoint: Use this value for the REST URL.
      • Identity: Use this value for the Identity URL.
    5. In the Integration pane, click LaunchPoint. The Installed services window opens.
    6. Click New > New Service and complete the following fields to create a custom service for use with the REST API: Ref: Marketo Docs)
      • Display name: Enter a name that identifies you and the purpose of the service, for example:

        AppConnect-username

      • Service: Select Custom.
      • Description: Enter a description. For example:

        Connection for App Connect

      • API Only User: Select your API Only Marketo user ID.
    7. Click Create. The new service is displayed in the Installed services window.
    8. Select the service and click View details. Note the following values:
      • Client Id: Use this value as the Client ID.
      • Client Secret: Use this as the Client secret.

    Use these values when you create your Marketo connection in App Connect.

What should I know about connecting to Salesforce?

  • If you want to create a free Salesforce account to test out App Connect, make sure that you create a Developer account rather than a Trial account. If you connect to App Connect with a Trial account, the Salesforce events do not work.
  • When you use Salesforce as a target application, make sure that you identify the required fields for the entry you are creating and assign values to these fields. For example:
    • If you are creating a new Lead, you must provide values for the LastName and Company fields.
    • If you are creating a new Contact, you must provide a value for the LastName field.
    • If you are creating a new Account, you must provide a value for the Name field.
  • For a step-by-step example of how to create a flow that uses Salesforce as the source application, see Tutorial: Salesforce and Google Sheets.

What should I know about connecting to SAP?

IBM App Connect can provide easy access to critical data in SAP in real time (through OData APIs) for use with other apps like Salesforce Lightning, without needing any coding or data migration.

Before you create a connection to SAP you need the following prerequisites:

  1. A well-defined SAP Gateway OData service that conforms to several requirements; your SAP objects should be defined without relationships, and your SAP service should be enabled with the sap:creatable:false flag. For more information about the requirement for a SAP service, see Creating a well-defined SAP Gateway OData service for use with IBM App Connect.
  2. The following SAP settings:
    SAP Gateway Service URL
    Specifies the URL to the SAP Gateway OData service.
    UserName
    Specifies the user name to use when connecting to the SAP Gateway OData service.
    Password
    Specifies the password to the user name when connecting to the SAP Gateway OData service.
  3. A network in App Connect configured to enable access to a SAP Gateway system in a private network.

    If you want App Connect to connect to a SAP Gateway OData service in a private network, ensure that you have an existing network in App Connect defined for your private network, and ensure that the Access control list (ACL) for the network is configured to allow connections to the SAP system. When connecting to SAP, you can select the option to create a new network. For information about creating a network in App Connect, see What should I know about connecting to applications that are on a private network?.

Before using the SAP connection in App Connect Designer, start the IBM Secure Gateway client that you configured for use with SAP. After starting the client, the Applications page of App Connect Designer should list the SAP objects and their actions that you can use; for example:

SAP objects and their actions as listed on the Applications page

Hint: If you start the IBM Secure Gateway client after logging in to App Connect Designer, you can refresh the Applications page to see the list of SAP objects and their actions.

Troubleshooting

  • If you see the message “We are unable to retrieve objects for SAP.”, check the network that you selected for use with the SAP connection:
    • The IBM Secure Gateway client is running
    • The ACL for the IBM Secure Gateway is configured to allow connections to the host and port of the SAP system

    For example:

    • On the Networks page:
      Network page showing a connected network for SAP, with ACL that allows access to the SAP system.
      (Click the image to see more of the Network page.)
    • On the Secure Gateway ACL page:
      Secure Gateway ACL page for SAP network, with ACL that allows access to the SAP system.
      (Click the image to see more of the Secure Gateway ACL page.)

    If starting the IBM Secure Gateway client with the correct ACL does not display the list of SAP objects, also verify the following:

    • The computer on which the IBM Secure Gateway client is running is connected to the host of the SAP system (for example, can ping the IP address of the host)
    • The user name to use when connecting to the SAP Gateway OData service is authorized to pass through any internal firewalls between the IBM Secure Gateway client and the SAP system.

For general information about connecting SAP OData to App Connect, see How to use IBM App Connect with SAP.

What should I know about connecting to SurveyMonkey?

  • To use IBM App Connect with SurveyMonkey, you need to have a Platinum SurveyMonkey account.
  • When using App Connect to create a collector in SurveyMonkey, you can create an Email or Web Link collector. To specify which connector you want to create, enter Email or Web Link into the Type field.

What should I know about connecting to custom applications?

  • You must subscribe to the IBM App Connect Personal plan in order to create custom applications.
  • You must have an application definition file for your custom application that contains the events and actions that you can use in App Connect.

    Note: Currently, you can connect only a custom application that is based on an IBM Integration Bus message flow. For an example, see the following tutorial: Tutorial: IBM Integration Bus (custom application) to Gmail. For more information about the custom application used, and as an example on which you might base your own custom applications, see Warehouse sample application.

  • Complete the following steps to connect a custom application:
    1. From the Applications page, click Add your application now.
    2. Give your application a name and a description.
    3. If your application is not available from the internet, you need to connect to your private network, see FAQ: What should I know about connecting to applications that are on a private network?
    4. Add your application definition file and click Apply.

    Result: Your application is now displayed on the Applications page and you can select the application as a source application (if the application has triggers) and as a target application (if the application has actions).

What should I know about connecting to applications that are on a private network?

  • You can connect to applications on a private network (for example, your company network or a private cloud) if you subscribe to the IBM App Connect Personal plan.
  • You use the IBM Secure Gateway to connect App Connect to applications that are available on a private network. For more information about the IBM Secure Gateway, see IBM Secure Gateway.

  • From App Connect, you can download and install the IBM Secure Gateway client, as outlined below.

    Note: You cannot install the IBM Secure Gateway client on a mobile phone or tablet.

    Before you create a flow
    From the App Connect menu, select Networks, click Connect a network, and follow the steps to download and install the IBM Secure Gateway client, and create a network connection. When you create a flow, you can select this network connection when you configure the account details for an application that is on the private network. You can also select the network connection when you define a custom application.
    While you are creating a flow
    Select the applications that you want to connect, and the event and action you want to use. When you are prompted to select the accounts for each application, click Connect to your network for any application that is on a private network. Follow the steps to download and install the IBM Secure Gateway client, and create a network connection. The network connection is selected for the application that is on the private network, and you can continue configuring your flow. You can use the same network connection when you define custom applications, or create flows that use other applications that are on the same private network.
    While you are defining a custom application
    Click Connect to a new private network. Follow the steps to download and install the IBM Secure Gateway client, and create a network connection. The network connection is selected, and then you can continue configuring your application. You can use the same network connection when you define other custom applications, or create flows that use applications that are on the same private network.

Note: You must set an access control list before you can connect to applications on a private network via the IBM Secure Gateway, see IBM Secure Gateway – Access control list

For a step-by-step example of how to configure a private network, see Tutorial: Configuring a private network

What can I do if my connection to an application is broken?

When you configure App Connect to connect to an application like Gmail, a notification that you have authorized App Connect to use your account details is recorded in your account profile for that application. For example, if you provide App Connect with your Google credentials, so that App Connect can connect to your Gmail account, you can see this authorization specified in your Google account (under Sign in & security > Connected apps and sites). If you remove the authorization from your Google account, App Connect can no longer connect to your Gmail account and any flows that use Gmail as a target application will become inactive.

To reconnect App Connect to an application where the authorization has been removed, go to the Applications page in App Connect. There, you can choose either to update the account, or to remove the account, and then add the account again (or add a new account).

Account details

I’ve forgotten my user ID. How do I find it?

Your user ID is the email address that you used to register for App Connect. If you have forgotten the email address that you used, click IBMid help desk, and locate the contact details for your country.

I’ve forgotten my password. How do I reset it?

Click Forgot password to go to the IBMid registration page and reset your password.

How do I change my password?

Click Change password to go to the IBMid registration page and change your password.

How do I change my email address?

Click Profile to go to your IBMid profile. Log in and change your email address in your profile.

Note: Your IBMid is still the same as the email address that you used when you registered for App Connect. Changing your email address does not change the name of your IBMid.

What features are available on each pricing plan?

For details of the different pricing plans and the features that are available, see Cloud Marketplace.

How can I check my account usage?

From the App Connect header, click the Notifications icon (notifications). A panel displays the following information:

  • Your current pricing plan (with a link to where you can upgrade the plan if you are on the Free plan).
  • The number of flows that you have created so far.
  • If you are on the Free plan, the number of flows that you are entitled to create.

I have a monthly quota of ‘actions’ but what counts as an action?

An action is any task that is initiated by a flow. For example, the update of an application or the sending of an email.

Note: Only successfully completed actions count towards your monthly quota. For example, if an event occurs but the flow is unable to complete the action, the attempted action does not count towards your quota.

How do I change my subscription from the Free plan to the Personal plan?

Just go to Cloud Marketplace and sign up for the Personal plan with the same IBMid that you used to sign up to the Free plan. The next time that you log in to App Connect, any flows that you created when you were on the Free plan are still available and in the same status (on, off, or in draft).

How do I change my subscription from the Personal plan to the Free plan?

If you signed up for the Free plan before you signed up for the Personal plan, your subscription to the Free plan is still active. If you haven’t signed up for the Free plan, do that first. Then, cancel your subscription to the Personal plan (see FAQ: How do I change my payment method or cancel my subscription?). The next time that you log in to App Connect, any flows that you created when you were on the Personal plan are still available and in the same status (on, off, or in draft) with the following caveats:

  • If you created any flows that connected to custom applications or to applications on a private network, those flows are inactive.
  • If you created more than 10 flows, you cannot create any new flows until you have deleted some of the existing flows.

How do I change my payment method or cancel my subscription?

Contact IBM App Connect support by clicking Contact Us in the menu in the App Connect header.

Trademarks

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at Copyright and trademark information.

15 comments on"Frequently asked questions about IBM App Connect"

  1. Hi,

    We wanted to migrate boomi integrations to appconnect. Is there any easier way to migrate them to appconnect instead of rebuilidng the integrations from the scratch?

    • Ian_Larner July 24, 2017

      @Ismail,
      There’s no one-to-one migration by copy from Boomi to IBM App Connect, and teams who moved projects from Boomi have responded that no migration tool would have helped their use case. Migration is an opportunity to review the original project to improve/simplify the design, eliminate issues, and exploit capabilities in IBM App Connect. Migrating by copy is usually more costly and persists poorer integration than reviewing the design and creating anew.

      Teams who migrated their projects off Boomi created new projects from scratch.

      Regards, Ian

  2. How do I connect to Data endpoints like JDE?

    • Ian_Larner April 20, 2017

      David,
      For JD Edwards (JDE) specifically, the current connect alternatives are 1) in App Connect Professional Studio the JDE endpoint (the current JD Edwards presence on the App Connect Applications page https://appconnect.ibmcloud.com/applications/) or 2) in App Connect Designer a custom app with IBM Integration Bus use of the WebSphere Adapter for JDE.

      For other endpoints ‘like JDE’ – enterprise on-premise applications – current connect options are similar.

      For JDE, and other endpoints ‘like JDE’, App Connect Designer has a fast-growing list of connectors that we are working to deliver. The on-premise application we started with is SAP, which we have delivered in App Connect Designer. We have plans for adding connectors like JDE to App Connect Designer in the coming months.

  3. Dear all

    I have the following case and I would appreciate any comment that could help.

    I have created an app by using IBM Domino Designer and I would like to connect that app to Slack.

    The logic of the app is very simple:
    1- You press a button on IBM Notes Client
    2- After that a message should be sent to one of Slack channel says [Test OK]

    The button on IBM Domino Designer is programmable (JavaScript, LotusScript could be used to program it)

    Any help would be appreciated
    Thank you very much in advance

    Best Regards

    Hattan

    • Karen Cameron October 20, 2016

      Hello Hattan,
      We don’t have a Domino connector in App Connect yet, so you can’t currently use App Connect to connect your Domino application to Slack. You might have noticed that you also have the ability to connect to a custom application in App Connect, but at the moment, you can only connect a custom application that is based on an IBM Integration Bus message flow.
      I hope that answers your question.
      Regards,
      Karen

  4. Timm Bryant October 12, 2016

    How do I edit an existing account for the Salesforce connector?

    • Karen Cameron October 18, 2016

      Hello Timm. Currently, you can have only one account connected to each application. If you want to connect a different account, or change the details of your existing account, you have to delete any flows that are using that account, delete the account, then re-create it. This is a known limitation that we are planning to remove in the future.

  5. The “What Transforms…” box does not fold away when I click on the arrow.

    • Please could you tell me what browser and operating system you are using? I don’t see this problem with Firefox or Chrome on Windows, but there might be other combinations of browser and operating system for which the open/collapse control is not working.

Join The Discussion

Your email address will not be published. Required fields are marked *