SSTTDS_saas - Documentation Index

Table of Contents

• Welcome
• What's new
• Overview
  • Solution architecture
  • Subscription terms
  • Pricing plans
  • Known limitations
  • Components and resources
  • On-premises versus cloud deployment
  • Glossary
• Managing subscriptions, instances, and users
  • What's new
  • Using the IBM SaaS Console with accounts
    • Getting started with the IBM SaaS Console with accounts
    • Granting access through service IDs and API keys from the IBM SaaS Console
    • Email notifications
  • Updating the version of your integration runtime
• Getting started
• Migrating to App Connect in webMethods Hybrid Integration
  • BAR file migration script
  • Designer flows migration script
• Configuring App Connect
• Creating integrations
  • Creating flows in App Connect Designer
    • Types of flows
    • Webhook callback URLs
    • Creating a flow from an imported definition
    • Creating a flow from a template
    • Creating event-driven flows from scratch
    • Creating flows for an API from scratch
    • Connecting to accounts
      • Managing accounts
    • Validating your flow
    • Catching errors in your flows
    • Importing APIs from IBM API Connect
    • Importing APIs from OpenAPI documents
    • Importing GraphQL APIs
    • Importing SOAP web services
    • Importing or creating community connectors
    • Configuring actions
      • How CRUD actions work in IBM App Connect
        • Create action
        • Retrieve action
        • Update action
        • Update or create action
        • Delete action
      • Techniques for specifying data to be passed to a target application or API
      • Simplifying data mapping and data transformation with AI-powered suggestions
        • Mapping Assist overview
        • Mapping your data by applying smart suggestions
        • Transforming data with the transformation generator
      • Mapping your data by inserting references
      • Applying JSONata functions to transform your data
      • Defining your own data properties
      • Composing CSV output for an action in a flow
      • Composing XML output for an action in a flow
      • Using advanced mode editing
    • Adding special processing to a flow (Toolbox utilities)
      • Configuring your flow to run at scheduled times
      • If (conditional)
      • Using the For each node
      • Enhancing logging with customized log messages
      • Using batch processing
      • Using a Set variable node to create mappings that you can reuse within a flow
      • Using the JSON parser to parse a JSON string into a JSON object
      • Using the CSV parser to parse CSV text into a JSON object
      • Using the XML parser to parse an XML string into an XML object
    • Tutorials
      • Creating an event-driven flow
      • Creating flows for an API (Part 1)
      • Creating flows for an API (Part 2)
      • Adding a new card in Trello when a new case is added in Salesforce
      • Adding data to Google Sheets when a new lead is added to Salesforce
      • Configuring polled events to trigger flows
      • Connecting IBM App Connect to an IBM Db2 database in a private network
      • Connecting IBM App Connect to an IBM MQ queue manager in a private network
      • Copying a Wufoo attachment to Box
      • Copying files from Dropbox to IBM Cloud Object Storage S3 on schedule
      • Creating a document in IBM Cloudant when a new contact is added in Salesforce
      • Creating an API flow to create SAP OData resources
      • Downloading a file from IBM Cloud Object Storage S3 to a Dropbox folder
      • Retrieving items from your applications
      • Sync Salesforce instances when records are deleted
      • Updating or creating a contact in Salesforce and updating Asana when a Wufoo form is submitted
      • Using the JSON parser to convert the response from an HTTP call for subsequent use in a flow
    • How-to guides for apps
      • How to connect applications in Designer
      • Amazon CloudWatch
        • Obtaining connection values for Amazon CloudWatch (BASIC, OIDC WEB, and BASIC OIDC)
      • Amazon DynamoDB
        • Obtaining connection values for Amazon DynamoDB (BASIC, OIDC WEB, and BASIC OIDC)
        • Obtaining connection values for Amazon DynamoDB (AWS PKI)
      • Amazon EC2
        • Obtaining connection values for Amazon EC2 (BASIC, OIDC WEB, and BASIC OIDC)
      • Amazon EventBridge
        • Obtaining connection values for Amazon EventBridge (BASIC, OIDC WEB, and BASIC OIDC)
      • Amazon Kinesis
        • Obtaining connection values for Amazon Kinesis (BASIC, OIDC WEB, and BASIC OIDC)
      • Amazon RDS
        • Obtaining connection values for Amazon RDS (BASIC, OIDC WEB, and BASIC OIDC)
      • Amazon Redshift
      • Amazon S3
        • Obtaining connection values for Amazon S3 (BASIC, OIDC WEB, and BASIC OIDC)
        • Configuring AWS PrivateLink endpoint or VPC endpoint and AWS PrivateLink certificate or TLS Certificate for Amazon S3
        • Obtaining connection values for Amazon S3 (AWS PKI)
      • Amazon SES
        • Obtaining connection values for Amazon SES (BASIC, OIDC WEB, and BASIC OIDC)
      • Amazon SNS
        • Obtaining connection values for Amazon SNS (BASIC, OIDC WEB, and BASIC OIDC)
        • Obtaining connection values for Amazon SNS (AWS PKI)
      • Amazon SQS
        • Obtaining connection values for Amazon SQS (BASIC, OIDC WEB, and BASIC OIDC)
        • Obtaining connection values for Amazon SQS (AWS PKI)
      • Anaplan
        • Obtaining connection values for Anaplan
      • Apache Pulsar
        • Obtaining connection values for Apache Pulsar
      • APIs (imported)
        • APIs from API Connect
        • APIs from OpenAPI documents
        • GraphQL APIs
      • Asana
        • Connecting to Asana
      • Astra DB
        • Obtaining connection values for Astra DB
      • AWS Lambda
        • Obtaining connection values for AWS Lambda (BASIC, OIDC WEB, and BASIC OIDC)
        • Obtaining connection values for AWS Lambda (AWS PKI)
      • BambooHR
        • Obtaining connection values for BambooHR
      • Box
        • Obtaining connection values for Box
      • Businessmap
        • Obtaining connection values for Businessmap
      • Calendly
        • Obtaining connection values for Calendly
      • ClickSend
        • Obtaining connection values for ClickSend
      • CMIS
      • Community connector (imported)
      • Confluence
      • Couchbase
      • Coupa
        • Obtaining connection values for Coupa
      • Crystal Ball
        • Obtaining connection values for Crystal Ball
      • Databricks
        • Obtaining connection values for Databricks
      • DocuSign
        • Obtaining connection values for DocuSign
      • Domino
      • Dropbox
        • Connecting from App Connect Enterprise as a Service
      • Email
      • Eventbrite
        • Obtaining connection values for Eventbrite
      • Expensify
        • Obtaining connection values for Expensify
      • Factorial HR
        • Obtaining connection values for Factorial HR
      • flexEngage
      • Front
        • Obtaining connection values for Front
      • GitHub
        • Obtaining connection values for GitHub
      • GitLab
      • Gmail
        • Connecting to a Google application using the website (OAUTH 2.0 AUTH CODE)
        • Connecting to a Google application by providing credentials for App Connect to use (BASIC OAUTH)
      • Google Analytics
        • Obtaining connection values for Google Analytics
      • Google Calendar
      • Google Chat
      • Google Cloud BigQuery
      • Google Cloud Pub/Sub
      • Google Cloud Storage
      • Google Contacts
      • Google Drive
      • Google Gemini
        • Obtaining connection values for Google Gemini
      • Google Groups
      • Google Sheets
      • Google Tasks
      • Google Translate
      • Greenhouse
        • Obtaining connection values for Greenhouse
      • HTTP
        • Connecting from App Connect Enterprise as a Service
      • HubSpot CRM
        • Obtaining connection values for HubSpot CRM
      • HubSpot Marketing
        • Obtaining connection values for HubSpot Marketing
      • Hunter
        • Obtaining connection values for Hunter
      • IBM Aspera
        • Obtaining connection values for IBM Aspera
      • IBM Cloud Object Storage S3
      • IBM Cloudant
      • IBM Db2
        • Configuring IBM Db2 for z/OS privileges
      • IBM Engineering Workflow Management
      • IBM FileNet Content Manager
      • IBM Food Trust
      • IBM Maximo
        • Configuring the IBM Maximo Integration Framework to route outbound event messages to App Connect
      • IBM MQ
      • IBM OpenPages with Watson
      • IBM Planning Analytics
        • Obtaining connection values for IBM Planning Analytics
      • IBM Sterling Intelligent Promising
      • IBM Sterling Order Management System
      • IBM Supply Chain Intelligence Suite
      • IBM Targetprocess
        • Obtaining connection values for IBM Targetprocess
      • IBM Watson Discovery
        • Obtaining connection values for IBM Watson Discovery
      • IBM watsonx.ai
        • Obtaining connection values for IBM watsonx.ai
      • IBM z/OS Connect
      • Infobip
        • Obtaining connection values for Infobip
      • Insightly
        • Obtaining connection values for Insightly
      • JDBC
      • Jenkins
      • Jira
      • Kafka
        • Connecting to a Kafka schema registry
      • LDAP
      • Magento
      • Mailchimp
        • Obtaining connection values for Mailchimp
      • Marketo
        • How to configure and activate a Marketo Webhook for use with App Connect
        • Obtaining connection values for Marketo
      • Microsoft Active Directory
      • Microsoft Azure Blob Storage
        • Obtaining connection values for Microsoft Azure Blob Storage
      • Microsoft Azure Cosmos DB
        • Obtaining connection values for Microsoft Azure Cosmos DB
      • Microsoft Azure Event Hubs
        • Obtaining connection values for Microsoft Azure Event Hubs
      • Microsoft Azure Service Bus
        • Obtaining connection values for Microsoft Azure Service Bus
      • Microsoft Dynamics 365 for Finance and Operations
        • Obtaining connection values for Microsoft Dynamics 365 for Finance and Operations
      • Microsoft Dynamics 365 for Sales
        • Obtaining connection values for Microsoft Dynamics 365 for Sales
      • Microsoft Entra ID
        • Obtaining connection values for Microsoft Entra ID
      • Microsoft Excel Online
        • Obtaining connection values for Microsoft Excel Online
      • Microsoft Exchange
        • Obtaining connection values for Microsoft Exchange
      • Microsoft OneDrive for Business
        • Obtaining connection values for Microsoft OneDrive for Business
      • Microsoft OneNote
        • Obtaining connection values for Microsoft OneNote
      • Microsoft Power BI
        • Obtaining connection values for Microsoft Power BI
      • Microsoft SharePoint
        • Obtaining connection values for Microsoft SharePoint
      • Microsoft SQL Server
      • Microsoft Teams
        • Connecting from App Connect Enterprise as a Service
      • Microsoft To Do
        • Obtaining connection values for Microsoft To Do
      • Microsoft Viva Engage
      • Milvus
      • monday.com
        • Obtaining connection values for monday.com
      • MySQL
      • Oracle Database
      • Oracle E-Business Suite
        • Connecting to Oracle E-business Suite
      • Oracle Human Capital Management
      • Pinecone Vector Database
        • Obtaining connection values for Pinecone Vector Database
      • PostgreSQL
      • Redis
      • Salesforce
        • Connecting to Salesforce from App Connect Enterprise as a Service
      • Salesforce Account Engagement
      • Salesforce Commerce Cloud Digital Data
      • Salesforce Marketing Cloud
        • Connecting from App Connect Enterprise as a Service
      • SAP (via OData)
        • Creating a well-defined SAP Gateway OData service for use with IBM App Connect
        • Ways of accessing SAP OData metadata information in App Connect
      • SAP (via RFC)
      • SAP Ariba
      • SAP Commerce Cloud
      • SAP SuccessFactors
      • ServiceNow
      • Shopify
        • Obtaining connection values for Shopify
      • Siemens Teamcenter SLM
      • Slack
        • Connecting from App Connect Enterprise as a Service
      • Snowflake
        • Obtaining connection values for Snowflake
      • SOAP web services (imported)
      • Splunk
        • Obtaining connection values for Splunk
      • Square
        • Obtaining connection values for Square
      • SurveyMonkey
      • The Weather Company
        • Obtaining connection values for The Weather Company
      • Toggl Track
        • Obtaining connection values for Toggl Track
      • Trello
      • Twilio
        • Obtaining connection values for Twilio
      • UKG
      • Vespa
        • Obtaining connection values for Vespa
      • WordPress
      • Workday
        • Obtaining connection values for Workday
      • Wrike
        • Obtaining connection values for Wrike
      • Wufoo
        • Obtaining connection values for Wufoo
      • Yapily
        • Obtaining connection values for Yapily
      • Zendesk Service
        • Obtaining connection values for Zendesk Service
      • Zoho Books
        • Obtaining connection values for Zoho Books
      • Zoho CRM
        • Obtaining connection values for Zoho CRM
      • Zoho Inventory
        • Obtaining connection values for Zoho Inventory
      • Zoho Recruit
        • Obtaining connection values for Zoho Recruit
  • Developing connectors with the Connector Development Kit
    • IBM Connector Development Kit
    • Release notes
      • What's new
      • Known issues and limitations
    • Creating a connector
      • Creating a connector by using an OpenAPI doc
      • Creating a connector from scratch
      • Creating a connector using generative AI
      • Connector versioning
        • Defining a connector version
          • Restrictions
          • Criteria for version updates
        • Managing connector versions
          • Managing version in Connector Development Kit
            • Updating major version in Connector Development Kit
            • Updating minor and patch version in Connector Development Kit
          • Managing version in App Connect
            • Adding a major version of the connector in App Connect
            • Adding a minor or patch version of the connector in App Connect
    • Configuring actions
      • Adding a group
      • Adding an action
      • Adding and removing actions for OpenAPI connectors
      • Configuring requests
        • Defining relationships
        • Adding filter parameters
        • Editing filter parameters
        • Removing filter parameters
        • Adding properties
        • Configuring pagination
          • Page
          • Skip and limit
          • Token
        • File size metadata mapping for a download action
        • Defining the request body structure for an upload action
      • Configuring responses
        • Error code mapping
    • Configuring polled events
      • Adding polled event groups and polled events
      • Enabling or disabling polled events
      • Updating polling configuration
        • Adding created timestamp properties
        • Adding updated timestamp properties
        • Created and updated timestamp properties behavior
        • Adding created query template
        • Adding updated query template
    • Configuring connection security
      • Authentication types (security protocols)
      • Adding authentication types and connection properties
      • Validating connections
      • Custom authentication and authentication renewal (refresh)
        • Adding custom authentication steps
        • Adding authentication renewal steps
        • Example: Using custom authentication and authentication renewal (refresh)
    • Configuring schemas
      • Creating schema properties
      • Editing schema properties
      • Deleting schema properties
      • Global parameters
        • Creating a global parameter
        • Editing a global parameter
        • Deleting a global parameter
    • Managing application connections
      • Connecting an application
      • Updating a connection
      • Deleting a connection
    • Testing a connector
      • Testing a download action
      • Testing an upload action
    • Downloading a connector
    • Publishing a connector
    • Glossary
    • Notices
  • Developing integrations in the IBM App Connect Enterprise Toolkit
    • Supported resources in imported BAR files
    • Connecting to TCP/IP-based applications
  • Connecting to a private network
  • Connecting to AWS services with AWS PrivateLink
  • Splitting processing with callable flows
    • Callable flows overview
    • Invoking a callable flow from another flow in App Connect Enterprise as a Service
    • Invoking an App Connect Enterprise callable flow from App Connect Enterprise as a Service
    • Invoking an App Connect Enterprise as a Service callable flow from App Connect Enterprise
• Testing flows during development
• Managing flows during development
• Exporting and importing flows
  • Exporting your API flow as an OpenAPI document
• Deploying integrations
  • Supported resources in imported BAR files
  • Deploying integrations on the flow runs plan
  • Deploying integrations on the VPC plan
    • Updating the version of your integration runtime
  • Providing credentials and secrets in configurations
    • Creating a Policy project configuration
    • Creating a server.conf.yaml configuration
  • Viewing details about deployed integrations
  • Stopping and starting deployed resources
  • Editing a runtime
  • Redeploying flows
  • Viewing certificates for runtimes
  • Testing a deployed integration
• Monitoring and troubleshooting
  • Viewing log messages in the log viewer
  • Viewing log messages in an external log viewer
  • Collecting trace for deployed flows
  • Viewing audit information
  • Replaying recorded messages (record and replay)
  • Troubleshooting private network connectivity
  • Troubleshooting unified authoring in IBM App Connect or IBM API Connect
  • Monitoring resources
• Reference
  • Configuration types
    • Accounts
    • AgentA
    • Agentx
    • BarAuth
    • db2cli.ini
    • Generic files
    • Keystore
    • LoopBack data source
    • mqccdt
    • mqccred.ini
    • odbc.ini
    • Policy project
    • Private network agent
    • REST Admin SSL files
    • server.conf.yaml
    • setdbparms.txt
    • Truststore
    • Truststore certificate
    • Vault
    • Vault archive
    • Vault archive key
    • Vault key
    • WorkdirOverride
  • IP addresses
  • API overview
    • Accessing the API
    • OpenAPI document
  • Understanding your responsibilities
• Notices