SSBH9Y - Documentation Index

Table of Contents

• Welcome
• Getting started with Control Hub
  • What is Control Hub?
  • Pipelines in Control Hub
  • Try IBM StreamSets
    • Build a pipeline
    • Deploy an engine
      • Run a Docker image
      • Download and install from a script
      • Troubleshooting
    • Preview the pipeline
    • Run a job
    • Monitor the job
    • Next steps
  • Supported browsers
  • My Account
    • Customizing table columns
    • Configuring account settings
      • Managing usage statistics collection
    • Configuring browser settings
    • Inviting users
    • Upgrading to a paid subscription
    • Signing out
  • Technology Preview functionality
• Release notes
  • June 24, 2026
  • May 20, 2026
  • April 8, 2026
  • April 3, 2026
  • March 4, 2026
  • February 4, 2026
  • 2025
    • December 10, 2025
    • October 15, 2025
    • October 8, 2025
    • August 20, 2025
    • June 25, 2025
    • May 23, 2025
    • May 21, 2025
    • April 23, 2025
    • March 21, 2025
    • February 19, 2025
    • January 22, 2025
  • 2024
    • December 2024
      • December 13
    • November 2024
      • November 20
      • November 15
    • October 2024
      • October 16
    • September 2024
      • September 25
      • September 18 and 20
    • August 2024
      • August 16, 2024
    • July 2024
      • July 24, 2024
      • July 11, 2024
    • June 2024
      • June 26, 2024
    • May 2024
      • May 22, 2024
    • April 2024
      • April 26, 2024
    • March 2024
      • March 20, 2024
    • February 2024
      • February 21, 2024
      • February 7, 2024
    • January 2024
      • January 24, 2024
      • January 4, 2024
  • 2023
    • December 2023
      • December 20, 2023
    • November 2023
      • November 15, 2023
      • November 1, 2023
    • October 2023
      • October 27, 2023
      • October 6, 2023
    • September 2023
      • September 29, 2023
      • September 27, 2023
    • August 2023
      • August 23, 2023
      • August 18, 2023
    • July 2023
      • July 28, 2023
      • July 21, 2023
    • June 2023
      • June 14 and 21, 2023
    • May 2023
      • May 12, 2023
    • April 2023
      • April 23, 2023
      • April 21, 2023
    • March 2023
      • March 29, 2023
    • February 2023
      • February 10, 2023
      • February 7, 2023
    • January 2023
      • January 20, 2023
  • 2022
    • December 2022
      • December 16, 2022
    • November 2022
      • November 18, 2022
    • October 2022
      • October 28, 2022
      • October 26, 2022
      • October 12, 2022
      • October 6, 2022
      • October 5, 2022
    • August 2022
      • August 26, 2022
    • July 2022
      • July 20, 2022
    • June 2022
      • June 17, 2022
      • June 3, 2022
    • May 2022
      • May 20, 2022
      • May 6, 2022
    • April 2022
      • April 27, 2022
      • April 22, 2022
      • April 13, 2022
      • April 8, 2022
    • March 2022
      • March 18, 2022
    • February 2022
      • February 25, 2022
      • February 23, 2022
      • February 11, 2022
      • February 4, 2022
    • January 2022
      • January 31, 2022
      • January 21, 2022
      • January 14, 2022
  • 2021
    • December 2021
      • December 20, 2021
      • December 8, 2021
    • November 2021
      • November 17, 2021
      • November 5, 2021
    • October 2021
      • October 22, 2021
    • September 2021
      • September 28, 2021
      • September 15, 2021
    • August 2021
      • August 11, 2021
    • July 2021
      • July 30, 2021
      • July 14, 2021 (beta)
    • June 2021
      • June 23, 2021 (beta)
      • June 18, 2021 (beta)
      • June 11, 2021 (beta)
      • June 1, 2021 (beta)
  • Known issues
• IBM StreamSets offerings
  • Comparing offerings
  • IBM StreamSets as a Service
  • IBM StreamSets as client-managed software
    • Installing
      • Installation prerequisites
      • Installing IBM StreamSets on IBM Software Hub
    • Post-installation tasks
      • Verifying user email addresses
      • Granting users access to the service
      • Creating an organization
      • Enabling the Transformer engine
      • Inviting users to the organization
      • Deploying an engine
    • Upgrading
    • Administering organizations
      • Comparing organizations and groups
      • Changing a primary organization administrator
      • Activating or deactivating an organization
      • Enabling projects for an organization
      • Enabling network access rules for an organization
      • Deleting an organization
      • Configuring global organization properties
      • Increasing default system limits
    • Uninstalling
      • Uninstallation prerequisites
      • Deleting the service instance
      • Uninstalling the service
• Set up
  • Firewall configuration
    • Firewall configuration for IBM StreamSets as a Service
      • Browser
      • Engines
        • Inbound connections
        • Outbound connections
    • Firewall configuration for IBM StreamSets as client-managed software
      • Browser
      • Engines
        • Inbound connections
        • Outbound connections
  • Environments
    • Environments overview
    • Feature versions
      • Configuring default feature versions
    • Self-managed environments
      • Feature versions
    • AWS environments
      • Feature versions
        • Required permissions
          • IAM policy for AWS_2023_12_15
          • IAM policy for AWS_2021_06_01
        • Changing to the AWS_2023_12_15 feature version
      • Credential types
      • Prerequisites
        • Create an Amazon VPC
          • Security group
        • Automatic credential type
        • Manual credential types
          • Instance profiles for EC2 instances
            • Create an IAM policy for EC2 instances
            • Use the policy with an instance profile
          • AWS credentials
            • Create an IAM policy
            • Use the policy with a cross-account role
            • Use the policy with access keys
      • Configuring an AWS environment
        • Define the environment
        • Configure AWS credentials
          • Configuring automatic cross-account role
          • Configuring manual cross-account role
          • Configuring manual access keys
        • Select the AWS region
        • Configure the AWS VPC
        • Configure AWS subnets
        • Share the environment
        • Review and activate the environment
    • Azure environments
      • Feature versions
      • Prerequisites
        • Register Azure resource providers
        • Create an Azure VNet
          • Network security group
        • Configure Azure credentials as a prerequisite
          • Register an application and create a service principal
          • Create and assign a custom role to the application
        • Configure managed identities for VM instances
          • Create a managed identity
        • Configure resource groups for VM instances
      • Configuring an Azure environment
        • Define the environment
        • Configure Azure credentials
        • Select the Azure region
        • Configure defaults for Azure VM instances
        • Configure the Azure VNet
        • Configure the Azure subnet
        • Share the environment
        • Review and activate the environment
    • GCP environments (deprecated)
      • Feature versions
      • Prerequisites
        • Designate a project and enable Google APIs
        • Create a Google VPC network
          • Firewall rules
          • Optionally create a Cloud NAT gateway
        • Configure Google Cloud credentials
          • Create a service account
          • Use the service account for impersonation
          • Use the service account key
        • Create instance service accounts for VM instances
      • Configuring a GCP environment
        • Define the environment
        • Configure GCP credentials
        • Configure the GCP project
        • Select the GCP VPC
        • Share the environment
        • Review and activate the environment
    • Kubernetes environments
      • Kubernetes agent
        • Kubernetes agent versions
          • Version 1.5.11
          • Version 1.5.1
          • Version 1.4.0
          • Version 1.3.2
          • Version 1.3.1
          • Version 1.3.0
          • Version 1.2.1
          • Version 1.2.0
          • Version 1.1.2
          • Version 1.1.1
          • Version 1.1.0
          • Version 1.0.0
          • Known issues
        • Resources created for the agent
        • Permissions granted to the agent
      • Feature versions
        • Changing to a later feature version
      • Prerequisites
        • Verify cluster requirements
        • Create a namespace
        • Allow inbound and outbound traffic
        • Configure kubectl
      • Configuring a Kubernetes environment
        • Define the environment
        • Configure the environment
        • Share the environment
        • Review and activate the environment
      • Launching the agent
        • Launching the agent from the installation script
        • Launching the agent from the YAML file
        • Retrieving the installation script
        • Retrieving the YAML file
      • Using a proxy server for Kubernetes
        • Configure the agent to use a proxy server
        • Configure engines to use a proxy server
      • Monitoring the agent
        • Agent status
        • Event logs
        • Accessing Kubernetes log files
        • Modifying the agent log level
        • Deleting an unresponsive agent
      • Upgrading the agent
    • Environment states
    • Environment tags
    • Managing environments
      • Filtering environments
      • Activating environments
      • Deactivating environments
      • Editing environments
      • Viewing deployments in an environment
      • Deleting environments
  • Deployments
    • Deployments overview
      • Engine types
        • Hosted or deployed Transformer for Snowflake engine
      • Engine versions
      • Engine Java version
      • Engine configuration
    • Stage libraries
      • Select from stages
      • Select from stage libraries
      • View the summary
    • Engine advanced configuration
    • External resources
      • External resource types
      • No source
        • Uploading resources from the pipeline canvas
        • Uploading resources from the engine details
        • Removing resources
      • Archive file as the source
        • Archive structure
        • Archive location
          • File system
          • Web server
          • Cloud service
        • Setting up an archive
        • Updating an archive
    • Engine labels
      • Labels and pipeline type
      • Working with multiple labels
      • Editing labels for a deployment
      • Overriding labels for an engine instance
    • Resource thresholds
      • CPU load
      • Memory
      • Number of running pipelines
      • Editing resource thresholds for a deployment
      • Overriding resource thresholds
    • Init script
      • Script requirements
      • Script execution
    • Self-managed deployments
      • Quick start deployment
      • Configuring a self-managed deployment
        • Define the deployment
        • Configure the engine
        • Share the deployment
        • Review and launch the engine
      • Foreground or background process
      • Launching an engine for a deployment
        • Launching a Data Collector Docker image
        • Launching a Data Collector tarball
        • Launching Transformer when Spark runs locally
          • Launching a Docker image when Spark runs locally
          • Launching a tarball when Spark runs locally
        • Launching Transformer when Spark runs on a cluster
          • Launching a Docker image for a Spark cluster
          • Launching a tarball for a Spark cluster
        • Launching a Transformer for Snowflake Docker image
        • Launching a Transformer for Snowflake tarball
        • Retrieving the installation script
        • Running the installation script without prompts
        • Increasing the engine timeout for the installation script
    • Amazon EC2 deployments
      • EC2 instance details
      • Secrets
      • Prerequisites
      • Configuring an Amazon EC2 deployment
        • Define the deployment
        • Configure the engine
        • Configure the EC2 autoscaling group
        • Configure EC2 SSH access
        • Share the deployment
        • Review and launch the deployment
      • Editing an Amazon EC2 deployment
      • Tracking URL
        • Auto scaling group
    • Azure VM deployments
      • VM instance details
      • Secrets
      • Prerequisites
      • Init script for custom DNS servers
      • Configuring an Azure VM deployment
        • Define the deployment
        • Configure the engine
        • Configure Azure VM zones
        • Configure the Azure VM autoscaling group
        • Configure Azure VM SSH access
        • Share the deployment
        • Review and launch the deployment
      • Editing an Azure VM deployment
      • Tracking URL
        • Instances
    • GCE deployments (deprecated)
      • VM instance details
      • Secrets policy
      • Prerequisites
      • Configuring a GCE deployment
        • Define the deployment
        • Configure the engine
        • Configure the GCE region and secrets policy
        • Configure the GCE zone and subnet
        • Configure the GCE autoscaling group
        • Configure GCE SSH access
        • Share the deployment
        • Review and launch the deployment
      • Editing a GCE deployment
      • Tracking URL
        • VM instance template
        • Managed instance group
    • Kubernetes deployments
      • Secrets
      • Prerequisites
      • Autoscaling
        • Full autoscaling (recommended)
        • Legacy autoscaling
      • Configuring a Kubernetes deployment
        • Define the deployment
        • Configure the engine
        • Configure the Kubernetes deployment
        • Share the deployment
        • Review and launch the deployment
      • Advanced mode
      • Editing a Kubernetes deployment
    • Deployment tags
    • Managing deployments
      • Filtering deployments
      • Starting deployments
      • Stopping deployments
        • Forcing a Kubernetes deployment to stop
      • Editing deployments
        • Updating stage libraries
        • Editing engine proxy properties
          • Editing for self-managed deployments
          • Editing for cloud service provider deployments
      • Cloning deployments
        • Same engine version
        • Later engine version
        • Cloning a deployment
          • Configure the deployment
          • Review and launch the deployment
        • Checking a cloned deployment
      • Restarting engines
      • Deleting deployments
    • Monitoring deployments
      • Deployment states
      • Event logs
      • Viewing engines in a deployment
    • Upgrading engines
      • Upgrading engines for self-managed deployments
      • Upgrading engines for Control Hub-managed deployments
    • User-provided stage library mode
      • Prerequisites
        • Display the stage library mode property
        • Download the stage libraries for IBM StreamSets as a Service
        • Download the stage libraries for IBM StreamSets as client-managed software
      • Provide files for self-managed deployments
      • Provide files for cloud service provider deployments
      • Provide files for Kubernetes deployments
    • Troubleshooting
  • Engines
    • Engines overview
      • Engine types and versions
    • Engine communication
      • Websocket tunneling
      • Direct engine REST APIs
        • Enabling HTTPS for engines
          • Prerequisites
          • Create a keystore file
          • Create a truststore file (Transformer only)
          • Configure engines to use HTTPS
        • Ensuring browser access to engines
        • Choosing the communication method
        • Requiring direct engine REST APIs
    • Engine requests to Control Hub
    • Managing engines
      • Restarting engines
      • Balancing jobs on engines
      • Shutting down engines for self-managed deployments
      • Starting engines for self-managed deployments
        • Starting from a tarball installation
          • Starting when using a proxy server
        • Starting from Docker
      • Deleting engines from a self-managed deployment
    • Monitoring engines
      • Performance
      • Pipeline status
      • Unresponsive engines
      • Stopping all draft runs
      • Configuration properties
      • External resources
      • Logs
        • Viewing engine logs
        • Log format
        • Modifying the log level
        • Accessing engine log files
          • Self-managed deployment
          • Amazon EC2 deployment
          • Azure VM deployment
          • GCE deployment
          • Kubernetes deployment
      • Metrics
      • Thread dump
      • Support bundles
        • Generators
        • Generating a support bundle
        • Customizing generators
      • Directories
      • Health inspector
        • Viewing the health inspector
      • Clearing the runhistory folder
  • Connection management
    • Overview
      • Understanding standard and engineless connections
      • Connection requirements
        • Data Collector versions
        • Transformer versions
        • Transformer for Snowflake versions
    • Getting started with connections
      • Create a connection
        • Define the connection
        • Configure the connection
      • Share the connection
      • Use the connection
    • Expressions in connection properties
    • Securing connections
      • Secure connection objects
      • Secure connection values
    • Connection tags
    • Using connections in pipeline fragments
    • Managing connections
      • Filtering connections
      • Testing connections
      • Viewing connection usage
      • Editing connections
      • Duplicating a connection
      • Upgrading a connection
      • Deleting connections
  • Connection types
    • Overview
    • Amazon
      • Amazon EMR Cluster Manager connection
      • Amazon EMR Serverless connection
      • Amazon Kinesis Firehose connection
      • Amazon Kinesis Streams connection
      • Amazon Redshift connection
      • Amazon S3 connection
      • Amazon SQS connection
      • Amazon security
        • Assume another role
          • Assume role methods
          • Create the trust policy
          • Configure connections to assume a role
      • Amazon connection properties
        • Common properties
        • Advanced properties
        • Amazon Redshift properties
        • EMR Cluster Manager properties
        • EMR Serverless properties
    • Azure Blob Storage
      • Prerequisites
      • Azure Blob Storage connection properties
    • Azure Data Lake Storage Gen2
      • Prerequisites
        • Retrieve authentication information
      • Azure Data Lake Storage Gen2 connection properties
    • Azure Synapse
      • Azure Synapse authentication
      • Azure Synapse connection properties
    • Cassandra
      • Cassandra connection properties
    • CoAP Client
      • CoAP Client connection properties
    • Couchbase
      • Couchbase connection properties
    • Databricks Delta Lake
      • Databricks Delta Lake connection properties
    • Elasticsearch
      • Elasticsearch security
      • Elasticsearch connection properties
    • Google Cloud
      • Google BigQuery connection
      • Google Cloud Storage connection
      • Google Pub/Sub connection
      • Google Cloud credentials
        • Default credentials
        • Credentials in a file
        • Credentials in a connection property
      • Google Cloud connection properties
    • Hive
      • Hive connection properties
    • IBM Cloud Object Storage
      • IBM Cloud Object Storage properties
    • IBM Db2
      • IBM Db2 properties
    • IBM watsonx.data
      • IBM watsonx.data properties
    • InfluxDB
      • InfluxDB connection properties
    • InfluxDB 2.x
      • InfluxDB 2.x connection properties
    • JDBC
      • JDBC connection properties
    • JMS
      • JMS connection properties
    • Kafka
      • Kafka connection properties
      • Kafka security
        • Prerequisite tasks
        • SASL authentication credentials
          • Providing plain credentials
          • Providing Kerberos credentials
            • Using a credential store
        • Enabling SSL /TLS encryption
        • Enabling SSL /TLS encryption and authentication
        • Enabling SASL authentication
        • Enabling SASL authentication on SSL /TLS
        • Enabling Confluent Cloud authentication
        • Enabling custom authentication
    • Kudu
      • Kudu connection properties
    • MongoDB Atlas
      • Credentials
      • Enabling SSL /TLS
      • MongoDB Atlas connection properties
    • MQTT
      • MQTT connection properties
    • MySQL
      • MySQL connection properties
    • OPC UA Client
      • OPC UA Client connection properties
    • Oracle
      • Oracle connection properties
    • Orchestrator
      • Orchestrator connection properties
    • PostgreSQL
      • PostgreSQL connection properties
    • RabbitMQ
      • RabbitMQ connection properties
    • Redis
      • Redis connection properties
    • Salesforce
      • Authentication types
      • Changing the API version
      • Salesforce connection properties
    • SFTP/FTP/FTPS
      • Credentials
      • SFTP/FTP/FTPS connection properties
    • Snowflake
      • Snowflake connection
        • Snowflake roles and privileges
        • Using custom roles
        • Snowflake connection properties
      • Snowpipe connection
        • Snowpipe connection properties
    • Splunk
      • Splunk connection properties
    • SQL Server
      • SQL Server connection properties
    • Teradata
      • Teradata connection properties
    • Web Client
      • Web Client connection properties
• Build
  • Fragments
    • Fragments overview
    • Fragment configuration
      • Creating pipeline fragments
        • Using a blank canvas
          • Define the fragment using a blank canvas
          • Configure the fragment using a blank canvas
          • Share the fragment using a blank canvas
        • Using pipeline stages
          • Define the fragment using stages
          • Configure the fragment using stages
          • Share the fragment using stages
          • Publish the fragment using stages
      • Fragment input and output
      • Execution mode
      • Data and data drift rules and alerts
      • Runtime parameters
        • Prefix for runtime parameters
          • Removing a fragment with parameters
        • Using runtime parameters
      • Creating additional streams
      • Data preview
      • Explicit validation
      • Fragment publishing requirements
    • Fragment types and default pipeline labels
    • Using fragments in pipelines
      • Fragment icons
        • Modifying a fragment icon
      • Using fragment versions
      • Stream order
    • Fragments tips and best practices
      • Design best practices
      • Usage tips
    • Managing fragments
  • Pipelines
    • Overview
    • Comparing IBM StreamSets pipelines
    • Authoring engine
      • Accessible engines
      • Changing the authoring engine
      • Stage libraries
      • External libraries
    • Pipeline canvas
      • New pipeline canvas UI
      • Classic pipeline canvas UI
      • Pipeline canvas tips
    • Pipeline labels
      • Deleting pipeline labels
    • Version history
      • Versions
        • Comparing versions
        • Deleting versions
        • Deleting a draft version
      • Tags
        • Creating tags
        • Removing tags
    • Creating a pipeline
      • Define the pipeline
      • Configure the pipeline
      • Share the pipeline
    • Validation
      • Spark for Transformer validation
      • Validating a pipeline
    • Managing pipelines and fragments
      • Duplicating a pipeline or fragment
      • Filtering pipelines and fragments
      • Using sticky notes
      • Starting a draft run of a pipeline
      • Viewing published pipelines and fragments
      • Viewing jobs that include a pipeline
      • Publishing a pipeline
      • Publishing a fragment
      • Deleting pipelines or fragments
    • Previewing pipelines and fragments
      • Preview availability
      • List view
        • Preview codes
      • Table view
      • Preview data types
      • Processor output order
      • Input and output schema for stages
      • Preview for Data Collector
        • Source data
        • Additional information
        • Editing preview data
      • Preview for Transformer
        • Spark for preview
      • Preview for Transformer for Snowflake
        • Providing preview data
      • Writing to destinations and executors
      • Previewing a pipeline or fragment
      • Modifying the preview configuration
      • Editing stage properties
    • Troubleshooting
      • Pipeline and fragment management
      • Preview
  • Sample pipelines
    • Sample pipelines overview
    • Creating user-defined sample pipelines
• Run
  • Job templates
    • Job templates overview
    • Parameters in job templates
      • Dynamic and static parameters
      • Updating job template parameters
    • Job instances created from templates
      • Attached and detached job instances
      • Job instance completion
      • Inherited permissions
      • Suffix for Job Instance Names
      • Parameter values for job instances
    • Job template tags
    • Managing job templates
      • Creating a job template
        • Define the job template
        • Select the pipeline
        • Configure the job details
        • Set parameter defaults
        • Review the job template
      • Filtering job templates
      • Editing job templates
      • Upgrading to the latest pipeline version
      • Duplicating job templates
      • Archiving job templates
      • Deleting job templates
    • Monitoring job templates
      • Running job instances
      • Run history
  • Job instances
    • Job instances overview
    • Number of pipeline instances
      • Scaling out active jobs
      • Rules and guidelines
    • Data Collector pipeline failover
      • Failover and number of pipeline instances
      • Failover retries
      • Determining when to enable failover
      • Configure origin systems for failover
      • Enabling pipeline failover
      • Balancing jobs enabled for failover
        • Balance specific jobs
        • Balance jobs on specific Data Collectors
        • Comparing balance jobs and synchronize jobs
    • Transformer pipeline failover
      • Failover and backup engines
      • Failover requirements
      • Failover retries
      • Enabling pipeline failover
    • Transformer for Snowflake pipeline failover
      • Failover and backup engines
      • Failover retries
      • Enabling pipeline failover
    • Runtime parameters
      • Using functions for parameter values
    • Job tags
    • Managing jobs
      • Creating a job from a pipeline
        • Define the job from a pipeline
        • Select the pipeline
        • Configure the job
        • Define the runtime parameters for the job
        • Review and start the job
      • Creating a job from a job template
        • Define the job from a template
        • Select the job template
        • Define the runtime parameters
        • Review and start the job from a template
      • Starting jobs
      • Filtering jobs
      • Synchronizing jobs
      • Job offsets
        • Origins that maintain offsets
        • Resetting the origin for jobs
        • Uploading an initial offset file
      • Editing the latest pipeline version
      • Upgrading to the latest pipeline version
      • Stopping jobs
        • Forcing a job to stop
      • Scheduling jobs
      • Editing jobs
      • Duplicating jobs
      • Deleting jobs
    • Monitoring jobs
      • Job monitoring UI
        • New job monitoring UI
        • Classic job monitoring UI
        • Job monitoring tabs
      • Job status
        • Pipeline status
        • Pipeline status examples
      • Jobs and unresponsive Data Collector engines
        • Engine gracefully shuts down
        • Engine loses connection
        • Engine unexpectedly shuts down
      • Acknowledging job errors
      • Resetting metrics for jobs
      • Monitoring stage-related errors
      • Logs
        • Viewing the execution engine log
        • Viewing the Spark driver log
      • Cluster and Spark URLs
      • Snapshots
        • Failure snapshots
          • Viewing a failure snapshot
        • Capturing and viewing a snapshot
        • Renaming a snapshot
        • Downloading a snapshot
        • Deleting a snapshot
      • Viewing the job run history
        • Viewing a run summary
    • Troubleshooting
  • Scheduled tasks
    • Scheduled tasks overview
    • Scheduled task types
      • Jobs
        • Batch and streaming jobs
    • Time zone
    • Cron expression
    • Start and end times
    • Missed execution handling
    • Creating scheduled tasks
    • Monitoring scheduled tasks
      • Scheduled task status
      • Viewing runs
      • Viewing the audit
    • Managing scheduled tasks
  • Draft runs
    • Draft runs overview
      • Comparing draft runs with data preview
      • Comparing draft runs with production jobs
    • Engine version requirements
    • Managing draft runs
      • Starting a draft run
      • Filtering draft runs
      • Stopping draft runs
      • Deleting draft runs
    • Monitoring draft runs
  • Sequences
    • Sequences overview
      • Example
    • Parallel jobs
    • Batch and streaming jobs
    • Conditions
      • Sequence start condition
      • Step start condition
      • Step finish condition
        • Scheduled time
        • Cron expression
      • Time zone
    • Managing sequences
      • Creating a sequence
      • Renaming a step
      • Reordering steps
      • Modifying the jobs in a sequence
      • Editing a start or finish condition
      • Manually running a sequence
      • Manually running a step
      • Disabling a sequence
      • Enabling a sequence
      • Deleting sequences
    • Monitoring sequences
      • Sequence status
        • Step status
      • Viewing sequence history
      • Viewing sequence errors
      • Deleting sequence history or errors
    • Troubleshooting
• Monitor
  • Operations dashboard
  • Topologies dashboard
  • Subscriptions
    • Subscriptions overview
    • Enabling events to trigger subscriptions
    • Events
      • Event conditions
      • Advanced expressions
        • Expression completion
        • Example expressions
    • Actions
      • Webhook action
        • Allow Control Hub IP addresses
        • Authentication type
        • Payload
      • Email action
    • Parameters
      • Using parameters in actions
      • Using parameters in event conditions
      • General event parameters
      • Data SLA triggered parameters
      • Execution engine not responding parameters
      • Job status change parameters
      • Max global failover retries exhausted parameters
      • Pipeline committed parameters
      • Pipeline status change parameters
    • Examples
      • Send a message to a Slack channel
      • Call an external API
      • Sending an email
    • Creating subscriptions
    • Troubleshooting
  • Topologies
    • Topologies overview
    • Map jobs in a topology
      • Connect multiple jobs to a single system
      • Create topologies
        • Define the topology
        • Share the topology
        • Review and open the topology
      • Mapping jobs and systems in a topology
      • Auto discover connecting systems
      • Managing jobs from a topology
      • Customizing system icons
    • Measure topology performance
      • Monitor jobs and systems
    • Monitor topologies with data SLAs
      • Creating data SLAs
      • Managing data SLA alerts
    • Auto fix an invalid topology
    • Topology history
    • Renaming a topology
    • Duplicating a topology
    • Deleting topology versions
  • Reports
  • Alerts
• Manage
  • Organization administration
    • Overview
    • Primary organization administrator
      • Changing the primary organization administrator
    • Multiple organizations
    • Leaving an organization
    • Configuring organization properties
    • Organization default system limits
  • Network authentication
    • Restricting engine access by domains
    • Restricting access by IP addresses
  • User authentication
    • User authentication
    • SAML authentication overview
      • Supported identity providers
      • IdP and SP-initiated logins
        • IdP-initiated logins
        • SP-initiated logins
      • Service provider certificates
        • Request and response validation
      • SCIM provisioning of user accounts
        • Default roles for provisioned users
      • IdP attribute mappings
      • Draft and production configurations
    • Enabling SAML using AD FS
      • Step 1. Retrieve IdP information
      • Step 2. Create an AD FS relying party trust
      • Step 3. Set up a draft SAML configuration
      • Step 4. Publish and enable the SAML configuration
    • Enabling SAML using Entra ID
      • Step 1. Retrieve IdP information
      • Step 2. Create an Entra ID application
      • Step 3. Set up a draft SAML configuration
      • Step 4. Publish and enable the SAML configuration
      • Step 5. Configure SCIM provisioning
    • Enabling SAML using Okta
      • Step 1. Retrieve IdP information
      • Step 2. Create an Okta app integration
      • Step 3. Set up a draft SAML configuration
      • Step 4. Publish and enable the SAML configuration
    • Enabling SAML using PingFederate
      • Step 1. Retrieve IdP information
      • Step 2. Create a PingFederate SP connection
      • Step 3. Set up a draft SAML configuration
      • Step 4. Publish and enable the SAML configuration
    • Managing SAML authentication
      • Testing the draft configuration
      • Resetting the draft configuration
      • Publishing the draft configuration
      • Rotating the service provider certificate
      • Enabling the production configuration
      • Disabling the production configuration
      • Logging in when SAML is incorrectly configured
      • Managing provisioned users and groups
    • Troubleshooting
  • Users and groups
    • Overview
    • Managing users and groups
      • Adding users
      • User status
      • Renewing invites
      • Creating groups
      • Adding users to groups
      • Activating or deactivating users
      • Deleting users
    • Roles
      • Role descriptions
      • Common role assignments
    • Permissions
      • Enabling permission enforcement
      • Connection permissions
      • Data SLA permissions
      • Deployment permissions
      • Environment permissions
      • Job permissions
      • Job template permissions
      • Pipeline fragment permissions
      • Pipeline permissions
      • Scheduled task permissions
      • Sequence permissions
      • Subscription permissions
      • Topology permissions
      • Sharing objects
      • Changing the object owner
    • Requirements for common tasks
      • Connection tasks
      • Data SLA tasks
      • Deployment tasks
      • Draft run tasks
      • Engine tasks
      • Environment tasks
      • Job tasks
      • Job template tasks
      • Pipeline fragment tasks
      • Pipeline tasks
      • Scheduled tasks
      • Sequence tasks
      • Subscription tasks
      • Topology tasks
  • Audits
  • API credentials
    • Overview
    • Creating API credentials
      • Define the API credential
      • View the API credential
    • Using credentials to call APIs
    • Regenerating API credentials
    • Activating or deactivating API credentials
    • Renaming API credentials
    • Deleting API credentials
    • Administering API credentials
  • Projects
    • Projects overview
      • Restrictions
    • Administering projects
      • Creating projects
      • Assigning project-level roles
      • Deleting a project
    • Working with projects
    • Troubleshooting projects
  • Export and import
    • Export and import overview
      • Object ID on export
      • Permissions on export
    • Pipeline, fragment, and topology export and import
      • Import objects from a view
      • Import a pipeline version from the pipeline canvas
      • Parent versions
    • Job export and import
    • Objects that use connections
      • Replace connections on import
    • Exporting objects
      • Exporting pipelines
      • Exporting fragments
      • Exporting jobs
      • Exporting topologies
    • Importing objects
      • Importing pipelines
      • Importing a pipeline version from the canvas
      • Importing fragments
      • Importing jobs
      • Importing topologies
• Search
  • Searching for objects
    • Overview
    • Search use cases
    • Defining search conditions
    • Changing the search mode
    • Saved searches
      • Preset searches
      • Starred searches
      • Saving a search
      • Managing saved searches
    • Persisting the last search
    • Reverting to original filtering
  • Basic search
    • Overview
    • Multiple conditions
    • Basic string searches
      • Auto-completion
      • Nested labels and tags
      • Pipeline and fragment versions
        • Search for the latest version
        • Search for a specific version
    • Performing a basic search
  • Advanced search
    • Advanced query language
    • Multiple condition clauses
    • Search properties
      • Pipeline and fragment properties
      • Job template properties
      • Job instance properties
      • Draft run properties
      • Sequence properties
    • Operators
      • Boolean operators
      • Datetime operators
      • Enumerator operators
      • Integer operators
      • String operators
    • Query examples
• Glossary
  • Glossary of terms
• StreamSets Platform SDK