Getting started

Get up and running with App Connect by taking advantage of tutorials, templates, and how-to guides.

Follow a tutorial

The Tutorials take you step by step through some common tasks and scenarios in App Connect Designer like creating event-driven and API flows that address common integrations. You can also find tutorials that guide you through tasks like configuring polled events, retrieving items from your applications, and including toolbox utilities like parsers.

You might like to look at the following tutorials as you start your journey with App Connect.

Try a template

Templates are provided for typical integrations. See the gallery of templates on the Discover page The icon that represents the Discover page..
The Discover page has a search field where you can search for templates for a specific application or use case.

You can filter the list of templates by searching for a specific application, object, or action.

When you find a template that meets your criteria, click the tile to find out more about it and how to use it. You might want to copy the instructions or open them in a separate window to refer to when customizing your flow. You can then create an event-driven or API flow from the template. When the flow opens in App Connect Designer, you can connect to your applications and customize any of the mappings or actions. If you need help with connecting to your accounts, or want to find out more about how to work with an application in App Connect, try the how-to guides. As with all flows, when you're ready to run it against your applications, you can deploy it.

Ask the integration agent to create a flow

The AI-based integration agent is powered by IBM watsonx and can help you to create flows. Tell the integration agent what you need the flow to do, and the agent creates the flow for you and prompts you to connect to your applications and map your data. You can also ask the agent to add more actions and Toolbox utilities to the flow. To open the agent, click the integration agent icon The icon that represents the integration agent.
The integration agent provides a text input box for you to describe your integration.

Refer to the how-to guides for connectors

The How-to guides describe how to connect App Connect to your applications. The guides also include any special prerequisites or considerations that applications might have, and they list tutorials or templates that include the applications.

Learn more from the documentation

The App Connect documentation introduces App Connect and describes how to use it to create and deploy your integrations. You might find the following topics useful as you start to use App Connect.
  • For an overview of the different ways that you can create a flow in App Connect Designer, see Creating integrations.
  • To learn how to deploy integrations, see Deploying integrations.
  • To see the amount of resources that your deployed runtimes and integrations are using, see Monitoring.
  • To find out how to view log messages and collect trace information for your deployed flows, see Troubleshooting.
To view documentation offline in a PDF, click Download PDF.
Screenshot showing the Download PDF link in the table of contents.
You can also view documentation offline by downloading it and viewing it in the IBM Documentation Offline application.
  1. Log in to IBM Documentation.
  2. Go to IBM Documentation Offline and follow the instructions to download, install, and open the application.
  3. In the App Connect documentation, at the end of the table of contents, click Offline docs. The documentation is downloaded as a .zip file.

    If you have already downloaded the documentation, the link changes to Downloaded. If the documentation has been updated since you downloaded it, the link changes to Update available. If you don't see a link, make sure that you're logged in to IBM Documentation with your IBMid.

  4. In IBM Documentation Offline, click Add or update docs.
    The Add or update docs link in the IBM Docs Offline application
  5. Click Select product files and select the .zip file that you downloaded.
  6. Select the appropriate language, then click Upload products. The selected product documentation is imported and a tile is added to the product list in IBM Documentation Offline. To view the documentation, click the tile.