logo
TIBCO® API Exchange Gateway

Contents

  • Installation
    • Important Information
    • TIBCO Documentation and Support Services
    • Installation Overview
      • Installation Requirements
        • Prerequisites for Installation
        • Guidelines for TIBCO API Exchange Gateway Installation
        • Disk Space Requirements for Installer
          • Temporary Disk Space Required by the Installer
          • Starting the Installer
          • Disk Space Requirement in Product Home Directory
          • Disk Space After Installation
        • System Memory Requirements for the Installer
        • Supported Platforms
      • TIBCO API Exchange Gateway Software Requirements
      • Installation Modes
        • GUI Mode
        • Console Mode
        • Silent Mode
      • Installation Types
      • Installer Account
      • Windowing Environment
      • Permissions
      • Installer Log File
    • Installing TIBCO API Exchange Gateway
      • Windows Installation Guidelines
        • Installer Account
        • Installing from a Network Drive
        • Installing on Windows 2000 Terminal Server
      • UNIX Installation Guidelines
        • Installer Account
        • Permissions
      • Installation
        • Installation Modes
          • GUI Mode
          • Console Mode
          • Silent Mode
        • Installing in GUI Mode
        • Installing in Console Mode
          • Prerequisites
        • Installing in Silent Mode
      • Verifying the Installation
        • Checking the Installer Log File
        • Checking the TIBCO API Exchange Gateway Server Status
        • Core Engine
          • Running the Core Engine on Windows Platform
          • Running the Core Engine on UNIX Platform
          • Testing Ping Operation using Native HTTP Channel
        • Apache HTTP Server (Optional)
          • Running Apache HTTP Server on Windows Platform (Optional)
          • Running Apache HTTP Server on UNIX Platform (Optional)
          • Testing Ping Operation Using RV Transport
      • Verifying the RVRD License File Installation (Optional)
    • Install and Run Gateway Components as Windows Services
      • Start a Command Prompt as an Administrator
      • Installing and Running the Config UI Server as a Windows Service
      • Installing and Running the Core Engine as a Windows Service
      • Installing and Running the Central Logger as a Windows Service
      • Installing and Running the Global Throttle Manager as a Windows Service
      • Installing and Running the Cache Agent as a Windows Service
      • Installing and Running the Cache Cleanup Agent as a Windows Service
    • Post Installation Tasks
      • Prerequisites
      • Setting the System Environment Variables
      • Installing and Configuring Apache HTTP Server (Optional)
        • Installing Apache HTTP Server
        • Installing Apache HTTP Server on Windows 64-bit Platform
        • Installing Apache HTTP Server on UNIX Platform
        • Configuring Apache HTTP Server for TIBCO API Exchange Gateway
      • Configuring TIBCO Enterprise Message Service (Optional)
    • Uninstalling Software
      • Uninstalling in GUI Mode
      • Uninstalling in Console Mode
  • User's Guide
    • Important Information
    • Editing asg_core.cdd File
    • Editing asg_cl.cdd File
    • Editing Properties Files
    • TIBCO Documentation and Support Services
    • Changes from the Previous Release of this Guide
    • Introduction to TIBCO API Exchange Gateway
      • Design-time Components
        • Config UI
        • Studio
      • Runtime Components
        • Gateway Operational Layer
        • Gateway Management Layer
      • Deployment Architecture
        • Single Server Deployment Architecture
        • Distributed Deployment Architecture
    • Getting Started
      • Examples Overview
        • Examples
      • Configure an Endpoint Operation for TIBCO API Exchange Gateway
        • Creating a New Configuration
        • Configuring Partner Group
        • Configuring Partner Data
        • Configuring a Facade Operation
        • Configuring a Target Operation
        • Configuring an Authorization Configuration
        • Configuring Routing Configuration
        • Saving the Gateway Configuration
        • Testing the Gateway configuration
          • Running Apache HTTP Server if not running
          • Running Core Engine
          • Testing the Configured Operation and Target Operation
      • Working with Studio
        • Starting Studio
        • Loading the Default ASG_DefaultImplementation Project
        • Editing Validating and Building the Default ASG_DefaultImplementation Project
          • Adding or Edit a Resource in a Project
          • Validating a Project, Project Folder or Project Resource
          • Fixing Validation Errors
          • Building the Default ASG_DefaultImplementation Project
          • Debugging Project in Studio
          • Setting the Debug Perspective within Studio
      • Validation Tool (asg-validate)
        • Running asg-validate Using asg-tools
        • Log File for asg-validate
        • Limitations of asg-validate
      • Runtime Properties
        • Runtime Properties of Core Engine
        • Runtime Properties of Central Logger
      • Building an EAR File at the Command Line
    • Core Engine Configuration
      • Core Engine
        • Starting Core Engine
        • Processing Units of Core Engine
        • Configure Log Files Settings
          • Log File Name and Location
          • Number and Size of Log Files
          • Setting the Log File Configuration Settings in a CDD File
        • Logging Levels of Core Engine
    • Apache Module for TIBCO API Exchange Gateway
      • Installing Apache HTTP Server
        • Installing Apache HTTP Server with SSL
      • Configuring Apache HTTP Server Using HTTP Transport
        • On the Windows Platform
        • Configuration On the UNIX Platform
      • Running the Apache HTTP Server
        • On the Windows Platform
        • Running On the UNIX Platform
      • Secure Communications
        • Mutual SSL Authentication
          • Generate Keys and Certificates
          • Configure SSL on Apache HTTP Server
          • Configure Client Authentication with Digital Certificates on Apache HTTP Server
          • Configure Client Certificate Identification Details On Apache HTTP Server
          • Register Partners on Config UI
        • SSL Communications Configuration
          • Configuring One-Way SSL Authentication
          • Mutual SSL Authentication Configuration
            • Prerequisites for Mutual SSL Setup
            • Configuring Mutual SSL on Apache HTTP Server
            • Configuring Client Authentication with Digital Certificates on Apache HTTP Server
            • Using Firefox
            • Using Internet Explorer
            • Testing the Imported Certificate
            • Forwarding Client Certificate Identification Details on Apache HTTP Server to Core Engine
            • Registering Partners Using the Config UI
        • Configure the Apache Server for Basic HTTP Authentication
          • Configuring Apache HTTP Server for Basic Authentication
            • Enabling Basic Authentication on Apache HTTP Server
            • Creating a Password File for the Apache HTTP Server
            • Reloading the Configuration File for the Apache HTTP Server
            • On the UNIX Platform
          • Configuring a Client (Requester) for Basic Authentication (Example Use Case)
            • Configuring the Endpoint URL for Transport
            • Creating an Identity Resource
            • Configuring Identity For Transport
          • Configuring TIBCO API Exchange Gateway for Basic Authentication
        • Configure Apache Module for RVRD Setup through a Firewall (DMZ)
          • Setting up TIBCO API Exchange Gateway in a DMZ Environment
        • Configure Apache HTTP Server as Reverse Proxy
          • Directives
          • Setting up Reverse Proxy Server for Non-SSL Communication
          • Setting up Reverse Proxy Server for SSL Communication
    • Transport Communication
      • Facade Operation Requests
      • Central Logger
      • Global Throttle Manager
      • Rendezvous Transport Communication
        • Enabling Rendezvous Communication for TIBCO API Exchange Gateway
          • Backup Files
          • Editing asg_core.cdd File
          • Editing asg_cl.cdd File
          • Setting tibco.env.RV_HOME Property in TRA Files
          • Editing Properties Files
        • Configuration Setup
        • Setting Rendezvous Transport Properties
          • Rendezvous Session Connection Parameters for Apache Module
          • Rendezvous Session Connection Parameters for Core Engine
          • Rendezvous Session Connection Parameters For Core Engine and Central Logger Communication
          • Rendezvous Session Connection Parameters for Core Engine and Global Throttle Manager Communication
        • Secure Deployments with TIBCO Rendezvous
        • Configuration for Secure Rendezvous Daemon
          • Configuration Tips
          • Setup and Configure Rendezvous Daemons
          • Configuration Setup for Apache Module and TIBCO API Exchange Gateway
            • Install Apache Server
            • Install TIBCO API Exchange Gateway
            • Setting up and Configuring Apache Module
              • Setting up Apache Module on Machine 1
              • Configuring Apache Module on Machine 1
              • Sample Properties For Apache Module
              • Configuring the Core Engine Properties
              • Sample Properties for Core Engine
            • asg-password-obfuscator Utility
      • Enabling Facade HTTP Transport
      • Enable Facade HTTPS Transport
        • Setting SSL Properties
        • Download Tomcat Native Library
          • Downloading on Windows platform
          • Downloading on Linux platform
          • Downloading and Building APR
          • Building Tomcat Native Library
          • Setting LD_LIBPARY_PATH
      • Setting Content-Type for Error Response
        • Endpoint Ports
      • JMS Transport Communication
        • SOAP JMS Transport
          • Gateway as SOAP JMS Server
          • Gateway as SOAP JMS Client
          • Configuring SOAP JMS Transport
            • Enabling SOAP JMS Channels
            • Edit asg.properties File for JMS Server
              • JMS Server Connection Parameters
              • JMS Server Queue Names
            • Create queues on EMS Server
            • Create Users On JMS Server
            • Setting JMS Jars in ClassPath
            • Config UI Configuration
              • Configuring New Partner
              • Configuring Facade Operation
              • Configuring Partner Operation
              • Configuring Target Operation
      • SSL Support for JMS Transport
      • Set JMS Message Delivery and Acknowledgment Mode
        • JMS Message Delivery Modes
        • JMS Message Acknowledgment Mode
      • Non-Standard JMS Headers
        • Setting up JMS Properties
      • ESB Channel
        • Enabling ESB Channels
        • Edit asg.properties File for ESB Channel Properties
          • JMS Server Connection Parameters For ESB Channel
        • Create queues on EMS Server
        • Create Users On EMS Server
    • Config UI
      • Starting GUI
        • Accessing Config UI through HTTPS Transport
          • SSL Properties for Config UI
        • Changing Login Host and Port Information
      • Authentication Process for Config UI
        • Authentication Properties
      • Configuration Setup for Authentication Process
        • LDAP Server Authentication
          • Configuring asg-configui.tra File
          • Configuring web.xml File
        • File-Based Authentication
          • Configuring asg-configui.tra File (FILE)
          • Configuring web.xml File (FILE)
          • Authentication Property Files
        • Default Authentication
      • Enable Debug Logging for Config UI
        • Creating Properties File
          • Logging to stdout
          • Logging to a File
        • Using Properties File in the TRA File
        • Configuring Directory for Log Files
      • Manage a Gateway Project Configuration
      • Publish Project Configuration
        • Publishing Configuration
        • Change Log Level Settings
          • Changing Log Level Settings for Core Engine
          • Changing Log Level Settings for Central Logger
      • Updating Project Configuration
      • Validate Configuration
      • Project Configuration
        • MAPPING
          • Mapping
          • Schemas
          • Error Maps
        • SECURITY
          • WSS
          • KeyStores
          • Policy Mapping
          • Policy Binding
        • MONITORING
          • Monitors
          • KPI Groups
        • ROUTING
          • Facade Operations
            • Adding a New Facade Operation
            • Deleting an Operation
          • Target Operations
            • Adding a New Target Operation
          • Target Operation Groups
          • Routing
        • PARTNER
          • Partners
          • Partner Groups
            • Adding a Throttle for a Partner Group
          • Facade Access
            • Adding a New Facade Access
          • Partner API Key
      • Set Runtime Properties
        • Setting General Properties
        • Setting Monitoring Properties
        • Setting Database Properties
        • Setting Transport Properties
        • Security Properties
    • Transaction Pipeline processing
      • Request Pipeline Processing
      • Response Pipeline Processing
      • Parsing Step
        • Set the Partner Identity for Request
        • Set the Routing Key for Request
        • Enrich the Audit Trail Log for Request
        • Logging Request Headers
          • Sample XSLT
        • Validate the Request Content
        • Set Metric Increment for Content-Based Throttles
        • Set Sticky Key for Load-Balancing with StickyResourceAffinity
        • Overriding HTTP Headers
      • Parsing XSLT Documents
        • Parsing Output Document Schema
      • Mappings and Transformations
        • Mapping Types
        • Mapping Configuration
          • Rendezvous Mapping Type
          • XSLT Mapping Type
          • Assign to the Gateway Operation Endpoint
          • Assign to the Gateway Reference Endpoint
      • Transformations (XSLT Mapping)
        • Set error codes for content validation
        • Validation
          • Enabling Validation
        • Implementing Request Validation
        • Map the Protocol Headers in Request Context
        • Enumeration Orchestration
        • Response Transformation
      • Mapping Schemas
        • Mapping Container
        • Mapping XSLT Schema
        • Context Document
      • JSON XML Transformation
        • Converting XML Message to JSON Message
          • BookQuery Example Response Message
            • BookQuery Example XML Response
            • Example XSLT to Convert BookQuery XML Response to JSON Response
            • BookQuery Example JSON Transformed Response
        • Converting JSON Message to XML Message
          • BookQueryBE Example Request Message
            • BookQueryBE Example JSON Message
            • Example XSLT to Convert BookQueryBE JSON Request to XML Request
            • BookQueryBE Example XML Transformed Request
      • XSLT Functions for URL Encode and URL Decode
        • Decode() Function
          • Sample XSLT (Decode)
          • Sample Input XML(Decode)
          • Sample Output XML(Decode)
        • Encode() Function
          • Sample XSLT (Encode)
          • Sample Input XML (Encode)
          • Sample Output XML (Encode)
          • Using Encode() and Decode() Functions
      • XSLT Functions for Base64 Encode and Decode
        • textToBase64()
        • base64ToText()
      • Custom Java Functions
        • Java Function
        • XSLT File
      • Pass-Through Gateway
        • Starting Config UI
        • Enabling Default Operation
        • Configuring DefaultOperation Facade Operation
          • Configuring DefaultOperation Facade Operation (REST)
          • Configuring DefaultOperation Facade Operation (SOAP)
        • Configuring Target Operation for DefaultOperation
        • Configuring Routing Key for DefaultOperation
        • Configuring Facade Access for DefaultOperation
      • Pass-Through Special Characters in Query String
      • Proxy Server
        • Configuring HTTP Headers
    • Routing Overview
      • Routing Key
        • Routing Key using XSLT
        • How to Derive and Configure Routing Key
          • Define a Transformation File
          • Navigating to the ROUTING Tab
          • Uploading the Transformation (XSLT) File
          • Routing Configuration
          • Routing Configuration for a Target Operation
          • Routing Configuration for a Target Operation Group
      • Routing Use Case using XSLT
        • Configuration
          • Define a Transformation File
          • Uploading the Transformation File
          • Routing Configuration
      • Preferred Routing
        • Use Case for Preferred Routing
          • Example
        • Overriding Preferred Routing Key using XSLT
          • Example XSLT File
      • Target Operation Group
        • Overview
          • Types of Target Operations Group
      • Routing Algorithms for Target Operation Group
        • LoadBalanced
        • RoundRobin
        • Weighted RoundRobin
        • RoundRobin with Failover
        • Weighted RoundRobin with Failover
        • Sticky Resource Affinity
      • Target Operation Group Configuration
        • Configuring a Target Operation Group
        • Configuring a RoundRobin Target Operation Group
        • Configuring a WeightedRoundRobin Target Operation Group
        • Configuring a RoundRobinWithFailOver Target Operation Group
        • Configuring a WeightedRoundRobinWithFailOver Target Operation Group
        • StickyResourceAffinity Target Operation Group Configuration
          • Define Sticky Routing Key
          • Uploading Sticky Routing Key File
          • Configuring StickyResourceAffinity Type Target Operation Group
      • HealthCheck for Reference
        • HealthCheck Modes for a Target Operation
        • HealthCheck Methods for Timer Mode
        • HealthCheck Configuration for Target Operation
        • Configuration for Reset Mode of HealthCheck
        • Configuration for Timer Based HealthCheck
          • Configuration for HTTP HealthCheck Method
          • Configuration for HTTPS HealthCheck Method
          • Configuration for HealthCheckURL HealthCheck Method
          • Configuration for TCPEcho HealthCheck Method
          • Configuration for ContentVerification HealthCheck Method
          • Configuration for SampleRequest HealthCheck Method
    • Throttles Overview
      • Facade Throttles
      • Service Throttles
      • Throttle Types
        • Rate
        • Quota
        • High Water Mark
        • Error
      • Monitor Time Modifiers
        • Configuring Time Modifier Throttles
      • Throttle Chaining
      • Throttle Counter
        • Throttle UpdateInterval
      • Configuring Throttles
        • Configuration Parameters for Throttles
        • Creating a Throttle Policy Definition
          • Modifying the Existing Configuration to Add Throttles
          • Defining a Quota Throttle
          • Assigning a Throttle Policy to the Target Operation
          • Testing the Target Operation
      • Content Based Throttles
        • Configure Content-Based Throttles
        • Configuring Throttle
        • Define XSLT File
        • Uploading XSLT File
      • Payload Size Throttles
        • Payload Size Throttle Types
        • Configuring Payload Size Throttles
          • Configuring Monitor Counter
      • Traffic Shaping
        • Configuration
          • QueueCompactionInterval
      • Shared Throttles Overview
        • Configuration Setup for Shared Throttles
          • Configuring ActiveSpaces Metaspace Connection Properties
          • Enable Shared Throttles
          • Throttle Configuration Parameters
        • Example Use Case
    • Authentication and Authorization
      • User Authentication
        • Transport and Protocol Level Authentication
      • WS Security Services Authentication
        • Security Service Providers
        • Web Services Security (WSS) Properties
        • Types of Security Service Providers
        • Configuring LDAP Authentication Service Provider (LDAP ASP)
        • Configuring Trust Identity Provider
        • Configuring Subject Identity Provider
        • Configuring WSS Service Provider
        • Limitations
      • Web Services Security Authentication
      • Registering WSS resources with TIBCO API Exchange Gateway
      • Defining the WSS security operations
      • Configure Secure Services with TIBCO API Exchange Gateway
        • Altering List of Algorithms (Optional)
        • Define DSS Properties for Services
          • Properties For SSL Authentication (isAnonymous = true)
          • Properties For Mutual SSL Authentication (isAnonymous = false)
        • Configuring Services
      • Partner Authorization Overview
        • Operation Identification
        • Partner Identification
          • Partner API Key
        • Partner Authorization
    • Overview of Security Policies
      • Security Concepts
      • Types of Security Policies
        • Authentication
        • Authorization
        • Confidentiality
        • Integrity
        • CredentialMapping
      • Manage Policies
        • Configure Shared Resource
          • Registering Shared Resource with TIBCO API Exchange Gateway
        • Create Policy
          • Creating Policy File
          • Sample Template Policy Files
        • Registering Policy
        • Applying Policies
      • Policy Use Cases
        • Authentication Policies
          • Configuring Authentication Policies
          • Authentication Policies Types
            • Basic
            • UsernameToken
            • SAML
            • SiteMinder
            • OAuth
              • Schema for OAuth Policies
              • OAuth Policy File Fields
            • SPNEGO
              • Configuration Setup for Kerberos SPNEGO Authentication Policy
                • Creating a User Account in the Microsoft Active Directory for TIBCO API Exchange Gateway
                • Mapping the Service Principal Name (SPN) to a Microsoft User Account
                • Generating a Keytab File for an SPN
          • Authentication Using Custom Shared Resource
            • Implementing Custom Login Module
              • Abstract LoginModule
              • Custom LoginModule
                • Sample Custom LoginModule
            • Packaging and Deploying the Custom Login Module
        • Applying Authorization Policies
          • Configuring Authorization Policies
          • Authorization Policies Types
            • Role
        • Integrity Policies
          • Configuring Integrity Policies
          • Integrity Policies Types
            • Sign
            • Verify Signature
        • Confidentiality Policies
          • Configuring Confidential Policies
          • Confidentiality Policies Types
            • Encryption
            • Decryption
        • Credential Mapping Policies
          • Credential Mapping Policies Types
            • UsernameToken Credential Mapping
            • SAML Credential Mapping
            • Credential Mapping by OAuth Policy
      • Types of Security Shared Resources
      • Shared Resources Properties
        • Configuring LDAP Authentication Shared Resource
        • Configuring SiteMinder Service Provider
        • Configuring Trust Identity Provider
        • Configuring Subject Identity Provider
        • Configuring the Kerberos Service Provider
        • Configuring Custom Shared Resource
        • Shared Resources Properties Sample Files
          • LdapAsp.properties
          • SiteMinderAsp.properties
          • Kerberos SPNEGOAsp.properties
          • SubjectIsp.properties
          • TrustIsp.properties
          • IdentityIsp.properties
          • WssAsp.properties
          • CelmAsp.properties
      • Authentication using File-Based Identity Store
        • Configuring User Authentication Policy using File
          • Create a Shared Resource Properties File
          • Create XML File for Credentials
            • asg-password-hasher Tool
          • Creating Policy File
            • Sample Policy
          • Registering Policy
          • Applying Policy
      • Data Masking and Selective Log Policy
        • Configuration Setup For Log Policy
          • Setting up Properties
          • Create Log Policy Configuration File
          • Creating Data Masking Configuration
            • Masking Headers Data
            • Masking Query String Parameters Data
            • Masking Payload Data
              • Masking Data in Text Payloads
              • Masking Data in XML Payloads
              • Masking Data in JSON Payloads
              • Masking Data in Property Format Payloads
            • Sample Log Policy XML File
            • Log Policy Schema File
          • Upload Log Policy XML File
            • Supported Stages for Log Policy
          • Create Selective Logging Configuration
            • Selective Logging for Text Payloads
            • Selective Logging for XML Payloads
            • Selective Logging for JSON Payloads
            • Selective Logging for Property Format Payloads
      • AntiVirus Scan of Request and Response Payloads
        • Configuration Setup of McAfee Web Gateway
          • Downloading McAfee Web Gateway
          • Configuring McAfee Web Gateway for ICAP Server
            • Enabling ICAP Server
            • Configuring ICAP Client for Request and Response
        • Configuring McAfee Web Gateway for SSL (Optional)
        • Configure TIBCO API Exchange Gateway to Enable AntiVirus Scan
          • Setting Runtime Properties of ICAP Server
          • Enabling AntiVirus Scan for Request Payload of Facade Operation
          • Enabling AntiVirus Scan for Response Payload of Facade Operation
          • Enabling AntiVirus Scan for Request and Response Payloads of Facade Operation
    • OAuth Server
      • Capabilities of the OAuth Server
      • OAuth Client Policies
      • OAuth 2.0 Concepts
      • Benefits of using the OAuth Server
      • OAuth Server Components and Interactions
        • Components
        • Component Interactions
      • OAuth Flows
        • Authorization Code
        • Client Credential
        • Password Credential
      • Configuration Setup of OAuth Server Authorization
        • Setting OAuth Server Properties
        • Enable OAuth Authorization For Gateway (Set Adapter Properties)
          • Owner Adapter
            • File-Based Owner Adapter
            • owners.properties
            • LDAP
          • Client Adapter
            • File-Based Client Adapter
            • clients.properties
            • TIBCO API Exchange Manager
          • Scope Adapter
            • File-Based Scope Adapter
            • scopes.properties
          • Non-Default (Custom) Adapter For Owner Client and Scopes
        • Starting OAuth Server
      • Manage Access Token
        • OAuth Server Endpoint
        • Token Management APIs
        • OAuth Server Endpoints
          • Transport and Port
          • Request Access Token
            • Client Credential Flow
            • Password Credential Flow
            • Authorization Code Flow
          • Access Token Response Example
          • Access Token Error Example
          • Retrieve Access Token Details
            • Using Access Token
              • Validating Access Token Request
              • Sample Response (Retrieve Access Token)
            • Retrieve List of Tokens
            • Retrieve Token for Specific Owner
          • Refresh Token
          • Revoke Token
      • Accessing Token Persistence
      • Enabling OAuth for Application using TIBCO API Exchange Manager
      • Authorization API
        • Name
        • Description
        • Authorization Request
        • Authorization Response
        • Authorization Error
      • Token Request API
        • Name
        • Description
        • Access Token Request
        • Access Token Response
        • Access Token Request Error
      • Token Validation API
        • Name
        • Description
        • Token Validation Request
        • Token Validation Response
        • Token Validation Error
      • Retrieve Access Token
        • Retrieving all tokens
        • Retrieving tokens for specific owner
      • Revoke Token API
        • Name
        • Description
        • Revoke Token Request
      • OAuth Service Provider Interfaces
        • Owner Service Provider Interface
          • Owner Service Provider Interface (SPI) Flow
          • Owner Service Provider Interface (SPI) Java API
        • Client Service Provider Interface
          • Client Service Provider Interface (SPI) Flow
          • Client Service Provider Interface (SPI) Java API
        • Scope Service Provider Interface
          • Scope Service Provider Interface (SPI) Flow
          • Scope Service Provider Interface (SPI) Java API
        • Deploying Custom Adapters
        • Default Adapters
          • Client Adapter
          • Owner Adapter
          • Scope Adapter
    • Gateway Management Features
      • Central Logger
        • Overview
        • Database Setup and Configuration for Central Logger
          • Database Location
          • Task A Setup Database Driver
          • Task B Creating a Database
          • Task C Creating a Database User
          • Task D Setting up the Database Schema
            • For MySql Database
            • For Oracle Database
            • For SQL Server Database
            • For DB2 Database
          • Task E Setting up the Database Connection Parameters
        • Runtime Properties For Central Logger
        • Enabling Reporting to the Central Logger
        • Running the Central Logger
      • Central Logger Database
        • Database Tables
        • Schema Details
        • ASG_TRANSACTIONS Table
        • ASG_TRANSACTION_DETAILS Table
        • ASG_TRANSACTION_MESSAGES Table
        • ASG_TRANSACTION_KEYS Table
        • ASG_THROTTLE_USAGE Table
        • ASG_THROTTLE_MESSAGES Table
        • ASG_KPI Table
        • ASG_LOG_MESSAGES Table
      • Write Transactions Data to File
        • Enabling Transaction Data to a File
        • Format of Transaction Data Log File
      • Recording Error Events to Central Logger
        • Publishing Error (Failed) Transactions
      • Correlation ID
        • Setting Correlation ID for HTTP Header
      • Enable JMS Channel for Central Logger
        • Configuration Setup for JMS Channel
          • Enabling JMS Channel for Central Logger
          • Setting JMS Transport for Central Logger
          • Configuring JMS Transport Properties
      • Global Throttle Manager
        • Throttle Calculation
        • Running Global Throttle Manager
      • Enabling AS Transport
        • Overview
        • Configuration
      • Cache Cleanup Agent
        • Running Cache Cleanup Agent
      • Reporting
        • TIBCO Spotfire Integration
        • Spotfire Configuration
          • Configuring TIBCO Spotfire Server and Client
          • Setting up a Spotfire Data source
          • Creating a Spotfire Information Model for Central Logger
          • Deploying Default TIBCO API Exchange Gateway Audit Trail DXP File on TIBCO Spotfire Server
    • Basic Deployment
      • Deploying TIBCO API Exchange Gateway Processing Units
        • Requirements For Deployment
        • Deployment Options
      • Deploy Using Monitoring And Management Server
        • Deployment Pre-Requisites
        • Configuration Settings Before You Deploy
          • Configuring JMX properties in Core Engine TRA File
            • To Configure JMX Properties
            • To Enable Monitoring and Management
            • To Enable JMX MBeans Authentication
          • Editing MM.cdd File
          • Editing Site Topology File in a Text Editor
          • Install and Configure Software for Remote Start and Deployment
          • Configure User Authorization for Administrator and User Roles
        • Deploying and Managing Processing Units
        • Overriding Global Variables in MM
        • Configure MM Console Properties
      • Configuring for TIBCO BusinessEvents DataGrid WKA Discovery
        • Configuring ASG_DefaultImplementation Project’s CDD
      • Configure Cluster Discovery and Internal Communication
        • Configuring a TIBCO BusinessEvents DataGrid Cluster (Metaspace)
        • Configuring the TIBCO BusinessEvents DataGrid Discover URL
          • If No Other Cluster Members are Started
          • Multicast (PGM) Cluster Member Discovery
          • Unicast (Well-Known Address) Cluster Member Discovery
        • Configuring the TIBCO BusinessEvents DataGrid Listen URL
      • Site Topology Overview
        • References in Site Topology File
        • Deployment-Specific Processing Units
      • Site Topology Reference
        • Site Settings
        • Cluster Settings
        • Deployment Unit Settings
        • Processing Unit Settings
        • Host Settings
      • Working with Cluster Explorer
        • Navigating Cluster Explorer
        • Starting Stopping Pausing and Resuming Core Engines
      • Working With Site Topology Editor
        • Adding a Site Topology Diagram
        • Configuring the Site Topology
        • Specifying the Site Topology Files for the MM Server
      • Running Processing Units At Command Line
      • Deploying Gateway Components Using TIBCO Administrator
    • Advanced Features
      • Cache Agent
        • Running Cache Agent
      • Hot Deployment Overview
        • Enabling Hot Deployment
        • Invoking Hot Deployment
      • Extension Mechanism
      • Response Caching
        • Types of Response Caching
          • Facade Response Cache (Simple Cache)
            • Sample Request Header
            • Sample Response Headers
          • Target Backup Response Cache
        • Cache Response Key
        • Response Caching with Proxy Server
        • Enabling Response Caching
        • Response Caching Parameters
        • Clearing Cached Items
        • Overriding Cache Response Key and Parameters
          • Sample XSLT File
      • Performance Tuning Parameters
      • Large Payload Limit Settings
      • Enable Access Logs in HTTP Channel
    • High Availability Deployment Of Runtime Components
      • Overview
      • Operational Layer Components
      • Gateway Management Layer Components
      • Configuration For High Availability Setup
        • Configure Load Balancer
          • Creating A Health Monitor For Core Engines
          • Creating A Load Balancing Pool
          • Creating a Virtual Server
        • Configure Apache Modules for Core Engines
          • Setting the Rendezvous Connection Parameters For Apache Module
          • Setting the Rendezvous Connection Parameters for Core Engine
        • Cluster Configuration For Runtime Components
          • Configuring Discover URL
            • Editing asg_core.cdd File To Set Discover URL (using text editor)
            • Editing asg_cl.cdd File To Set Discover URL (using text editor)
      • Configuring Fault Tolerance Parameters
      • Configuring Core Engines
      • Configuring Cache Agent
      • Configuring Cache Cleanup Agent
        • Example Setting For Cache Cleanup Agent Instance
      • Configuring Global Throttle Manager
        • Example Setting For Global Throttle Manager Instance
      • Configuring Central Logger
        • Example Settings For Central Logger Instance
      • Configure Rendezvous Session Connection Parameters
    • Appendix A
      • Edit Cluster Deployment Descriptor (CDD) File
        • Editing CDD File using Text Editor
        • Editing CDD File using Studio
        • Setting Discover URL
        • Setting Max Active
        • Setting Priority
      • Configuration Tasks
        • Enabling Cross-Origin Resource Sharing(CORS) Filter Properties
          • Adding URL patterns
          • Adding Filter Parameters
      • Configuring JMS Destinations for Southbound Service Operations
      • Configuring Async Mode for Southbound JMS Service
      • Configuring Retry parameters for HTTP HTTP(s) Transport
      • Enabling detail level logging for Gateway
      • Configuring TIBCO Enterprise Message Service
      • Configuring JMS Northbound Transport for XML
        • Configuring TIBCO Designer
        • Configuring Operations
        • Enable the ESB Channels in CDD File
        • Updating TIBCO Enterprise Message Service Libraries
      • Change the Stack Size
        • Changing the Stack Size Permanently
        • Changing the Stack Size Temporarily
      • Modify Unicast Discovery URL in CDD file
        • Editing the Discover URL and Listen URL (using text editor)
        • Editing the Discover URL and Listen URL (using Studio)
      • Generate Private Keys And Public Certificates with OpenSSL
        • Generating Self-Signed SSL Certificates
        • Generating SSL Keys and Certificates With Your Own your own Trusted CA
          • Creating CA Hierarchy
          • Creating Private Key and Certificate Signing Request (CSR)
          • Creating PKCS#12 archive (Optional)
      • Editing Cluster Deployment Descriptor (CDD) File
        • Using Text Editor
        • Using Studio
      • Connection Problem to TIBCO DataGrid
    • Glossary

Index

Search Results

No search has been performed.
Home
...
User's Guide
Appendix A
Configuring JMS Northbound Transport for XML

Configuring JMS Northbound Transport for XML

This section describes the steps to configure the JMS transport on the northbound side for XML message.

  • Configuring TIBCO Designer
  • Configuring Operations
  • Enable the ESB Channels in CDD File
  • Updating TIBCO Enterprise Message Service Libraries
Copyright © Cloud Software Group, Inc. All rights reserved.