•  webMethods CloudStreams Documentation
  •  About this Documentation
    • Document Conventions
    • Online Information and Support
    • Data Protection
  •  Administering webMethods CloudStreams
    •  Overview
      •  About CloudStreams
        • CloudStreams Components
        • SOAP/REST Outbound Architecture
        • SOAP/REST Inbound Architecture
        • Streaming Architecture
        •  Virtual Services and Connector Virtual Services
          • The Processing Steps of Virtual Services
          • The Processing Steps of Connector Virtual Services
        •  Policies for Virtual Services and Connector Virtual Services
          • Policies for Virtual Services
          • Policies for Connector Virtual Services
        •  The CloudStreams Analytics Dashboard
          • The Run-Time Events
          • The Key Performance Indicator (KPI) Metrics
      • Getting Started with CloudStreams
    •  CloudStreams Configuration Options
      • Overview
      •  The Administration Options
        • Setting the General Options
        • Setting the E-mail Options for Logging Payloads and Sending Performance Monitoring Alerts
        •  Setting the Database Options for Publishing Performance Metrics and Events
          • The Intervals for Metric Publishing
        • The Virtual Services Option
        • Setting the STS Options
        • Setting the Service Fault Configuration Options
        • Setting the Consumers Options
        • Setting the OAuth Tokens Options
      • The Providers Options
      •  The Streaming Options
        • Setting the Streaming Providers Options
        •  Setting the Streaming Subscribers Options
          •  Creating an ESB Service as a Streaming Subscriber Destination
            • ESB Services for the Client Type of Comet
            • ESB Services for the Client Type of HTTP
          • Streaming subscriber behavior in case of an error
      • Connection Options
    •  Virtual Services
      •  Overview
        • Define a CloudStreams Server Target
        • Create a CloudStreams Governance Project
        •  Create the Virtual Services
          • The Processing Steps of a Virtual Service
          • The Processing Steps of a Connector Virtual Service
        • Create Policies for the Virtual Services
        • Policies for Connector Virtual Services
      • Defining and Managing a CloudStreams Server Target
      • Creating a CloudStreams Governance Project
      •  Creating a New Virtual Service (SOAP)
        •  The Properties of a Virtual Service (SOAP)
          • Managing a Virtual Service (SOAP)
        •  The In Sequence Step (SOAP)
          • The Entry Step (SOAP)
          • The Transform Step (Inbound, SOAP)
          • The Invoke IS Service Step (Inbound, SOAP)
          •  The Routing Rule Step for HTTP or HTTPS (SOAP)
            • The Straight Through Routing Rule Step (SOAP)
            • The Context-Based Routing Rule Step (SOAP)
            • The Content-Based Routing Rule Step (SOAP)
            • The Load Balancing Routing Rule Step (SOAP)
        •  The Out Sequence Step (SOAP)
          • The Transform Step (Outbound, SOAP)
          • The Invoke IS Service Step (Outbound, SOAP)
        •  The Error Sequence Step (SOAP)
          • The Fault Handler Variables
        •  IS Service Constructs
          •  Using the Security API in IS Services
            • pub.cloudstreams.security.ws.AddUserNameToken
            • pub.cloudstreams.security.ws.AddX509Token
            • pub.cloudstreams.security.ws.AddSamlSenderVouchesToken
            • pub.cloudstreams.security.ws.AddTimestamp
            • pub.cloudstreams.security.ws.AddWSAddressingHeaders
          •  Using Context Variables in IS Services
            • The Predefined Context Variables
            • The API for Context Variables
      •  Creating a New Connector Virtual Service (SOAP)
        •  The Properties of a Connector Virtual Service (SOAP)
          • Managing a Connector Virtual Service (SOAP)
        •  The In Sequence Step (Connector Virtual Service, SOAP)
          • The Entry Step (Connector Virtual Service, SOAP)
          • The Routing Rule Step (Connector Virtual Service, SOAP)
          • The Invoke IS Service Step (Inbound, Connector Virtual Service, SOAP)
        • The Out Sequence Step (Connector Virtual Service, SOAP)
        • The Error Sequence Step (Connector Virtual Service, SOAP)
      •  Creating a New Virtual Service (REST)
        •  The Properties of a Virtual Service (REST)
          • Managing a Virtual Service (REST)
        •  The In Sequence Step (REST)
          • The Entry Step (REST)
          • The Transform Step (Inbound, REST)
          • The Invoke IS Service Step (Inbound, REST)
          •  The Routing Rule Step (REST)
            • The Straight Through Routing Rule Step (REST)
            • The Context-Based Routing Rule Step (REST)
            • The Content-Based Routing Step (REST)
            • The Load Balancing Routing Rule Step (REST)
        •  The Out Sequence Step (REST)
          • The Transform Step (Outbound, REST)
          • The Invoke IS Service Step (Outbound, REST)
        • The Error Sequence Step (REST)
      •  Creating a New Connector Virtual Service (REST)
        •  The Properties of a Connector Virtual Service (REST)
          • Managing a Connector Virtual Service (REST)
        •  The In Sequence Step (Connector Virtual Service, REST)
          • The Entry Step (Connector Virtual Service, REST)
          • The Routing Rule Step (Connector Virtual Service, REST)
          • The Invoke IS Service Step (Inbound, Connector Virtual Service, REST)
        • The Out Sequence Step (Connector Virtual Service, REST)
        • The Error Sequence Step (Connector Virtual Service, REST)
      •  Important Considerations for REST Virtual Services
        • HTTP Method/Content-Type Combinations
        •  Changing the HTTP Method of a REST Virtual Service
          • Implications of Changing HTTP Methods
          • Changing HTTP Methods in Requests Dynamically Using a Context Variable
          • Sample XSLT Transformation for GET-to-POST or GET-to-PUT
    •  Policies
      •  Overview of Policies
        •  Policies for Virtual Services
          • WS-SecurityPolicy 1.2 Actions
          • Monitoring Actions
          • Additional Actions
        • Policies for Connector Virtual Services
      • Creating Policies
      • Modifying Policies
      •  The Policy Actions
        • Action Evaluation Order and Dependencies
        •  Usage Cases for Identifying/Authenticating Consumers
          • Multiple Security Elements in Requests/Responses
        •  The Policy Action Reference
          • Authorize User
          • Identify Consumer
          • Include Timestamps
          • Log Invocation
          • Monitor Service Performance
          • Monitor Service Level Agreement (SLA)
          • Require Encryption
          • Require HTTP Basic Authentication
          •  Require SAML Token
            • To Identify a Trusted STS to Integration Server
          • Require Signing
          • Require SSL
          • Require WSS Username Token
          • Require X.509 Token
          • Throttling Traffic Optimization
          • Validate Schema
    •  Deploying Virtual Services and Connector Virtual Services
      • Overview of Deployment
      • Before You Deploy Virtual Services or Connector Virtual Services
      • Deploying All Services in a CloudStreams Governance Project
      • Deploying a Single Service
      • Undeploying Services
      •  What Happens When You Deploy a Service?
        • Policy Validation
        • Policy Conflict Resolution Rules
        • What if You Need to Modify Deployed Services?
    •  Cloud Connections, Services, and Connector Listeners
      • CloudStreams Provider
      • CloudStreams Connector
      • Cloud Connection
      • Cloud Connector Service
      • Working with Connector Listeners
      • Replaying Salesforce events
      • Detection and processing of duplicate Salesforce events
      • Persistent configuration of events for duplicate detection
      • Persistent configuration of last received Replay IDs
      • Configuring Error Recovery and Callback information for Salesforce
      • Managing Cloud Connectors
      • Managing Cloud Connector Packages
      • Using inline connection details while running a cloud connector service
      • Support for multiple authentication schemes in a single connector
      • Generating OAuth 2.0 Tokens while configuring connections
      • Multipart/form-data content type
      • Message Transmission Optimization Mechanism (MTOM)
      • Service signatures having complex nested document structures
      • Multiple root JSON data format with anonymous collection
      •  REST Parameters
        •  Parameter Types
          • URI_CONTEXT
          • QUERYSTRING_PARAM
          • CFG_PARAM
          • FORM_ENCODED_PARAM
        •  Parameter Data Types
          • String
          • Record
        •  Parameter Formatters for REST Connector Services
          • Using the Default Parameter Formatter
          • Implementing a Custom Parameter Formatter
      • Viewing the Constraints Applied to Variables
      • Server Name Indication (SNI) Support
    •  Clustering
      • Clustering support for connector listeners
    •  Using CloudStreams Configuration Variables Templates with webMethods Microservices Runtime
      • Overview
      • Configuration Variables Template
      • Configuration Variables Template Assets
    •  Deploying Assets using webMethods Deployer
      • Overview
      • Building Assets
      • Deploying assets to other servers
    •  CloudStreams Analytics
      •  Overview
        • The Run-Time Events
        • The Key Performance Indicator (KPI) Metrics
      •  Installation and Configuration Tasks
        • Creating the Schema and Tables Required by CloudStreams Analytics
        •  Creating a JDBC Connection Pool for CloudStreams
          • SQL Statement Execution and Connection Timeouts
          • Installing and Starting MashZone NextGen Server
          • Copying the Resource Files for CloudStreams Analytics
          • Configuring the Data Feed
          • Configuring the record limit for Transaction and Event tables
          • Importing the CloudStreams Analytics Dashboard
      • Setting the Publishing Options for Performance Metrics and Events
      •  Using the CloudStreams Analytics Dashboard
        • Performance Summary
        • API Usage
        • Performance Trends
        • Error Trends
        • Transaction
        • Event
    •  CloudStreams API Reference
      • Overview
    •  Admin Folder
      • Summary of Elements in this Folder
      • pub.cloudstreams.admin.connection:disableConnection
      • pub.cloudstreams.admin.connection:enableConnection
      • pub.cloudstreams.admin.connection:getConnectionStatistics
      • pub.cloudstreams.admin.connection:queryConnectionState
      • pub.cloudstreams.admin.listener:disable
      • pub.cloudstreams.admin.listener:enable
      • pub.cloudstreams.admin.listener:queryListenerState
      • pub.cloudstreams.admin.listener:listEnabledListeners
      • pub.cloudstreams.admin.listener:update
      • pub.cloudstreams.admin.service:update
      • pub.cloudstreams.admin.service:batchUpdate
      • pub.cloudstreams.upgrade:batchUpgrade
    •  Advanced Settings
      • Introduction
      • pg.backupFailedProxies
      • pg.CollectionPool.
      • pg.CollectionWorkQueue.
      • pg.debug.
      • pg.delayedRefresher.
      • pg.ehcache.config.
      • pg.email.
      • pg.endpoint.
      • pg.failedProxies.
      • pg.http.
      • pg.IntervalPool.
      • pg.jaxbFileStore.
      • pg.jdbc.
      • pg.keystore.
      • pg.lb.
      • pg.passman.
      • pg.PgMenConfiguration.
      • pg.PgMenSharedCacheManager.
      • pg.PgMetricsFormatter.
      • pg.policygateway.
      • pg.proxyLoader
      • pg.rampartdeploymenthandler.
      • pg.ReportingPool.
      • pg.ReportingWorkQueue.
      • pg.serviceReader.
      • wst.cloudConnectorService.
      • wst.connfactory.
      • wst.default.tenant.
      • wst.product.
      • wst.largedata.
  •  webMethods CloudStreams Development
    •  CloudStreams Governance Project
      • Governance Project Wizard
      •  CloudStreams Servers Dialog Boxes
        • CloudStreams Servers Dialog Box
        • Add CloudStreams Servers Dialog Box
      •  Connector Virtual Services (SOAP)
        • New Connector Virtual Service Wizard (SOAP)
        • General Properties View (SOAP Connector Virtual Service)
        • Advanced Properties View (SOAP Connector Virtual Service)
        • Entry Step (SOAP Connector Virtual Service)
        • Routing Rule Step (SOAP Connector Virtual Service)
        • Invoke IS Service Step (Inbound, SOAP Connector Virtual Service)
        • Invoke IS Service Step (Outbound, SOAP Connector Virtual Service)
        • Error Messaging Step (SOAP Connector Virtual Service)
      •  Connector Virtual Services (REST)
        • New Connector Virtual Service Wizard (REST)
        • General Properties View (REST Connector Virtual Service)
        • Advanced Properties View (REST Connector Virtual Service)
        • Entry Step (REST Connector Virtual Service)
        • Routing Rule Step (REST Connector Virtual Service)
        • Invoke IS Service Step (Inbound, REST Connector Virtual Service)
        • Invoke IS Service Step (Outbound, REST Connector Virtual Service)
        • Error Messaging Step (REST Connector Virtual Service)
      •  Policies
        • Create a New Policy Wizard
        • General Properties View (Policy)
        • Action: Authorize User
        • Action: Identify Consumer
        • Action: Include Timestamps
        • Action: Log Invocation
        • Action: Monitor Service Performance
        • Action: Monitor Service Level Agreement (SLA)
        • Action: Require Encryption
        • Action: Require HTTP Basic Authentication
        • Action: Require SAML Token
        • Action: Require Signing
        • Action: Require SSL
        • Action: Require WSS Username
        • Action: Require X.509 Token
        • Action: Throttling Traffic Optimization
        • Action: Validate Schema
      •  Virtual Services (SOAP)
        • New Virtual Service Wizard (SOAP)
        • General Properties (SOAP Virtual Service)
        • Advanced Properties (SOAP Virtual Service)
        • Virtual Service Namespaces Dialog Box (SOAP Virtual Service)
        • VSD Dialog Box (SOAP Virtual Service)
        • Applicable Policies Dialog Box (SOAP Virtual Service)
        • Endpoint Dialog Box (SOAP Virtual Service)
        • Entry Step (SOAP Virtual Service)
        •  Transform Step (SOAP Virtual Service)
          • Transform Step (Inbound, SOAP Virtual Service)
        • Invoke IS Service Step (Inbound, SOAP Virtual Service)
        • Routing Rule Step (Straight Through Routing, SOAP Virtual Service)
        • Routing Rule Step (Context-Based Routing, SOAP Virtual Service)
        • Routing Rule Step (Content-Based Routing, SOAP Virtual Service)
        • Routing Rule Step (Load Balancing Routing, SOAP Virtual Service)
        • Attach WSDL Dialog Box (SOAP Virtual Service)
        • Transform Step (Outbound, SOAP Virtual Service)
        • Invoke IS Service Step (Outbound, SOAP Virtual Service)
        • Error Messaging Step (SOAP Virtual Service)
      •  Virtual Services (REST)
        • New Virtual Service Wizard (REST)
        • REST Resources Wizard
        • General Properties (REST Virtual Service)
        • Advanced Properties View (REST Virtual Service)
        • Virtual Service Namespaces Dialog Box (REST Virtual Service)
        • VSD Dialog Box (REST Virtual Service)
        • Applicable Policies Dialog Box (REST Virtual Service)
        • Endpoint Dialog Box (REST Virtual Service)
        • Entry Step (REST Virtual Service)
        •  Transform Step (REST Virtual Service)
          • Transform Step (Inbound, REST Virtual Service)
        • Invoke IS Service Step (Inbound, REST Virtual Service)
        • Routing Rule Step (Straight Through Routing, REST Virtual Service)
        • Routing Rule Step (Context-Based Routing, REST Virtual Service)
        • Routing Rule Step (Content-Based Routing, REST Virtual Service)
        • Routing Rule Step (Load Balancing Routing, REST Virtual Service)
        • Transform Step (Outbound, REST Virtual Service)
        • Invoke IS Service Step (Outbound, REST Virtual Service)
        • Error Messaging Step (REST Virtual Service)
      • Deploy
    •  CloudStreams Provider Project
      • Creating a Provider Project
      • CloudStreams Connector
      • Creating a Connector
      • Updating a Connector by importing a new Swagger or OpenAPI specification file (REST only)
      • Connector Overview-General Information
      •  Editing the Connection Properties
        • Adding Properties
        • Editing Properties
        • Removing Properties
        • Start and Stop Sequences for REST-based providers
        • Start and Stop Sequences for SOAP-based providers
      • Configuring References
      •  Creating and Renaming Resource Groups
        • Configuring Assignments in Resource Groups
      •  REST Connector
        • Creating a REST Resource
        • Creating a Resource Request Parameter
        • Creating a Resource Request Header
        • Adding a Resource Request Body
        • Changing the Sequence of Local Assignments
        • Creating a Resource Response Header
        • Adding a Resource Response Body
        • Handling JSON representations of REST resources
      •  SOAP Connector
        • Creating a SOAP Request Parameter
        • SOAP Request Header
        • SOAP Request Body
        • Changing the Sequence of Local Assignments
        • SOAP Response Header
        • SOAP Response Body
      • Moving and Copying Elements
      •  Advanced Configurations
        •  Assigning Values
          • Assigning Values from a Service
        • Abstract Object Definition
        • Parameter Data Types and Formatters
      • Importing Provider Packages
      • Exporting Provider Packages
      • Publishing and Unpublishing Providers
• Copyright

webMethods CloudStreams Documentation

Copyright

Cloud_Project_ProjectScrn

Cloud_Servers_ServersScrn

Cloud_Servers_AddServersScrn

Cloud_CVSS_NewServiceScrn

Cloud_CVSS_GeneralScrn

Cloud_CVSS_AdvancedScrn

Cloud_CVSS_EntryScrn

Cloud_CVSS_RoutingScrn

Cloud_CVSS_InvokeIS_In_Scrn

Cloud_CVSS_InvokeIS_Out_Scrn

Cloud_CVSS_CustomErrorScrn

Cloud_CVSR_NewServiceScrn

Cloud_CVSR_GeneralScrn

Cloud_CVSR_AdvancedScrn

Cloud_CVSR_EntryScrn

Cloud_CVSR_RoutingScrn

Cloud_CVSR_InvokeIS_In_Scrn

Cloud_CVSR_InvokeIS_Out_Scrn

Cloud_CVSR_CustomErrorScrn

Cloud_Policy_NewPolicyScrn

Cloud_Policy_GeneralScrn

Cloud_Policy_AuthorizeScrn

Cloud_Policy_IdentifyScrn

Cloud_Policy_TimestampsScrn

Cloud_Policy_LogScrn

Cloud_Policy_PerformanceScrn

Cloud_Policy_SLAScrn

Cloud_Policy_EncryptScrn

Cloud_Policy_HTTPAuthScrn

Cloud_Policy_SAMLTokenScrn

Cloud_Policy_SigningScrn

Cloud_Policy_SSLScrn

Cloud_Policy_UsernameToken

Cloud_Policy_509TokenScrn

Cloud_Policy_ThrottlingScrn

Cloud_Policy_SchemaScrn

Cloud_VSS_NewServiceScrn

Cloud_VSS_GeneralScrn

Cloud_VSS_AdvancedScrn

Cloud_VSS_NamespacesScrn

Cloud_VSS_VSDScrn

Cloud_VSS_ApplicablePoliciesScrn

Cloud_VSS_EndpointScrn

Cloud_VSS_EntryScrn

Cloud_VSS_Transform_In_Scrn

Cloud_VSS_InvokeIS_In_Scrn

Cloud_VSS_StraightScrn

Cloud_VSS_ContextScrn

Cloud_VSS_ContentScrn

Cloud_VSS_LoadScrn

Cloud_VSS_AttachWSDLScrn

Cloud_VSS_Transform_Out_Scrn

Cloud_VSS_InvokeIS_Out_Scrn

Cloud_VSS_CustomErrorScrn

Cloud_VSR_NewServiceScrn

Cloud_VSR_RESTResourcesScrn

Cloud_VSR_GeneralScrn

Cloud_VSR_AdvancedScrn

Cloud_VSR_NamespacesScrn

Cloud_VSR_VSDScrn

Cloud_VSR_ApplicablePoliciesScrn

Cloud_VSR_EndpointScrn

Cloud_VSR_EntryScrn

Cloud_VSR_Transform_In_Scrn

Cloud_VSR_InvokeIS_In_Scrn

Cloud_VSR_StraightScrn

Cloud_VSR_ContextScrn

Cloud_VSR_ContentScrn

Cloud_VSR_LoadScrn

Cloud_VSR_Transform_Out_Scrn

Cloud_VSR_InvokeIS_Out_Scrn

Cloud_VSR_CustomErrorScrn

Cloud_Deploy_DeployScrn

CustomConnector_ProviderProjectScrn

CloudStreamsConnector_Intro

CustomConnector_NewConnectorScrn

Update_Connector

CustomConnector_OverviewScrn

ConnectionConfig_AuthenScrn

add_connauth_property

edit_connauth_property

remove_connauth_property

startstop_sequence_rest

startstop_sequence_soap

CustomConnector_ConfigureReferences

CustomConnector_NewResourceGroupScrn

configureassignment_resourcegroups

create_rest_resource

add_resource_request_parameter

create_resource_request_header

add_resource_request_body

rest_resource_request_assignment_order

create_resource_response_header

add_resource_response_body

CustomConnector_ExcludeRoot

add_soap_request_parameter

soap_request_header

soap_request_body

soap_request_assignment_order

soap_response_header

soap_response_body

cut_copy_paste

CustomConnector_AssignScrnREST

CustomConnector_AbstractObjects

parameter_datatypes_formatters

CustomConnector_ImportPackages

CustomConnector_ExportPackages

CustomConnector_PublishProviders