Integration Hub release notes
Summarize
Summary of Integration Hub release notes
The ServiceNow® Integration Hub in the Australia release enhances Workflow Studio automation by enabling seamless integration between your ServiceNow instance and external systems, including local Kafka environments. This release introduces new capabilities to improve integration management, monitoring, and security, especially for on-premise Kafka integration and Stream Connect enhancements.
Show less
Key Features
- Direct Kafka Integration: Connect your on-premise ServiceNow instance directly to your local Kafka environment by configuring custom Kafka connections, facilitating real-time data exchange.
- Stream Connect Topic Aliases: Simplify topic management by using unique aliases that can map to any Hermes or Direct Kafka topic and be moved across instances, enhancing flexibility.
- OAUTHBEARER Authentication: Support for OAUTHBEARER authentication in Stream Connect message replication aligns with advanced security needs and OAuth capabilities, improving secure Kafka integrations.
- Enhanced Dashboards:
- Stream Connect Dashboard now displays topic aliases and cluster-specific data usage for Hermes and Direct Kafka.
- Remote Process Sync (RPS) Dashboard provides real-time visibility into integration metrics such as processed records, queue sizes, and processing times to aid in performance monitoring and issue identification.
- Message Production via MID Server: Send messages to Hermes directly from MID Server scripts for improved integration workflows.
- Usage Metrics for Direct Kafka: Track data volumes produced and consumed at cluster and topic levels with metrics retained for 13 months, enabling better monitoring and capacity planning.
- Stream Connect Roles and Logs: Introduces a read-only role for view-only access and detailed producer logs with configurable message size display for troubleshooting.
- Alert Threshold Configuration: Set alerts for undelivered and unprocessed messages in Stream Connect to proactively detect message delivery or consumption issues.
- Metadata and Timestamp Access: Access detailed metadata and message timestamps in Stream Connect consumers for enhanced data processing and tracking.
- Remote Process Sync Improvements: Customize error handling with error subflow templates, specify attachment parameters, and implement retry policies for failed requests to increase reliability.
- SASL Authentication for Apache Kafka: Support for SASLSSL and SASLPLAINTEXT protocols with multiple SASL mechanisms (PLAIN, SCRAM-SHA-256, SCRAM-SHA-512) enhances secure Kafka connection options.
Activation and Plugin Information
Integration Hub is included with the Workflow Data Fabric subscription. The Australia release introduces several new plugins that provide core Stream Connect capabilities, Direct Kafka connectivity, Hermes messaging integration, replication certificates handling, and MID Server Hermes API support. These plugins enable comprehensive and secure data integration workflows.
Related Applications and Features
- Workflow Studio: Design and automate processes without coding.
- MID Server: Facilitates data movement between ServiceNow and external systems within your network.
- RPA Hub: Automate repetitive tasks by emulating user actions across applications.
- Connections and Credentials: Manage access credentials for various ServiceNow services and external integrations securely.
This release equips ServiceNow customers with advanced, secure, and flexible integration capabilities, especially for on-premise Kafka environments and Stream Connect management, enabling improved automation, monitoring, and operational efficiency.
The ServiceNow® Integration Hub application extends the ServiceNow® Workflow Studio automation capabilities by enabling you to integrate your instance data with data in external systems. Integration Hub was enhanced and updated in the Australia release.
Integration Hub highlights for the Australia release
- Integrate your on-premise ServiceNow instance with your local Kafka environment with Direct Kafka.
- Simplify topic management in Stream Connect with topic aliases. A topic alias is a unique topic name that can be connected to any underlying Hermes or Direct Kafka topic.
- View detailed statistics and monitor the health of your Integration Hub Remote Process Sync (RPS) integrations with the Remote Process Sync Dashboard.
See Integration Hub for more information.
New in the Australia release
- Use Direct Kafka to integrate your on-premise ServiceNow instance with your local Kafka environment
- Configure a custom Kafka connection to enable your on-premise instance to connect directly to your local Kafka environment.
- Create topic aliases for Stream Connect topics
- Use topic aliases to simplify topic management in Stream Connect. A topic alias is a unique topic name that can be connected to any underlying Hermes or Direct Kafka topic. A topic alias can be moved to different instances and, wherever they’re moved, connected to an underlying topic.
- OAUTHBEARER authentication for Stream Connect message replication
- Authenticate using OAUTHBEARER as part of the SASL credential framework for Stream Connect message replication. OAUTHBEARER authentication lets Stream Connect administrators meet customer requirements, improve security, and align with existing OAuth capabilities on the platform, enabling seamless integration with Kafka environments that require advanced authentication.
- Stream Connect Dashboard updates
-
- The Topics menu displays topic aliases, Hermes topics, and Direct Kafka topics.
- The Data usage tab shows data for the Hermes cluster or the Direct Kafka cluster. Use the Kafka Cluster list to select which cluster data to display.
- The Consumers and Producers menus reference topic aliases instead of Hermes topics.
- View the Remote Process Sync Dashboard
- View detailed statistics and monitor the health of your Remote Process Sync (RPS) integrations. The Remote Process Sync Dashboard provides real-time visibility into key metrics, including records processed, queue sizes, processing times, and system status. Use this dashboard to identify issues, track performance trends, and promote smooth operation of your RPS integrations.
- Produce messages to Hermes via a MID Server
- Send message payloads to Hermes with MID script includes.
- View usage metrics for Direct Kafka
- Track data usage between your instance and Direct Kafka systems. The Direct Kafka Usage metrics table provides administrators with visibility into data transfer volumes for bytes produced and consumed. View metrics aggregated by hour, day, or month at the cluster and topic level. Usage records are automatically retained for 13 months.
- Use the read-only role for Stream Connect
- Use the new read-only role for Stream Connect to grant users view-only access to Stream Connect resources. Users with this role can view Stream Connect configurations and runtime statistics across all related modules, but can’t create, modify, or delete any Stream Connect settings.
- View logs for Stream Connect producers
- Get detailed log information for producers in the Stream Connect logs. Use the glide.ih.kafka.producer.message_bytes_to_log property to specify how much of the message to display in the logs.
- Configure alert thresholds for undelivered messages in Stream Connect
- Set alert thresholds for undelivered messages based on how long a topic has gone without receiving new messages. Use this configuration to trigger INFO, WARNING, or CRITICAL alerts when message delivery stops for a specified period.
- Configure alert thresholds for unprocessed messages in Stream Connect
- Set alert thresholds for messages that remain unprocessed in a topic. You can trigger alerts based on how long messages sit in a topic without being consumed, helping to identify lagging or failing consumers.
- Get metadata information for Stream Connect consumers
- View the partition, offset, datacenter ID, and timestamp epoch for the script consumer and Kafka Message trigger.
- View message timestamps in the Stream Connect script consumer
- Get the message timestamp in the script consumer as a UTC time-zone string. You can use the UTC time-zone string to convert the timestamp to a GlideDateTime object.
- Use an error subflow template to create your own error subflows in Remote Process Sync
- Copy and modify the RPS Error Subflow Template to create error subflows. The template enables you to select notification methods for when the Inbound and Outbound States are errored.
- Specify attachment details in Remote Process Sync actions
- Specify the max attachment size and allowed attachment extensions in the Identify New Attachments action and the Get Attachment Metadata for Local Record action.
- Use a new retry policy for Remote Process Sync actions
- Retry failed requests at specified intervals with the RPS Push Attachment Policy. This policy works with the Identify New Attachments action and the Get Attachment Metadata for Local Record action.
- SASL authentication support for Apache Kafka connections
- Configure SASL authentication for your Apache Kafka connections with support for SASL_SSL and SASL_PLAINTEXT security protocols. Kafka credentials now support multiple SASL mechanisms: PLAIN- SCRAM-SHA-256, SCRAM-SHA-512.
Activation information
Integration Hub is included in Workflow Data Fabric and is available with activation of an Workflow Data Fabric subscription package. For details, see https://www.servicenow.com/now-platform/workflow-data-fabric.html.
Plugin information
- New plugins
-
The following plugins are new in Australia:
- ServiceNow Stream Connect common core (com.glide.hub.stream_connect.common.core): Provides the general Stream Connect capabilities across Hermes and Direct Kafka.
- ServiceNow Stream Connect Direct Kafka (com.glide.hub.stream_connect.direct_kafka): Adds the capability to connect the ServiceNow instance to Apache Kafka directly (not using Hermes Messaging Service).
- ServiceNow Stream Connect Hermes (com.glide.hub.stream_connect.hermes): Adds the capability for Stream Connect to connect to the Hermes Messaging Service.
- ServiceNow Stream Connect Installer (Direct Kafka) (com.glide.hub.stream_connect.onprem_installer): The installer that installs the required plugins for Direct Kafka.
- ServiceNow Stream Connect Kafka Connection (com.glide.hub.stream_connect.kafka_connection): Adds the ability to use Kafka credentials for Direct Kafka and Message Replication.
- ServiceNow Stream Connect Replication Certificates (com.sn_stream_connect.replication.cert): Adds the capability to handle certificates to connect to the Hermes Messaging Service from the MID Server.
- ServiceNow Stream Connect Replication Core (com.glide.hub.stream_connect.replication.core): Adds capabilities to replicate data between a topic in the Hermes Messaging Service and a topic in a local Apache Kafka environment.
- Stream Connect MID Hermes API (com.glide.mid.hermes_api): Provides the capability to produce messages from the MID Server to a topic in the Hermes Messaging Service.