SSC74RW_saas - Documentation Index

Table of Contents

• Welcome
• What's new
• Overview
  • Solution architecture
  • Availability by region
  • Parity across deployments
  • Trial conditions
  • Known limitations
• Getting started
  • Administrators
  • End-to-end monitoring users
  • Federated API management users
  • Integration runtime management users
• Administering
  • Administering access
    • 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
    • Creating user groups
    • Adding users to user groups
    • Roles
  • Administering environments and capabilities
    • Creating the first instance in the IBM SaaS Console
    • Adding and managing capabilities
  • Administering AI settings
  • Configuring private network connections
    • Creating AWS PrivateLink (Inbound) connections
    • Creating AWS PrivateLink (Outbound) connections
    • Creating Azure Private Link (Outbound) connections
  • Administering federated authentication
    • Reference example for configuring Okta as an IdP for IBMid Enterprise Federation
• Managing
  • Managing federated APIs
    • Federated API management overview
    • Connecting Runtimes
      • Connecting IBM webMethods API Gateway
      • Connecting IBM webMethods Developer Portal
      • Connecting Amazon API Gateway
        • AWS agents core implementation logic
        • Co-relation between Amazon API Gateway and federated API management terminologies
        • Deploying the AWS Agent in Docker
          • Authentication for AWS agent implementation
        • AWS Lambda Implementation Overview
          • Deploying AWS agent in AWS Lambda functions
            • Environment variables applicable for Lambda functions
      • Connecting Azure API Management Service
        • Azure agents core implementation logic
        • Co-relation between Azure API Management Service and federated API management terminologies
        • Deploying the Azure Agent in Docker
        • Deploying Java Function in Azure that uses Azure CLI
        • Environment variables applicable for Azure API Management Service
      • Connecting DataPower API Gateway
        • Deploying the DataPower Agent in Docker
      • Connecting Third-party Gateway
    • Managing runtimes
      • Runtimes overview
    • Managing data planes
      • Data planes overview
    • Managing APIs
    • Managing administration APIs
  • Managing integration runtimes
    • Integration runtime management overview
      • Integration runtime management home page
      • Downloading audit logs
      • App Connect runtimes
        • Registering App Connect runtimes
      • webMethods Integration Server runtimes
        • Registering webMethods Integration Server runtimes
      • webMethods Integration runtimes
        • Registering self-managed runtimes
        • Configuring proxy servers by using environment variables
        • Adding replicas to self-managed runtimes
        • Downloading runtime manifest files
        • User-provisioned cloud runtimes
          • Provisioning user-provisioned cloud runtimes
        • Self-managed runtime lifecycle states
        • Adding metadata
        • Managing runtime states
        • Removing unknown runtime instances
        • Regenerating runtime passwords
        • Generating pairing tokens
        • Data retention for webMethods Integration runtimes
        • Self-managed runtime operational requirements
          • Preparing self‑managed runtime setup
        • Managing runtime access permissions
          • Sharing and revoking access to private runtimes
          • Reassigning private runtime ownership
          • Transferring public runtime ownership
        • Configuring runtime security settings
          • Accessing stores and certificates of a runtime
          • Adding new stores
          • Setting up custom stores as default stores
          • Configuring stores for runtimes
  • Managing B2B workspace
    • ​B2B workspace overview
    • Sharing applications in B2B workspace
    • Creating applications in B2B workspace
    • Managing communities in B2B workspace
• Monitoring
  • Monitoring end-to-end transactions
    • Monitoring transactions for failures
    • Observability Agent
      • Monitoring end-to-end transactions with the Observability Agent
    • External observability platform integration
      • Configuring external observability platforms
      • External observability platform configuration reference
    • Viewing transaction data for logged-in tenants
    • Monitoring IBM MQ messages in IBM webMethods Hybrid Integration transactions
    • Getting quick access to transactions with direct links
    • Exporting and importing monitoring assets across environments
    • Hybrid monitoring
      • Setup that uses IBM webMethods Installer
        • IBM webMethods Integration Server
        • IBM webMethods Microservices Runtime
        • IBM webMethods API Gateway
      • Setup that uses Integration Server (IS) package
        • Advantages and supported versions
        • Setup
        • Verification and FAQs
      • Mandatory configuration
        • Setting up webMethods Cloud tenant connection in webMethods Integration Server
        • Setting up what to trace in Integration Server and Microservices Runtime
        • Setting up what to trace in webMethods API Gateway
      • Other configurable options
        • Collector end-points
        • Common configurable properties
        • Configuring a proxy server
        • Troubleshooting
      • With Integration Server through Cloud Container services
        • Hybrid monitoring through Cloud Container
  • Monitoring webMethods Integration runtimes in integration runtime management
    • Viewing the runtime dashboard
    • Changing connections
      • Creating a database connection pool alias
      • Associating a function with database pool alias
    • Resyncing projects
    • Downloading diagnostic data
  • Monitoring federated API management
    • Monitoring overall performance of assets
    • Monitoring performance of data planes
      • Metrics of data planes
    • Monitoring performance of runtimes
      • Metrics of runtimes
    • Monitoring performance of APIs
      • Metrics of APIs
    • Setting display preferences and thresholds
  • Analyzing usage
    • Converting transactions into resource units
  • Tracing transactions in B2B workspace
• Developing
  • Developing agents for federated API management
    • Federated API management agent overview
    • Agent implementation approaches
    • Agent deployment modes
    • Implementing agents for third-party gateways
      • Accessing the Agent SDK
      • Agent SDK interfaces and classes
      • Creating agents by using SDK
      • Building Gradle projects
      • Deploying agents in Docker
  • Using the asset explorer
    • Managing access requests
  • Building workflows with AI from integration descriptions
    • Learn what you can do and get tips for better results
• Troubleshooting
  • Known issues
  • Troubleshooting end-to-end monitoring
• Tutorials
  • Creating a workflow in webMethods Integration by using the AI conversation interface
  • Identifying long-running integrations
  • Managing webMethods Integration Server remotely through the Hybrid Control Plane
  • Using App Connect integrations in webMethods Integration
  • Registering, viewing, managing and monitoring webMethods Integration self-managed runtimes
• Reference
  • Administration APIs in federated API management
  • APIs in integration runtime management
    • Runtime management APIs
    • Runtime management APIs by using configurations
    • Runtime connection APIs
    • Version control APIs
    • Runtime security APIs
    • Runtime configuration APIs
      • Extended settings
      • Global variables
      • JNDI Aliases
      • JMS Aliases
  • Outbound IP addresses
  • Responsibility overview
  • Transaction use cases supported in end-to-end monitoring
  • JSON schema to validate alert payload
• Glossary
• Notices