•  webMethods Adapter Development Kit Documentation
  •  About This Help
    • Document Conventions
    • Online Information and Support
    • Data Protection
  •  webMethods Adapter Development Kit Installation and User’s Documentation
    •  Overview
      • What is the Adapter Development Kit?
      •  Points of Integration
        • Data-Level Integration
        • Application Interface-Level Integration
        • Method-Level Integration
        • User Interface-Level Integration
      •  Development Time Tasks and Support
        • Create the Adapter Definition
        • Define Connections and Connection Factories
        • Define Adapter Service Templates
        • Define Polling Notification Templates
        • Define Listener Notification Templates
        • Define Metadata
        • Transaction Support
        • Exception Support
        • Logging Support
        • Internationalization Support
      • Design Time Tasks
      • The Runtime Conceptual Model
    •  Installing and Uninstalling the Sample Adapter
      • Overview
      • Requirements
      • The Integration Server Home Directory
      • Installing Sample Adapter
      • Uninstalling Sample Adapter
    •  The Adapter Definition
      • Overview
      • Creating an Adapter Package
      • Adapter Definition Classes
      • Adapter Definition Implementation Classes (Example MyAdapter)
      •  Creating a WmAdapter Implementation Class
        • Creating WmAdapter Implementation Class with example
      •  Creating Resource Bundles
        • Creating Resource Bundles Class With Example
      •  Deploying the adapter
        •  Creating Adapter Startup and Shutdown Java Services
          • Creating Java Classes for Adapter Startup and Shutdown
          • Creating Java Services for Adapter Startup and Shutdown using Designer
        • Compiling the Adapter
        • Registering the Adapter Startup and Shutdown Java Services in Integration Server
        • Debugging the Adapter
        • Adapter Load Process
        • Adapter Unload Process
        • Reporting Adapter Fix Levels
      •  Package Management
        • Package Dependency Considerations for Namespace Node Packages
        • Package Dependency Considerations for Namespace Nodes
        • Group Access Control
        • Enabling and Disabling Packages
        • Loading, Reloading, and Unloading Packages
    •  Connections
      • Overview
      • Adapter Connection Classes
      • Adapter Connection Implementation Classes
      • Creating a WmManagedConnection Implementation Class
      •  Creating a WmManagedConnectionFactory Implementation Class
        • Metadata Model for Connection
        • WmDescriptor Interface
      • Updating the Resource Bundle
      • Registering Connection Factories in the Adapter
      •  Connection Class Interactions
        • Retrieving Connection Metadata
        • Enabling Connection Nodes
        • Creating Connections
        • Disabling Connection Nodes
        • Releasing Connections
        • Receiving AdapterConnectionExceptions
      •  Configuring and Testing Connection Nodes
        • Configuring Connection Nodes
    •  Adapter Services
      • Overview
      •  Adapter Service Classes
        • Adapter Services Implementation Classes
      •  Metadata Model for Adapter Services
        • Metadata Parameter Groups, FieldMaps and Tuples
        •  Resource Domains
          • Resource Domain Lookups
          • Adapter Check Value Callbacks
        • Field Maps with Resource Domain Dependencies
        •  Adapter Service Node Signatures
          • Implementing Resource Domain Lookups for Signature Names and Data Types
        •  Adapter Service Execution
          • Interacting with the Pipeline
      •  Adapter Service Template Interactions
        •  Creating Adapter Service Nodes
          • Selecting Connection Nodes
          • Entering Names and Folders for Adapter Service Nodes
        • Viewing or Editing Adapter Service Nodes
        • Executing Adapter Service Nodes
      •  Adapter Service Implementation
        • Example 1: WmAdapterService Implementation Class
        • Example 2: WmManagedConnection Implementation Class Updates
        • Defining WmAdapterService Implementation Class
        • Specifying Configuration Metadata for Adapter Service
        • Implementing Configuration Resource Domains for Adapter Service
        •  Manipulating Adapter Service Signature Properties
          • Template-Based Signature Properties
          • Signature Field Properties
        • Specifying Adapter Service Signature Data
        • Specifying Adapter Service Signature Resource Domains
        • Implementing the WmAdapterService.execute Method
        • Updating the Resource Bundle
        • Registering Adapter Service in the Connection Factory Implementation Class
        • Compiling Adapter
        • Reloading Adapter
        • Refreshing the Designer cache
        • Configuring and Testing Adapter Service Nodes
      • Configuring and Testing Adapter Service Nodes
    •  Polling Notifications
      •  Overview
        • Implementing Polling Notifications
      •  Polling Notification Classes
        • Polling Notification Implementation Classes
      • Polling Notification Callbacks
      • Metadata Model for Polling Notifications
      • Polling Notification Interactions
      •  Polling Notification Implementation
        • Example Polling Notification Class
        • Defining a WmPollingNotification Implementation Class
        • Specifying Configuration Metadata for Polling Notifications
        • Implementing Configuration Resource Domains for Polling Notifications
        • Specifying Notification Signatures (Document Type)
        • Manipulating Adapter Notification Document Properties
        • Implementing Signature Resource Domains
        • Implementing the WmPollingNotification.runNotification Method and Callbacks
        • Updating the Resource Bundle
        • Registering Polling Notifications in the Adapter
      •  Configuring and Testing Polling Notification Nodes
        • Configuring Polling Notification Nodes
        • Scheduling and Enabling Polling Notification Nodes
        •  Testing Polling Notification Nodes
          • Creating the Flow Service for the Polling Notification Node
          • Creating the Trigger for the Polling Notification Node
          • Scheduling and Enabling the Polling Notification Node
          • Testing the Polling Notification Node
      •  Cluster Support for Polling Notifications
        • Callback Coordination
        • Polling Coordination
        • Configuration Settings
    •  Listener Notifications
      •  Overview
        • Synchronous and Asynchronous Listener Notifications
        • Implementing Listeners and Listener Notifications
      • Listener Classes
      • Asynchronous Listener Notification Classes
      • Synchronous Listener Notification Classes
      • Listener and Listener Notification Interactions
      •  Listener Implementation
        • Example Listener Class
        • Defining a WmConnectedListener Implementation Class
        • Specifying Configuration Metadata for Listener Notifications
        • Implementing Listener Methods
        • Creating getReader Method in WmManagedConnection Implementation Class
        • Updating the Resource Bundle
        • Registering Listeners in the WmAdapter Implementation Class
        • Compiling Adapter
        • Reloading Adapter
        • Refreshing the Designer cache
        • Configuring a Listener
      •  Listener Notification Implementation
        • Example Listener Notification Class
        • Defining a WmAsyncListenerNotification Implementation Class
        •  Specifying Configuration Metadata for Listener Notifications
          • The useParam Argument of setResourceDomain
        • Implementing Configuration Resource Domains for Listener Notifications
        • Implementing the supports and runNotification Method
        • Updating the Resource Bundle
        • Registering Listener Notifications in the Adapter
        • Compiling Adapter
        • Reloading Adapter
        • Refreshing the Designer cache
        •  Configuring and Testing Listener Nodes and Listener Notification Nodes
          • Configuring Listener Notification Nodes
          •  Testing Listener and Listener Notification Nodes
            • Creating the Flow Service for the Listener Notification Node
            • Creating the Trigger for the Listener Notification Node
            • Enabling Listener Notification Nodes and Listener Nodes
            • Testing Listener
      •  Configuring and Testing Listener Nodes and Listener Notification Nodes
        • Configuring Listener Notification Nodes
        •  Testing Listener and Listener Notification Nodes
          • Creating the Flow Service for the Listener Notification Node
          • Creating the Trigger for the Listener Notification Node
          • Enabling Listener Notification Nodes and Listener Nodes
          • Testing Listener
    •  Runtime Activities
      • Overview
      • Retry and Recovery Architecture
      •  Runtime Connection Allocation for Adapter Services
        •  Implementing Partitioned Connection Pools
          • Implementing WmConnectionRequestInfo
          • Implementing WmConnectionSpec
          • Updating the Connection Factory
    •  Usage Scenarios
      •  How to register an adapter with the Integration Server?
        • Creating an Adapter Package
        • Creating an Adapter Implementation Class
        • Creating Adapter Startup and Shutdown Java Services
        • Compiling the Adapter
        • Registering the Adapter Startup and Shutdown Java Services in Integration Server
        • Testing the Adapter Registration
      • How to create an adapter connection implementation?
      •  How to create an adapter service implementation?
        • How to create a basic adapter service implementation without any elements?
        • How to display elements in an adapter service?
        • How to group elements, display data in tables and perform lookups in an adapter service?
        • How to display adapter service signature?
      • How to create a polling notification implementation?
      • How to create an adapter listener implementation?
    •  Alternative Approaches to Metadata
      • Overview
      • Implementing Metadata Parameters Using External Classes
      • An Alternative Approach to Organizing Resource Domains
      • Using Resource Bundles with Resource Domain Values
    •  Integration Server Transaction Support
      • Overview
      • Simple Transactions
      • More Complex Transactions
      • Implicit Transaction Usage Cases
      • Explicit Transaction Usage Cases
      •  Built-In Services For Explicit Transactions
        • pub.art.transaction:startTransaction
        • pub.art.transaction:commitTransaction
        • pub.art.transaction:rollbackTransaction
        •  pub.art.transaction:setTransactionTimeout
          • Changing the Integration Servers' Transaction Timeout Interval
      • Transaction Error Situations
      • Specifying Transaction Support in Connections
    •  Using the Services for Managing Namespace Nodes
      •  Overview
        •  Connection Services
          • wm.art.dev.connection:createConnectionNode
          • wm.art.dev.connection:deleteConnectionNode
          • wm.art.dev.connection:fetchConnectionManagerMetadata
          • wm.art.dev.connection:fetchConnectionMetadata
          • wm.art.dev.connection:updateConnectionNode
        •  Adapter Service Services
          • wm.art.dev.service:createAdapterServiceNode
          • wm.art.dev.service:deleteAdapterServiceNode
          • wm.art.dev.service:fetchAdapterServiceTemplateMetadata
          • wm.art.dev.service:updateAdapterServiceNode
        •  Listener Services
          • wm.art.dev.listener:analyzeListenerNodes
          • wm.art.dev.listener:createListenerNode
          • wm.art.dev.listener:deleteListenerNode
          • wm.art.dev.listener:fetchListenerTemplateMetadata
          • wm.art.dev.listener:updateListenerNode
          • wm.art.dev.listener:updateRegisteredNotifications
        •  Listener Notification Services
          • wm.art.dev.notification:analyzeListenerNotifications
          • wm.art.dev.notification:createListenerNotificationNode
          • wm.art.dev.notification:deleteListenerNotificationNode
          • wm.art.dev.notification:fetchListenerNotificationTemplateMetadata
          • wm.art.dev.notification:updateListenerNotificationNode
        •  Polling Notification Services
          • wm.art.dev.notification:createPollingNotificationNode
          • wm.art.dev.notification:deletePollingNotificationNode
          • wm.art.dev.notification:fetchPollingNotificationTemplateMetadata
          • wm.art.dev.notification:updatePollingNotificationNode
      •  Connection Services
        • wm.art.dev.connection:createConnectionNode
        • wm.art.dev.connection:deleteConnectionNode
        • wm.art.dev.connection:fetchConnectionManagerMetadata
        • wm.art.dev.connection:fetchConnectionMetadata
        • wm.art.dev.connection:updateConnectionNode
      •  Adapter Service Services
        • wm.art.dev.service:createAdapterServiceNode
        • wm.art.dev.service:deleteAdapterServiceNode
        • wm.art.dev.service:fetchAdapterServiceTemplateMetadata
        • wm.art.dev.service:updateAdapterServiceNode
      •  Listener Services
        • wm.art.dev.listener:analyzeListenerNodes
        • wm.art.dev.listener:createListenerNode
        • wm.art.dev.listener:deleteListenerNode
        • wm.art.dev.listener:fetchListenerTemplateMetadata
        • wm.art.dev.listener:updateListenerNode
        • wm.art.dev.listener:updateRegisteredNotifications
      •  Listener Notification Services
        • wm.art.dev.notification:analyzeListenerNotifications
        • wm.art.dev.notification:createListenerNotificationNode
        • wm.art.dev.notification:deleteListenerNotificationNode
        • wm.art.dev.notification:fetchListenerNotificationTemplateMetadata
        • wm.art.dev.notification:updateListenerNotificationNode
      •  Polling Notification Services
        • wm.art.dev.notification:createPollingNotificationNode
        • wm.art.dev.notification:deletePollingNotificationNode
        • wm.art.dev.notification:fetchPollingNotificationTemplateMetadata
        • wm.art.dev.notification:updatePollingNotificationNode
    •  Using the Sample Adapter
      • Overview
      •  The Sample Server
        • Starting the Sample Server
      • Banking Services, Queries and Alerts
      • Prerequisites for Code Compilation
      •  Phase 1: Creating an Adapter Definition
        • Disabling Sample Adapter Package
        • Creating the MyWmSampleAdapter Package
        • Compiling the MyWmSampleAdapter Package
        • Adding the MyWmSampleAdapter's Startup and ShutDown Services
        • Testing the MyWmSampleAdapter Package
        • Disabling the Phase 1 Implementation
      •  Phase 2: Adding a Connection
        • Implementing the Connection Template
        • Revising Adapter Definition Classes From Phase 1
        • Compiling the Phase 2 Implementation
        • Creating the TestMyWmSampleAdapter Package
        • Configuring the Connection Node
        • Enabling the Connection Node
        • Disabling the Phase 2 Implementation
      •  Phase 3: Adding Adapter Services
        • Implementing the Adapter Service Template
        • Revising Code From Phases 1 and 2
        • Compiling the Phase 3 Implementation
        •  Configuring the Adapter Service Nodes
          • Configuring and Enabling a Connection Node
          • Configuring the Adapter Service Node
        • Testing the Adapter Service Nodes
        • Disabling the Phase 3 Implementation
      •  Phase 4: Adding Polling Notifications
        • Implementing the Polling Notification Template
        • Revising Code From Phases 1, 2, and 3
        • Compiling the Phase 4 Implementation
        •  Configuring and Testing the Polling Notification Nodes
          • Configuring and Enabling a Connection Node
          • Configuring the underBalancePolling Notification Node
          • Creating the Flow Service for the underBalancePolling Notification Node
          • Creating the Trigger for the underBalancePolling Notification Node
          • Scheduling and Enabling the underBalancePolling Notification Node
          • Testing the underBalancePolling Notification Node
        • Disabling the Phase 4 Implementation
      •  Phase 5: Adding Listener Notifications
        • Implementing the Listener
        • Implementing the Asynchronous Listener Notification Template
        • Revising the Code from Phases 1, 2, 3, and 4
        •  Configuring and Testing the Listener and the Listener Notification Nodes
          • Configuring and Enabling a Connection Node
          • Configuring the Listener Node
          • Configuring the checkDepositListener Notification Node
          • Creating the Flow Service for the checkDepositListener Notification Node
          • Creating the Trigger for the checkDepositListener Notification Node
          • Enabling the checkDepositListener Notification Node and the Listener Node
          • Testing the checkDepositListener Notification Node
• Copyright

webMethods Adapter Development Kit Documentation

Copyright