API Management
Understanding Software AG Products
About this Guide
Quick Start
Agile Process Quick Start
Design
Analysis
Development
Execution
Administration and Monitoring
Composite Applications
Analytics & Decisions Quick Start
API Management Quick Start
Application Integration Quick Start
B2B Integration Quick Start
In-Memory Data Management
Master Data Management Quick Start
Agile Process
Business Process Management
Designing Business Processes
ARIS Connect, Software AG Designer, and ARIS Architect
Software AG Designer
Governing Business Process Models
Implementing Business Process Models
Software AG Designer
Developing Services
Developing Rules
Developing Tasks
Task Engine
AgileApps
Terracotta
Executing Business Processes
Integration Server
Universal Messaging
My webMethods Server
Business Process Model Implementation Details
Creating Documents, Services, Tasks, and Rules
Developing Tasks Within a Process
Simulating and Debugging Business Processes
Logging and Monitoring Processes
Mapping Process Steps to Run Times
Developing in a Collaborative Environment
Developing Composite Applications
Software AG Designer
Application Platform
My webMethods Server
Integration Server
Developing in a Collaborative Environment
Administering and Monitoring Business Processes
Administering Business Processes
Monitoring Business Process Instances
Administering and Working with Business Processes and Tasks
Solving Problems with Closed Loop Analytics
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
Analytics & Decisions
Analytics & Decisions
Business Event Processing
Business Activity Monitoring
Products Involved in Analytics & Decisions
Analytics & Decisions Example
Visualizing Data
MashZone NextGen Business Analytics
MashZone NextGen Visual Analytics
Terracotta
Mining Process Data and Analyzing Root Causes
Process Performance Manager
Defining Baselines, Metrics, and Alerts
Optimize for Process
Terracotta
Detecting and Analyzing Complex Patterns in Real Time
Developing Apama Applications
Integrating Apama with External Data Sources
Building Dashboards
Monitoring System Resources
Optimize for Infrastructure
Sharing Events Across Products
Digital Event Services
Universal Messaging
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
API Management
API Management
Exposing and Consuming APIs
API-Portal
Governing and Securing Your API Management System
Mediator
Terracotta
CentraSite
Terracotta
Enterprise Gateway Server
API Gateway
Terracotta
Monitoring and Managing Your API Management System
Insight
Application Integration
Application Integration
Developing Application Integrations
Software AG Designer
Application Platform
CloudStreams
Terracotta
Adapters
EntireX
ApplinX
Web Enablement
Instant Solution
HTML Emulation Solution
Composite Solution
SOA Enablement
Webpage Integration
Executing Application Integrations
Integration Server
Terracotta
Integration Agent
Universal Messaging
Application Integration Examples
Synchronization
Propagation
Composition
Sharing Events Across Products
Digital Event Services
Universal Messaging
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
B2B Integration
B2B Integration
Building, Managing, and Monitoring a Trading Network
Trading Networks
Terracotta
eStandards Modules
Terracotta
Optimize for B2B
B2B Analytics
Managing File Transfers
Developing Mobile Integrations
Software AG Designer
Mobile Designer
Mobile Support
Terracotta
In-Memory Data Management
In-Memory Data Management
BigMemory
Terracotta Server Array
Master Data Management
Master Data Management
OneData
Using Terracotta with webMethods Products
About this Guide
webMethods Products and Terracotta
Overview
Using Terracotta to Create Very Large In-Memory Caches with BigMemory
Using a Terracotta Server Array to Share Cached Data Among Applications
System Caches Used by webMethods Products
How webMethods Products Use Terracotta
Business Process Management
Software AG Common Platform
CentraSite
webMethods CloudStreams
Software AG Command Central
Software AG Event Routing
webMethods eStandards Modules
webMethods Integration Server
webMethods Mediator
webMethods Mobile Support
webMethods OneData
webMethods Optimize
webMethods Trading Networks
Licensing Requirements
Installing the Terracotta License
License Requirements for Integration Server
Installing and Configuring the Terracotta Server Array for Use with webMethods Products
Installing the Terracotta Server Array
Configuring the Terracotta Server Array for Use with webMethods Product
Creating the tc-config File
Using Command Central to Manage Terracotta
Command Central Commands that Terracotta Supports
Configuration Types that Terracotta Supports
Lifecycle Actions for Terracotta
Run-time Monitoring Statuses for Terracotta
Run-time Monitoring Statuses for Terracotta
System Caches Used by the webMethods Product Suite
Overview
Business Process Management
SoftwareAG.IS.PE.FailedProcessAudit
Software AG Common Platform
SSOAssertionsCacheManager.SSOAssertionsCache
CentraSite
SoftwareAG.CentraSite.model.ObjectCache_machine_name_port
SoftwareAG.CentraSite.model.TypeCache_machine_name_port
webMethods CloudStreams
SoftwareAg.IS.CloudStreams.ClusterStatusCache
SoftwareAg.IS.CloudStreams.CollectionKeysCache
SoftwareAg.IS.CloudStreams.ConsumerApplicationsCache
SoftwareAg.IS.CloudStreams.IntervalNotificationCache
SoftwareAg.IS.CloudStreams.MetricAccumulatorCache
SoftwareAg.IS.CloudStreams.RegisteredConsumerNamesCache
SoftwareAg.IS.CloudStreams.RuntimePolicyCache
SoftwareAg.IS.CloudStreams.VirtualServicesCache
Software AG Command Central
com.softwareag.plm.cce.cache.alert
com.softwareag.plm.cce.cache.attributes
com.softwareag.plm.cce.cache.basicmonitoringstatecached
com.softwareag.plm.cce.cache.configurationDataInfo
com.softwareag.plm.cce.cache.configurationInstanceInfo
com.softwareag.plm.cce.cache.configurationTypeInfo
com.softwareag.plm.cce.cache.environment
com.softwareag.plm.cce.cache.fixInfo
com.softwareag.plm.cce.cache.licenseKeyContainer
com.softwareag.plm.cce.cache.licenseMeteringReport
com.softwareag.plm.cce.cache.licenseMeteringAggregateReport
com.softwareag.plm.cce.cache.licenseMeteringConfigurationAggregationStatus
com.softwareag.plm.cce.cache.licenseMeteringRequiredStatus
com.softwareag.plm.cce.cache.manifest
com.softwareag.plm.cce.cache.node
com.softwareag.plm.cce.cache.platformInfo
com.softwareag.plm.cce.cache.productInfo
com.softwareag.plm.cce.cache.repositories
com.softwareag.plm.cce.cache.runtimeComponentInfo
com.softwareag.plm.cce.cache.runtimeMetadata
webMethods Enterprise Gateway
SoftwareAG.IS.Core.NonceCache
webMethods eStandards Modules
webMethods Module for AS4
SoftwareAG.IS.AS4. Duplicate_Detection
SoftwareAG.IS.AS4. MPC_pmode_map
SoftwareAG.IS.AS4. Default_Cache
webMethods Chem eStandards Module
SoftwareAG.IS.Chem.CHEMModelSessionCache
webMethods ebXML Module
SoftwareAG.IS.ebXML.EBXML
webMethods FIX Module
SoftwareAG.IS.FIX.FIXCache
webMethods HIPAA Module
SoftwareAG.IS.HIPAA.CodeSourceCache
SoftwareAG.IS.HIPAA.DefaultCache
webMethods RosettaNet Module
SoftwareAG.IS.RosettaNet.RNModelSessionCache
Software AG Event Routing
eventTypeQName
webMethods Integration Server
SoftwareAG.IS.Core.ActiveOpenIDRequests
SoftwareAG.IS.Core.ClusterMembers
SoftwareAG.IS.Core.IteratorHandles
SoftwareAG.IS.Core.IteratorResults
SoftwareAG.IS.Core.NonceCache
SoftwareAG.IS.Core.OAuthAccessTokens
SoftwareAG.IS.Core.OAuthAuthCodes
SoftwareAG.IS.Core.OAuthClients
SoftwareAG.IS.Core.OAuthRefreshTokens
SoftwareAG.IS.Core.OAuthScope
SoftwareAG.IS.Core.OAuthTokens
SoftwareAG.IS.Core.SessionStore
SoftwareAG.IS.Core.XMLParser.Partitions
SoftwareAG.IS.Services.ServiceResults
webMethods Mediator
SoftwareAg.IS.Mediator.APIKeysCache
SoftwareAG.IS.Mediator.APIPortalCommunicationCache
SoftwareAG.IS.Mediator.ClusterStatusCache
SoftwareAG.IS.Mediator.ConsumerApplicationsCache
SoftwareAG.IS.Mediator.ESCommunicationCache
SoftwareAG.IS.Mediator.IntervalNotificationCache
SoftwareAG.IS.Mediator.MetricAccumulatorCache
SoftwareAG.IS.Mediator.OAuth2TokensCache
SoftwareAG.IS.Mediator.RegisteredConsumerNamesCache
SoftwareAG.IS.Mediator.RuntimeAliasesCache
SoftwareAG.IS.Mediator.RuntimeAliasesServicesAssociationCache
SoftwareAG.IS.Mediator.RuntimePolicyCache
SoftwareAG.IS.Mediator.VirtualServicesCache
webMethods Mobile Support
SoftwareAG.IS.MobileSupport.RecordLocker
webMethods OneData
SoftwareAG.OneData.core.cacheName
webMethods Optimize
Metadata Caches
sag.opt.clusterable.caches.deployed/dimensiondef
sag.opt.clusterable.caches.deployed/dimensiondef-BASE_TYPE
sag.opt.clusterable.caches.deployed/dimensiondef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/dimensiondef-ID
sag.opt.clusterable.caches.deployed/dimensiondef-NAME
sag.opt.clusterable.caches.deployed/dimensionfilter
sag.opt.clusterable.caches.deployed/dimensionjoin
sag.opt.clusterable.caches.deployed/dimensionjoin-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/dimensionjoin-ID
sag.opt.clusterable.caches.deployed/dimensionjoin-NAME
sag.opt.clusterable.caches.deployed/dimensionsubscriber
sag.opt.clusterable.caches.deployed/eventmap
sag.opt.clusterable.caches.deployed/eventmap-BASE_TYPE
sag.opt.clusterable.caches.deployed/eventmap-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/eventmap-ID
sag.opt.clusterable.caches.deployed/eventmap-NAME
sag.opt.clusterable.caches.deployed/hierarchydef
sag.opt.clusterable.caches.deployed/hierarchydef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/hierarchydef-ID
sag.opt.clusterable.caches.deployed/hierarchydef-NAME
sag.opt.clusterable.caches.deployed/ilink
sag.opt.clusterable.caches.deployed/kpidef
sag.opt.clusterable.caches.deployed/kpidef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/kpidef-EVENT_MAP_NAME
sag.opt.clusterable.caches.deployed/kpidef-ID
sag.opt.clusterable.caches.deployed/kpidef-NAME
sag.opt.clusterable.caches.deployed/rule
sag.opt.clusterable.caches.deployed/rule-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/rule-ID
sag.opt.clusterable.caches.deployed/rule-NAME
sag.opt.clusterable.caches.latest/dimensiondef
sag.opt.clusterable.caches.latest/dimensiondef-BASE_TYPE
sag.opt.clusterable.caches.latest/dimensiondef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/dimensiondef-ID
sag.opt.clusterable.caches.latest/dimensiondef-NAME
sag.opt.clusterable.caches.latest/dimensionfilter
sag.opt.clusterable.caches.latest/dimensionjoin
sag.opt.clusterable.caches.latest/dimensionjoin-DISPLAY_NAME
sag.opt.clusterable.caches.latest/dimensionjoin-ID
sag.opt.clusterable.caches.latest/dimensionjoin-NAME
sag.opt.clusterable.caches.latest/dimensionsubscriber
sag.opt.clusterable.caches.latest/eventmap
sag.opt.clusterable.caches.latest/eventmap-BASE_TYPE
sag.opt.clusterable.caches.latest/eventmap-DISPLAY_NAME
sag.opt.clusterable.caches.latest/eventmap-ID
sag.opt.clusterable.caches.latest/eventmap-NAME
sag.opt.clusterable.caches.latest/hierarchydef
sag.opt.clusterable.caches.latest/hierarchydef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/hierarchydef-ID
sag.opt.clusterable.caches.latest/hierarchydef-NAME
sag.opt.clusterable.caches.latest/ilinkdef
sag.opt.clusterable.caches.latest/kpidef
sag.opt.clusterable.caches.latest/kpidef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/kpidef-EVENT_MAP_NAME
sag.opt.clusterable.caches.latest/kpidef-ID
sag.opt.clusterable.caches.latest/kpidef-NAME
sag.opt.clusterable.caches.latest/rule
sag.opt.clusterable.caches.latest/rule-DISPLAY_NAME
sag.opt.clusterable.caches.latest/rule-ID
sag.opt.clusterable.caches.latest/rule-NAME
Operational Caches
sag.opt.clusterable.caches.AcceptedJMSMessageIdsCache
sag.opt.clusterable.caches.deleteAllKPIsCache
sag.opt.clusterable.caches.kpiCompInstStateCache
sag.opt.clusterable.caches.kpiInstStateCache
sag.opt.clusterable.caches.KPIISID2ID_IndexCache
sag.opt.clusterable.caches.kpiLastProcTimeCache
sag.opt.clusterable.caches.kpiLockCache
sag.opt.clusterable.caches.KPIN2IIDS_IndexCache
sag.opt.clusterable.caches.KPIN2MIDS_IndexCache
sag.opt.clusterable.caches.LIID2CIID_IndexCache
sag.opt.clusterable.caches.lockCache
sag.opt.clusterable.caches.metadataDefinitionLoadLockCache
sag.opt.clusterable.caches.metadataOpsLockCache
sag.opt.clusterable.caches.monitorCache
sag.opt.clusterable.caches.monitorChangeInFlightCache
sag.opt.clusterable.caches.monitorLastReadingTimeCache
sag.opt.clusterable.caches.OptAEClusterMemberCache
sag.opt.clusterable.caches.optimizeAlgorithmStateCache
sag.opt.clusterable.caches.optimizeDiagnosesCache
sag.opt.clusterable.caches.optimizeDimensionEnabledStateCache
sag.opt.clusterable.caches.optimizeDimensionIndexByStringIdCache
sag.opt.clusterable.caches.optimizeDimensionOpsCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByDimKeyCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByDimNameCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByIdentityCache
sag.opt.clusterable.caches.optimizeROStatsOpsCache
sag.opt.clusterable.caches.optimizeStatsAccumulationOpsCache
sag.opt.clusterable.caches.OreEvaluatorCache
sag.opt.clusterable.caches.OreEvaluatorIndex_EMID2RIIDS
sag.opt.clusterable.caches.OreEvaluatorIndex_ET2RIIDS
sag.opt.clusterable.caches.OreEvaluatorIndex_KMID2RIIDS
sag.opt.clusterable.caches.OreStubCache
sag.opt.clusterable.caches.OreStubCache_RDID2RIID
sag.opt.clusterable.caches.OreStubCache_RISID2RIID
sag.opt.clusterable.caches.OreStubIndex_EMID2RIIDS
sag.opt.clusterable.caches.OreStubIndex_KMID2RIIDS
sag.opt.clusterable.caches.pt_cluster_member_cache
sag.opt.clusterable.caches.pt_partitionTableCache
sag.opt.clusterable.caches.ScheduledKPIInstanceDeletionJobs
Locally Persistent Operational Caches
sag.opt.eventhandling.caches.EventsForStorage
sag.opt.eventhandling.caches.PendingEventLists
sag.opt.eventhandling.caches.TaskObserver_MessagesCache
sag.opt.eventhandling.caches.TaskObserver_TasksCache
sag.opt.eventhandling.caches.TempEventsForStorage
sag.opt.jmscommunication.caches.JMSCommunicationResendCache
sag.opt.notifications.caches.dimensionDefNotificationsCache
sag.opt.notifications.caches.dimSubscriberNotificationsCache
sag.opt.notifications.caches.eventMapNotificationsCache
sag.opt.notifications.caches.kpiDefNotificationsCache
sag.opt.notifications.caches.monitorChangeNotificationsCache
sag.opt.notifications.caches.ptRoutingTableNotificationsCache
sag.opt.notifications.caches.ruleDefNotificationsCache
webMethods Trading Networks
SoftwareAG.IS.TN.TNDocAttribute
SoftwareAG.IS.TN.TNDocType
SoftwareAG.IS.TN.TNProfile
SoftwareAG.IS.TN.TNProfileId
SoftwareAG.IS.TN.TNProfileSummary
SoftwareAG.IS.TN.TNProfileSummaryByDispName
SoftwareAG.IS.TN.TNQueryResults
SoftwareAG.IS.TN.TNTPA
SoftwareAG.IS.TN.TNTPAId
Working with CentraSite Business UI
API Management Solutions
Overview
CentraSite and API Management
Why Do APIs Need to Be Managed?
The webMethods API Management Product Suite
Getting Started with API Management
Creating an API
Viewing the API List
Viewing Details for an API
Summary of Profiles in the API
Summary of Actions in the API
Editing the Properties of an API
Setting Permissions on an API
Who Can Set Permissions on an API?
Setting Instance Level Permissions on an API
Setting Instance Level Profile Permissions on an API
Configuring the API Consumption Settings
Roles and Permissions Needed to Configure API Consumption Settings
Configuring the API Consumption Settings for API Key Authentication
Configuring the API Consumption Settings for OAuth2 Authentication
Managing API Keys and OAuth 2.0 Tokens
Roles and Permissions Needed to Manage Access Keys and Tokens
Satisfying Key and OAuth Token Generation Requirements
Configuring the Email Templates for API Key or OAuth Token Generation
Renewing an API Key
Changing the Default Key Expiration Interval
Configuring the Email Templates for Key Expiration
Configuring the Email Templates for Key Renewal
Revoking an API Key
Revoking an API Key by an API Provider
Revoking an API Key by an API Consumer
Using Custom Email Templates for API Key Revocation
Deleting an API Key
Deleting a Single API Key
Deleting a Set of API Keys
Revoking an OAuth2 Client
Revoking an OAuth2 Client by an API Provider
Revoking an OAuth2 Client by an API Consumer
Using Custom Email Templates for OAuth2 Client Revocation
Approving a Request
Approving Requests for Consumer Onboarding Registration
Approving Requests for Access Token Management
Deleting an API
Deleting a Single API
Deleting a Set of APIs
Exporting and Importing an API
Before You Begin
Exporting an API
Exporting Multiple APIs in a Single Operation
Importing APIs
Email Notification Templates and Tokens
Predefined Email Templates Installed with CentraSite
Customizing Email Templates
Writing a Custom Email Template
Using Substitution Tokens
Predefined Policies for API Management
The User Registration Policies
Global New User Account Policy
New User Account Policy
The Consumer Onboarding Policies
Global Consumer Onboarding Policy
Consumer Onboarding Policy
The API Key Management Policies
API Key Generation Policy
API Key Renewal Policy
API Key Revocation Policy
The OAuth2 Client Management Policies
OAuth2 Client Generation Policy
OAuth2 Client Revocation Policy
The API-Portal Integration Policies
Publish to API-Portal Policy
Unpublish from API-Portal Policy
Administering the Business UI
Overview
Conceptual Overview of the CentraSite Business UI
Working with the CentraSite Business UI
About CentraSite Business UI
Starting the Graphical User Interface
Using URL to Start the Graphical User Interface
Alternative Procedures on Windows
Logging In and Out
Your First Logon after Installation
Logging in into Business UI
How to Log in to CentraSite Business UI as Registered User
How to Log in to CentraSite Business UI as Guest User
Resetting your Password
Creating your New Account in CentraSite
Take a Tour through
Logging out from Business UI
Starting CentraSite Business UI
The Navigation Controls in the User Interface
Configuring the Enhanced Profile Layout for Rendering Details of Registry Objects
What is the Enhanced Profile Layout?
What is the Legacy Profile Layout?
Where is the Enhanced Profile Layout Used?
Configuring the Enhanced Profile Layout
Managing Your Profile
About Profiles
Viewing Your Profile
Editing Your Profile
Uploading and Updating Your Personal Profile Picture
Managing Your User Preferences
Setting Notification Options
Setting Display Options
Managing Your API Keys / OAuth2 Tokens
Viewing Your List of API Keys / OAuth2 Tokens
Renewing an API Key / OAuth2 Token
Deleting an API Key / OAuth2 Token
Setting Saved Searches Preferences
Viewing Your List of Saved Searches
Adding a Search to Saved Searches
Modifying a Search in Saved Searches
Renaming a Search in Saved Searches
Removing a Search from Saved Searches
Managing Your List of My Favorites
Viewing Your List of My Favorites
Adding an Asset to the My Favorites List
Adding Multiple Assets to the My Favorites List
Removing an Asset from the My Favorites List
Removing an Asset from the My Favorites List via Asset Details Page
Removing Multiple Assets from the My Favorites List
Renaming an Entry in the My Favorites List
Deleting an Entry from the My Favorites List
Managing Your Portlets
Viewing Your List of Portlets
Renaming a Portlet
Deleting a Portlet
Managing Your Inbox
Overview
Using the Inbox
How to Access Your Inbox
Creating a Notification Request
How to Create Notification Request for an Asset
How to Create Notification Request for Multiple Assets
Viewing Notifications You Have Received
Deleting a Notification Request
How to Delete Notification Request for an Asset
How to Delete Notification Request for Multiple Assets
Removing Notifications from Your Inbox
Using Refiners in Your Inbox
Using the Help Center
Access Business UI Help Center
What You Will Find in the Help Center
Introduction
All about Assets
Using Keyword Searching
Browsing the Catalog
Managing the Catalog
Collaborating on Assets
Working with Notifications
Customizing your Welcome Page
Updating Your User Profile
Further Resources
Customizing CentraSite i18n Messages
Understanding Message Bundles
Customizing i18n Messages
Fetching a Message Key
Changing a Message Value
Working with Organizations, Users, Groups, and Roles
Working with Organizations
Introduction
Displaying a List of Your Organizations
Adding an Organization
Viewing or Modifying Details of an Organization
Deleting an Organization
Working with Child Organizations
Add a Child Organization
View or Modify a Child Organization
Delete a Child Organization
Operations on Users, Groups, and Roles at the Organization level
Working with Users
Adding a User to an Organization
Viewing or Modifying Details of a User
Adding a User to a Group from the User Details View
Deleting a User from a Group from the User Details View
Deleting a User
Viewing or Deleting Assets of a User
View Assets of a User
Delete Asset Belonging to a User
Working with Groups
Adding a Group to an Organization
Viewing or Modifying Details of a Group
Adding a User to a Group from the Group Details View
Deleting a User from a Group from the Group Details View
Modifying or Deleting Groups
Working with Roles
Adding a Role to an Organization
Viewing or Modifying Details of a Role
Assigning a Role to a User or Group
Deleting Role Assignments from a User or Group
Delete a Role from the Set of Roles Assigned to a User or Group
Remove a User or Group from the Set of Users and Groups Assigned to a Role
Modifying a Role's Permissions
Assign Permission to a Role
Remove Permission from a Role
Deleting a Role from an Organization
Exporting and Importing Registry Objects Using Business UI
Introduction
Which Objects Can You Export and Import?
An Overview of the Export/Import Process
Exporting an Object
Importing an Object
Exporting and Importing Specific Object Types
Organizations
Asset Instances
Exporting Objects Using CentraSite Business UI
Importing Objects from an Archive Using CentraSite Business UI
Managing Assets
Introduction
Displaying Details of an Asset
Before You Begin
Viewing the Details of an Asset
Creating a New Asset in the Catalog
Who Can Create Asset to the Catalog?
Who Can Access the Assets that You Create?
Adding an Asset to the Catalog
Editing the Properties of an Asset
General
How to Edit the Attributes of an Asset
Viewing a List of Your Assets
Watching and Unwatching an Asset
Introduction
Watching an Asset
How to Watch an Asset
How to Unwatch an Asset
Watching or Unwatching a Set of Assets
How to Watch a Set of Assets
How to Unwatch a Set of Assets
Viewing the List of Watchers for Your Asset
Attaching a Document to an Asset
Overview
Attaching an Input File to an Asset
Attaching a WSDL File to a Service Asset
General
Restrictions
Attaching a Supporting Document to an Asset
Attaching Documents from a URL
Attaching Documents from the Computer's File System
Attaching Documents from the Supporting Document Library
Removing a Supporting Document from an Asset
Changing the Lifecycle State of an Asset
Introduction
Lifecycle Management
Who Can Change Lifecycle State of an Asset?
How to Change Lifecycle State of an Asset
Setting Permissions on an Asset
Who Can Set Permissions on an Asset?
Restricting Access to Specific Profiles
Ways in Which You Can Set Permissions
Setting Instance Level Permissions on an Asset
Selecting Users or Groups Using Search Option
Selecting Users or Groups Using Browse Option
Setting Instance Level Profile Permissions on an Asset’s Profile
Propagation of Permissions
Propagation of Instance Level Permissions
Propagation of Profile Level Permissions
Versioning an Asset
Generating New Asset Versions
Creating a New Version of an Asset
Creating a New Version of a Set of Assets
Locating Other Versions of an Asset
Changing the Ownership of an Asset
Introduction
User Ownership
Organizational Ownership
Who Can Change Ownership of an Asset?
Conditions that Must be Satisfied in Order to Change Ownership of an Asset
How to Change Ownership of an Asset
How to Change User Ownership of an Asset
How to Change the Organization of an Asset
Displaying Runtime Information for an Asset
The Runtime Metrics
Displaying the Runtime Metrics
The Runtime Events
Displaying the Runtime Events
Deleting an Asset
General
Deleting Assets
Deleting Assets
Deleting a Set of Assets
Downloading an Asset
Before You Begin
Performing the Zip Download
Downloading an Asset
Downloading a Set of Assets
Structure of the Zip File
Performing the Single Document Download
How to download a attached document from Supporting Document Library
How to download a WSDL / XSD document from Service/Schema
How to download a XSD document from REST / XML services
Exporting and Importing Assets
Before You Begin
Exporting Assets
Exporting a Single Asset
Exporting Multiple Assets in a Single Operation
Importing Assets
Managing the Catalog
About the Catalog
What does the Catalog Contain?
Who Can View the Catalog?
Browsing the Catalog
Performing a Quick Find by Browse
Searching the Catalog
Simple Search
Using Search Metacharacters in the Simple Search
Using Keywords
Using Wildcards
Performing a Simple Search
Advanced Search
Search by Keyword
Using Keywords
Search by Keyword
Search by Taxonomy
Search by Lifecycle Model
Search by Asset Type
Search by Attribute Values
Searchable Attributes
Generic Attributes
Type-Specific Attributes
Attribute Data Types
Configuring CentraSite's Expandable Property
Using the Search Result List
Managing the Search Results Page
Configuring the Search Results Page
Managing the Search Recipe
Search Filters
Defining a Search Recipe
Adding a Search Filter to the Recipe
Removing a Search Filter from the Recipe
Combining Search Filters
Rendering of Search Scopes
Saving and Re-Executing Saved Searches
Saving a Search Definition
Re-executing a Saved Search
Creating a New Search from a Saved Search
Adding a Custom Reporting Search from the Command Line
Writing Your Own Reporting Search
Writing an XQuery Module
Writing a Saved Search XML
Uploading Required Search Files from the Command Line
Activating the Reporting Search
Working with Approval Workflows
Predefined Approval Policies for CentraSite Business UI
What Happens When an Approval Action is Enforced?
Adding an Approval Policy to CentraSite
Reviewing Requests that You Have Submitted for Approval
Approving a Request
Approving a Pending Approval Request by a CentraSite Administrator
Reverting the State of an Asset That is Pending Approval
Message Handling and Diagnostics
Presenting Error Messages in CentraSite Business UI
Setting the Diagnostic Email Notification Configurations
Substitution Tokens
Using a Custom Message in Diagnostic Email Notification
Using Diagnostic Email Templates
Creating a Custom Email Template
Adding an Email Template to CentraSite
Working with Portlets
Portlet Types
Text Portlet
IFrame Portlet
Graphical Portlet
Tailor Your Portlets
Portlet Quick Facts and Links
Viewing Your Portlets
Adding a Portlet
Adding an Existing Portlet
Adding a New Portlet
Creating a Text Portlet
Creating an IFrame Portlet
Creating a Graphical Portlet
Adding the New Portlet to Your Welcome Page
Configuring a Portlet
Personalization Settings for Portlet Functions
Refresh Intervals for Portlets
Expanding or Collapsing a Portlet
Removing a Portlet
Rearranging Portlets
CentraSite Business UI Pluggable Architecture
Introduction
Customizing the Login Page
Introduction
Installing the Customized Login Page
The CentraSite Business UI Configuration Files
Configurations for a Custom Login Page
Customizing the Welcome Page
Introduction
Installing the Customized Welcome Page
Configurations for a Custom Welcome Page
Header Links
Search Scopes
Activity Menu
Browse Link
Portlets
About Customizing Content Pages
Extension Points for Customizing Content Pages
Log in to CentraSite Business UI
Request an Account
Extend Activity Menu by Additional Functions
Implement Activity as an Extension
Enable Activity through Configuration
Replace Standard Search Widget
Advanced Search Criteria
Browse Link
Browse Search Criteria
Extend Search View
Replace Standard Asset Detail Page
Add Action Menu
Implement Action as an Extension
Enable Action through Configuration
Add Portlet
Implement Portlet as an Extension
Enable Portlet through Configuration
Computed Runtime Actions
Implement Runtime Action as an Extension
Enable Runtime Action through Configuration
GWT Sample Code Location
Step-by-Step Guide for Customizing Content Pages
Installing an Extension
Eclipse Prerequisites
Setting up the GWT project
Setting the Classpath
Importing the GWT Project
Configuring an Extension
Uninstalling an Extension
Uninstalling a Single Extension
Uninstalling a Set of Extensions
Creating a Custom Extension
Built-in Portlets Reference
Summary of Portlets in the Design/Change-Time Category
Summary of Portlets in the Run-Time Category
Built-in Portlets for Design/Change-Time Category
Asset Instance Count Per Category for Taxonomy
Get Undelivered Access Tokens
Inbox Notifications
Instance Count Per State for Lifecycle Model
Instances Per Type
Last Created Assets
Last Updated Assets
Linked Instance Count Per Category For Taxonomy
My All List
My All Saved Searches
My API Keys
My Favorites
My List
My Pending Approval Requests
My Pending Consumer Registration Requests
My Saved Searches
Recent Lifecycle Changes
Top X Assets by Consumers
Top X Assets by Incoming Association
Top X Assets by Watchers
Top X Assets Consumed Per Organization
Top X Assets Provided Per Organization
Top X Assets with Watcher and Consumer Count
Top X Most Versioned Services
Built-in Portlets for Run-Time Category
Service Performance Metrics
Service Performance Metrics Over Time
Top X Consumers Based on Runtime Invocations
Top X Monitoring Events Per Service
Top X Services Based on Invocations
Top X Services Based on Payload Size
Top X Services Based on Runtime Errors
Top X Services Based on Runtime Policy Violations
OData Service Management
Overview of the OData Services
The Entity Data Model (EDM)
Metadata for OData Services
The CentraSite OData Model
EDMX to CentraSite OData Service Mappings
Registry and Repository Entries for an OData Service
Supported HTTP Methods for OData Resources
Sample OData Resource URLs
Creating OData Services
Creating an OData Service using EDMX File from the UI
Creating an OData Service using OData Importer from the UI
Creating an OData Service using OData Importer from the Command Line
Viewing the List of OData Services
Viewing or Modifying Details of an OData Service
Versioning of an OData Service
Changing the Ownership of an OData Service
Changing User Ownership of an OData Service
Changing Organization Ownership of an OData Service
Virtualizing OData Services
Publishing and Unpublishing OData Services to and from Gateways
Deleting OData Services
Deleting a Single OData Service
Deleting Multiple OData Services in a Single Operation
Managing Organizations
Introduction
Basic Organization Structure
The Default Organization
Planning Your Organization Structure
Who Can Create and Manage Organizations?
Organization Administrators and Primary Contacts
Adding a Top-Level Organization
Viewing or Editing the Properties of an Organization
Adding a Child Organization to an Organization
Deleting an Organization
Asset Navigator
Introduction
Graphical Visualization
Navigating to Asset Navigator from the Activity Bar
Navigating to Asset Navigator from the Actions Bar
Types of Charts
TreeChart Chart
SunBurst Chart
Icicle Chart
Graph Chart
Configuration Settings
Adding Custom Usecases
Managing Governance Rules
Working with Run-Time Policies
Actions that Run-Time Policies Can Execute
Supported Asset Type and Action Combinations
Who Can Create and Manage Run-Time Policies?
Adding a Run-Time Policy to CentraSite
Creating a New Run-Time Policy
Activating a Run-Time Policy
Deactivating a Run-Time Policy
Viewing the Run-Time Policy List
Viewing or Changing a Run-Time Policy
Specifying the Scope of a Run-Time Policy
System-Wide versus Organization-Specific Policy Enforcement
System-Wide Policies
Organization-Specific Policies
Modifying the Scope of a Run-Time Policy
Refining the Policy Scope
Assigning Actions to a Run-Time Policy
Modifying the Action List
Configuring Policy Action Parameters
Viewing the List of Virtual APIs to Which a Run-Time Policy Applies
Deleting a Run-Time Policy
Mediator Runtime Aliases
Defining the Runtime Aliases
Referencing the Runtime Aliases in Virtual Services
Publishing the Virtual Service
Using CentraSite with webMethods API-Portal
Before You Configure CentraSite for API-Portal
Roles and Permissions Needed to Create and Manage API-Portal Gateways
Configuring CentraSite, Mediator, and API-Portal
Displaying a List of Available API-Portal Gateways
Registering an API-Portal Gateway with CentraSite
Viewing or Modifying Details of an API-Portal Gateway
Setting Permissions on an API-Portal Gateway
Who Can Set Permissions on an API-Portal Gateway?
Setting Instance-Level Permissions on an API-Portal Gateway
Setting Instance-Level Profile Permissions on an API-Portal Gateway
API-Portal Specific Profiles in CentraSite
API-Portal Information Profile
CentraSite Communication Profile
API-Portal Communication Profile
Published APIs Profile
The Design/Change-Time Policies that are Used for API-Portal Communication
Configuring the Design/Change-Time Policies that are of use for API-Portal Gateway
Configuring the Publish to API-Portal Policy
Configuring the UnPublish from API-Portal Policy
Understanding Communication Between CentraSite and API-Portal
Retry Mechanism
Changing the Default Values for Retry Mechanism
Viewing Undelivered Access Tokens
Resending Undelivered Access Tokens
Rescheduling the Scheduler
Resending Access Tokens from the Command line
Sharing a Report Template with API-Portal
Unregistering an API-Portal Gateway from CentraSite
What Happens When You Unregister an API-Portal Gateway?
What Happens When Unregistration Fails?
What If You Need to Modify Unregistered API-Portal Gateways?
Unregistering a Single API-Portal
Unregistering a Set of API-Portals
Deleting an API-Portal Gateway
Deleting a Single API-Portal Gateway
Deleting a Set of API-Portal Gateways
Administering API Portal
About this Guide
Overview
Why do Organizations Expose APIs?
Why do APIs Need to be Managed?
What is webMethods API-Portal?
Configuring API-Portal
Before You Configure API-Portal
Security Considerations
Securing Client Requests
Preventing Use of the HTTP OPTIONS Method
Implementing Secure Password Policies
Sending Email Notifications
Configuring the SMTP Mail Server Connection for API-Portal
Configuring the SMTP Mail Server Connection for API-Portal using the User Management Component
Configuring the SMTP Mail Server Connection for API-Portal using ACC
Usage Reports
Creating a Usage Report
Configuring Ports
About Enabling or Disabling a Port
Disabling a Port
Enabling a Port
Testing for HTTPS Requests
Considerations for Machines with Multiple Network Interfaces
Reconfiguring the Load Balancer when you configure multiple API-Portal machines
Reconfiguring the Loadbalancer in case of a DMZ/Reverse Proxy Setup
Reconfiguring the Loadbalancer Settings
Updating the SSL Certificate
Configuring CentraSite, Mediator, and API-Portal
API-Portal Configuration Parameters
Preparing to Publish APIs to API-Portal
API-Portal License File
Importing the API-Portal License File using the ACC
Importing the API-Portal License File using the UMC
Registering Users in API-Portal
Registering for webMethods API-Portal
Configuring Approval Workflows for User Registration
Assigning Users to the Approver Group
Configuring the Approval Workflow
Working with Pending Approvals
Configuring Email Confirmation for User Registration
Configuring Automatic User Registration
View and Manage Users
Email Notifications Templates and Tokens
Customizing Email Templates
Email Tokens
Advanced Configuration of API-Portal
Configuring API-Portal with External Databases
Configure API-Portal with Microsoft® SQL Server 2012 or Microsoft® SQL Server 2014
Configure API-Portal with an Oracle Database
User Registration in API-Portal with Social Login
Configuring Google Login
Configuring Facebook Login
OAuth Properties for Social Login
Removing Social Login
Connecting to Specific Servers
High Availability setup in API-Portal
Setting up API-Portal HA setup
Managing Tenants
Creating tenants
Deleting Tenants
Managing API-Portal
Overview of Managing API-Portal
What Happens When You Start API-Portal?
Starting API-Portal (Windows)
Starting API-Portal (Linux/UNIX)
Stopping API-Portal (Windows)
Stopping API-Portal (Linux/UNIX)
Opening the API-Portal User Interface in a Browser
API-Portal Components
Verifying the Status of API-Portal Components
Understanding API-Portal Component Status in ACC
Starting and Stopping API-Portal Components
Managing Users
Overview of Managing Users
Users, Groups, Roles, and Permissions in CentraSite
Predefined Roles in CentraSite
Other Users in CentraSite
Predefined Roles in API-Portal
Other Users and Roles in API-Portal
Managing Communities
Overview of Communities
Managing API Assets
Planning for API Management
About API-Portal Assets
API-Portal Profile in CentraSite
Publishing and Unpublishing APIs to and from API-Portal
Handling Events
API-Portal Extension Points
Managing Third-party Key Management Providers
Managing Access Tokens
Managing API Packages and Plans
API Packages and Plans
Creating an API Package
Creating a Plan
Associating a Plan to a Package
Disassociating a Plan from an API Package
Deleting an API Package
Associating APIs with a Package
Disassociating APIs from an API Package
Associating Providers with a Package
Disassociating Providers from an API Package
Managing Data in API-Portal
Configuring Audit Logs
Purging Logs
Purging logs by invoking a REST service
Purging logs through the user interface
Back up and Restore Tenant Data
Prerequisites for Backup and Restore in a Distributed Environment
Using the ACC REST Service
Using a Configuration File
Back up Tenant Data
Restore Tenant Data
Troubleshooting Backup and Restore Failures
Working with REST-based APIs
About this Guide
Document Conventions
Online Information
About CentraSite RESTful API Model
Overview
REST APIs
Base URL
API Parameters
REST Resources
Resource URLs
Resource Parameters
Resource Methods
Supported HTTP Methods
Method Parameters
REST Parameters
Parameter Levels
API-Level Parameters
Resource-Level Parameters
Method-Level Parameters
Parameter Types
Query-String Parameters
Path Parameters
Header Parameters
Form Parameters
Parameter Data Types
Supported Content Types
Supported HTTP Status Codes
Sample Requests and Responses
Sample 1 - Retrieve a list of phones
Sample 2 - Find a phone that doesn't exist
Sample 3 - Create a phone
Sample 4 - Adjusting the phone name
Importing a RESTful API to CentraSite
Overview
Importing RAML Files
Importing a REST API Using RAML File
RAML to CentraSite REST API Mappings
Importing Swagger Files
Importing a REST API Using Swagger File
Swagger to CentraSite REST API Mappings
Creating a RESTful API from Scratch
Overview
Adding a REST API to CentraSite
Adding Base URL to REST API
Adding Resource to REST API
Adding HTTP Method to REST API
Adding Parameter to REST API
Adding HTTP Request to REST API
Adding HTTP Response to REST API
Adding Request and Response Messages to REST API
Managing RESTful APIs
Viewing a REST API
Using the Method-Centric View
Using the Resource-Centric View
Viewing the List of REST APIs
Viewing the Details of a REST API
Changing a REST API
Editing the Basic Details of a REST API
Editing the Extended Details of a REST API
Deleting a REST API
Deleting an API from the API Details Page
Deleting APIs from the Search Results Page
Generating Swagger 2.0-Compliant File for a RESTful API
Getting Started with CentraSite
Introducing CentraSite
CentraSite's Role in Today's SOA
Today's SOA Challenges
Where CentraSite Fits in Today's SOA
Support for the SOA Design-Time Environment
Asset Management and Governance
Support for the SOA Run-Time Environment
Use of CentraSite by Other Products
Features
The Registry
The Catalog
The Repository
Design/Change-Time Policies
Run-Time Policies
Virtual Services
Lifecycle Management
Reporting
Impact Analysis
Security and Auditing
Role-Based Access
Federation with Other Registries
GUI Access to CentraSite
API Access to CentraSite
Topology and Architecture
Basic Topology
Architecture
The Information Model
Overview
Objects in the Information Model
Relationships Between Objects in the Registry
CentraSite Editions
Implementation Concepts
Implementation Decisions and Configuration Tasks
Issues to Consider Before Implementation
Configuration Checklist
Choosing a Deployment Strategy
Deploying to Support Your SDLC
Deployment Options
Deployment Considerations
Defining Your Organizational Structure
What is an Organization?
The Default Organization
Child Organizations
Consumer Organizations
Modeling Your Organizations
Choosing an Organizational Strategy
Users, Groups, Roles, and Permissions
Users
User Authentication
Predefined Users
Activating or Deactivating Users
Groups
Permissions and Roles
Instance-Level Permissions
Roles and Role-Based Permissions
System-Level Role-Based Permissions and Predefined Roles
Organization-Specific Role-Based Permissions and Predefined Roles
Considerations when Working with Instance-Level and Role-Based Permissions
Configuring the Default Roles that CentraSite Assigns to Users in an Organization
Customizing Your Asset Catalog
Creating Custom Types
Object Types vs. Asset Types
Customizing the Predefined Asset Types
Creating Custom Asset Types
Assigning Attributes to a Type
Assigning Attributes to Profiles
Creating Custom Asset Types that can be Imported from an Input File
Defining and Using Taxonomies
Classifying Assets Using Taxonomies
How Taxonomies Help Users Locate Assets
Using Taxonomies to Target the Execution of Design/Change-Time Policies
The Scope of a Taxonomy
The Predefined Taxonomies
Defining Custom Taxonomies
Creating Custom Association Types
How Association Types Are Used to Relate Assets to Other Objects
How Association Types and Relationship Attributes Support Impact Analysis
Creating Custom Association Types
Working with Asset Types, Taxonomies and Association Types in a Multi-Stage Environment
Issues to Consider when Customizing Your Registry
Defining Lifecycle Models
How Lifecycle Models Help You Organize Your Assets
How Lifecycle Models Help You Govern Your Assets
Lifecycle Model States and Transitions
Assigning Permissions to Lifecycle Model States
Triggering Policies during Lifecycle Model Transitions
Associating a Lifecycle Model with an Asset Type
When to Use Lifecycle Models
Lifecycle Stages
Creating a Lifecycle Model for a Single-Stage Environment
The Proposed State
The Design State
The Test State
The Available State
The Canceled State
The Deprecated State
The Retired State
Issues to Consider When Using Lifecycle Models in a Single-Stage Environment
Creating a Lifecycle Model for a Two-Stage Environment
The Lifecycle Model on the Creation Registry
The Promoted State
The Lifecycle Model on the Consumption Registry
Issues to Consider When Using Lifecycle Models in a Two-Stage Environment
Updating Assets That Are Under Lifecycle Management
Creating a Different Lifecycle Path for a New Version of an Asset
Reverting an Asset to a Previous State
Managing Lifecycle Models
Activating a Lifecycle Model
Versioning or Replacing Lifecycle Models
Modifying the Predefined Lifecycle Model for Lifecycle Models
Defining Design/Change-Time Policies
What is a Design/Change-Time Policy?
Policy Actions
Policy Scope
Refining a Policy's Scope with Additional Selection Criteria
Scope of a Policy Action
System-Wide vs. Organization-Specific Policies
Policy Priority
Pre-Operation and Post-Operation Event Types
What Happens When a Design/Change-Time Policy Executes?
OnTrigger Policies
Typical Uses for Design/Change-Time Policies
Using Policies to Initiate Reviews and Approvals
Using Policies to Validate Assets
Using Policies to Modify Assets
Using Policies to Issue Notifications or Update External Systems
Using Policies to Execute a Consumer Registration
Using Policies to Manage the Deployment of Virtual Services
Issues to Consider When Developing Design/Change-Time Policies
Managing Design/Change-Time Policies
Activating a Design/Change-Time Policy
Modifying a Design/Change-Time Policy
Copying a Design/Change-Time Policy
Modifying the Predefined Lifecycle Model for Policies
Working with Versions and Revisions
What is Versioning?
Which Objects Can You Version?
What is a Revision?
System-Assigned Version Identifiers vs. User-Assigned Version Identifiers
Using Versions to Avoid Enforcement Gaps in Policies and Lifecycle Models
When Should You Version an Asset?
How Do Lifecycles and Versioning Relate?
Managing the Transition to a New Version
Versioning in CentraSite vs. Versioning in Source Code Control Systems (SCCS)
Cleaning Up Old Versions
Planning Your Run-Time Environment
Basic Components in the Run-Time Environment (when using webMethods Mediator as the PEP)
Deploying for Run-Time Governance
An Overview of the Creation Run-Time Environment
An Overview of the Consumption Run-Time Environment
General Concept of Operations between the Environments
Implementing the Mediation Environment
Managing the Collection of Metrics
Managing the Collection of Events
Using CentraSite with Other Policy Enforcement Points
Defining Run-Time Policies
Run-Time Policy Scope
Refining the Run-Time Policy's Scope with Additional Selection Criteria
Run-Time Policy Actions
Run-Time Policy Deployment
Creating and Testing Policies
Distributing the Development of Policies
Activating a Run-Time Policy
Modifying a Run-Time Policy
Lifecycle Model for Policies in a Multi-Stage Deployment of CentraSite
Managing Virtualized Services
Which Services Should You Virtualize?
Virtualizing Business Services at the Point of Consumption
Virtualizing Shared Services
Virtualizing Services that are in Different Domains of Control (for example, Cloud Computing)
The Basic Elements of a Virtual Service
Virtual Service Processing Steps
Entry Protocol Step
Request Processing Step
Routing Step
Using the Routing Step to Direct Requests across Multiple Endpoints
Response Processing Step
Configuring for Virtual Services
Defining Gateways
Defining a Lifecycle Model for Services and Virtual Services
Understanding the Lifecycle for Services and Virtual Services
Creating the Lifecycle Model for Services and Virtual Services
Defining a Lifecycle Path that Enables Deployment of a Virtual Service
Creating a Policy that Enables the Deployment Profile
Creating a Policy that Disables the Deployment Profile
Creating Virtual Services
When Should You Create a Virtual Service?
Who Should Create a Virtual Service?
Virtual Service Ownership
Deploying a Virtual Service
The Deployment Process
Undeploying a Virtual Service
Redeploying a Virtual Service
Revising a Virtual Service
Minor Versions vs. Major Versions
The Layer of Indirection Pattern
The Adapter Pattern
Combination of the Layer of Indirection Pattern and the Adapter Patterns
Identifying the Consumers of Virtual Services
The Concept of Consumers
How Are Consumer Applications Represented and Used in CentraSite?
How Does Mediator Identify Consumer Applications at Run Time?
Defining Application Assets in CentraSite
Synchronizing the Application Assets in CentraSite with the Mediator
Deciding How to Identify a Consumer Application
Registering an Application Asset with a Virtual Service
The Consumer Registration Process
The Consumer-Registration Policy
Issues to Consider when Defining Applications
Managing Endpoints
Multiple Endpoints
Who Uses Endpoint Information?
How Service Endpoints are Represented in CentraSite
Managing the Endpoints of a Native Service over its Lifecycle
Example of the Bindings for a Service in a Single-Stage Registry
Example of the Endpoints for a Service in a Two-Stage Registry
Adopting a Naming Convention for Binding Names
Managing Endpoints of a Virtual Service over its Lifecycle
Publishing the Test Endpoint for a Virtual Service on the Consumption Registry
Deploying Multiple Virtual Services for a Single Native Service
Using the Asset Navigator Tool to Find the Virtual Services for a Native Service
Administering CentraSite
Basic Operations
Overview of Basic Operations
Starting and Stopping the Application Server Tier and Registry Repository
Administering the License Key
Relationship Between the License Key and Editions
Identifying the Edition of CentraSite You Are Using
Changing the License Key
Working with Time-Limited Licenses
Configuring CentraSite
Configuring Application Server Tier
Changing the Default Java Location for CentraSite
The Java Service Wrapper
The Java Service Wrapper Configuration Files
JVM Configuration
JVM Configuration Properties
The Wrapper Log
Logging Properties
Fault Monitoring
JVM Timeout Properties
Deadlock-Detection Properties
Console Filtering Properties
Generating a Thread Dump
Configuring a Proxy
Configure an HTTP Proxy
Configure an HTTPS (SSL) Proxy
Print on UNIX and Linux Systems
Configuring UDDI
Configuring CentraSite to Use Terracotta BigMemory
Setting Up CentraSite Eclipse Plug-Ins
Installing CentraSite Plug-ins in Your Own Eclipse Environment
Connecting Eclipse to the CentraSite Data Source
Using CentraSite Online Documentation
Installing Adobe Flash Player
Maintaining the CentraSite Internal Database
Repository Monitoring
Database Activity
Space Usage
Backing Up the Database
Restoring the Database from a Backup
Deleting a Backup
Moving a Database to Another Location
Locations
Listing the Currently Defined Locations
Changing the Currently Defined Path of a Location
Database Configuration Parameters
Reclaiming Disk Space in the CentraSite Database
How to Reclaim Disk Space in the CentraSite Database
Setting Up Replication Instances of the Registry Repository
Configuring the Authentication Settings
Listing Names of All of the Configurations
Listing Details of a Particular Configuration
Setting the Default Configuration
Adding a Configuration
Modifying a Configuration
Removing a Configuration
Configuring Port Numbers
Changing the Port Numbers of the Registry/Repository
Changing a Port Number on the Registry/Repository Host
Changing the Software AG Runtime Port Numbers
Configuring Secure Communication Between Components
Secure Communication Between the CRR and the CAST
Setting the Security Configuration for the Registry Repository
Creating a RR Configuration File to Define Security Values
Executing the RR Configuration File that Invokes Security Values
Setting the Security Configuration for the CAST Components
Creating a AST Configuration File to Define Security Values
Executing the AST Configuration File That Invokes Security Values
Obtaining the Security Configuration of Registry Repository
Obtaining the Security Configuration of CAST Components
CAST Stores
Identifying the Communication Method Between CAST and CRR
Allowing HTTP Communication Between CAST and CRR
Secure Communication Between Software AG Runtime and External Clients
Overview
Software AG Runtime Properties File for SSL Communication
SSL Keystore
SSL Truststore
Note on SSL Port Number
Secure Communications with CentraSite for Synchronous Deployment
Anatomy of a SSL Connection
SSL Connection Type
As an SSL Client
As an SSL Server
Roadmap for Configuring SSL
Creating Keys and Certificates
Creating a Keystore and Truststore
Obtaining the Certificates and Keys of the webMethods Mediator
Keystores and Truststores
Keystore File
Truststore File
How CentraSite Uses a Keystore and Truststore
Protecting Keystore and Truststore Files
Configuring CentraSite to Use SSL
Configure CentraSite Client to Use One-way SSL
Configure CentraSite Client to Use Two-way SSL
Using the CTP Server.xml File for SSL
Configuring webMethods Integration Server to Use SSL
Configure Integration Server to Use One-way SSL
Configure Integration Server to Use Two-way SSL
Configuring webMethods Mediator to Use SSL
Configuring the Registry Cache Settings
Prerequisites
Displaying the Cache Configuration
Modifying the Cache Configuration
Option: maxElementsOnHeap
Option: maxElementsOffHeap
Option: memoryStoreEvictionPolicy
Option: statistics
Configuring the Email Server
Configuring the Email Server Settings
Getting the Email Server Settings
Overview of the Administration Tools
Overview of the inoadmin Command
Return Codes from inoadmin Command Execution
Overview of the CentraSite Command
Overview of the Toolbox Script
Usage of the CentraSite Command Tools
Setting Your User Preferences from the Command Line
Updating Your User Preference Settings
Viewing Your User Preference Settings
Reconstructing Your User Preference Settings
Deleting Organizations from the Command Line
Managing Gateways from the Command Line
Listing Existing Gateways
Creating a New Gateway
Configuration File
Deleting an Existing Gateway
Publishing and Unpublishing APIs to and from Gateways from the Command Line
Publishing APIs to Gateways
Unpublishing APIs from Gateways
Managing Reports and Scheduled Reports from the Command Line
Listing Existing Reports
Adding a New Report
Report Configuration File
Updating an Existing Report
Deleting an Existing Report
Sharing a Report with API-Portal
Downloading an Existing Report Template
Listing Existing Scheduled Reports
Adding a New Scheduled Report
Scheduled Report Configuration File
Updating an Existing Scheduled Report
Deleting an Existing Scheduled Report
Triggering an Existing Scheduled Report
Listing Asset Types Associated to a Report
Associating an Asset Type to a Report
Remove the Existing Association Between an Asset Type and a Report
Managing Access Tokens from the Command Line
Restoring Expired Access Tokens
Purging Expired or Inactive Access Tokens
Managing Run-Time Event Store from the Command Line
Fetching the State of Run-Time Event Store
Changing the Storage Mode of Run-Time Event
Purging the Run-Time Events
Fetching Details of the Migrated Pending Consumer Registrations from the Command Line
Usage of the CentraSite Toolbox Scripts
Checking the Sequence Order for Asset Profiles from the Command Line
Bulk Importing Assets from the Command Line
Managing Asset Types from the Command Line
Creating a New Asset Type
Creating a New Virtual Asset Type
Deleting an Existing Virtual Asset Type
Updating Policy Actions from the Command Line
Deleting Virtual Services from the Command Line
Logging On and Using the UIs and APIs
Your User Account
User Accounts
Ways to Interact with CentraSite
CentraSite User Interfaces
CentraSite Control
CentraSite Plug-ins for Eclipse
CentraSite Business User Interface
Application Program Interfaces (APIs) to CentraSite
Using the User Interface
Starting CentraSite
Navigation Controls in the User Interface
Context Menus
Actions Menu
Setting Display Options in CentraSite Control
Restricting the Locale
Viewing/Editing Information About Your User Account
Working with My Favorites
Viewing My Favorites
Adding Shortcuts to Individual Objects
Adding Shortcuts to Multiple Assets in a Single Operation
Adding a List of Objects to My Favorites
Adding Multiple Objects to a List in a Single Operation
Removing an Object from a List
Adding a Saved Search to My Favorites
Viewing or Editing a Saved Search
Adding an XQuery to My Favorites
Adding a Category List to My Favorites
Adding a Type List to My Favorites
Removing Entries from My Favorites
Renaming an Entry in My Favorites
Working with Notifications
Creating a Notification Request
Creating Notification Requests for Multiple Assets in a Single Operation
Viewing Notifications You Have Received
Deleting a Notification Request
Authentication Topics and LDAP
Overview of Authentication Topics and LDAP
Overview of User Repositories
Selecting a User Repository for Authentication
Domain Names of User Repositories
Default User Repository
Creating Authentication Configurations
Commands for Creating and Maintaining Authentication Configurations
Specifying the Domain Name
Mapping User and Group Fields
File Structure of Login Authentication Configuration
Configuring the Internal Authentication Type
General
Administration of Users and Passwords for Internal Authentication
Configuring the LDAP Authentication Type
Principles of Configuring Against LDAP
Performing the LDAP Configuration
LDAP Server Configuration
User Information Configuration
User Mapping Configuration
Group Information Configuration
Group Mapping Configuration
Group Resolution Configuration
Technical Principal for LDAP
Background
Example of Configuring LDAP Authentication
Performing Maintenance on Authentication Configurations
Editing an Existing Authentication Configuration
Deleting an Existing Authentication Configuration
Setting a New Default Authentication Configuration
Creating an Administration User from the Command Line
Logging of Login Authentication Messages
Purpose of Log Files
Activating the Authentication Logging
Transforming and Migrating Internal and LDAP Configuration Data
Creating a Technical User for Reconfiguring Migrated Configuration
Securing Login Information of a Technical User
Listing Details of SSX-Based Authentication Configuration
Notes on Authentication in CentraSite
Case Sensitivity
Working in an Offline Environment
Users, Groups, Roles, and Permissions
Adding and Managing Users
Required Permissions
Add Users
Add a User and Associate with an External Authentication System Account
Select Users or Groups from the Operating System User Repository
Select Users or Groups from an Active Directory or LDAP Repository
Bulk Load Users from the External Authentication System
Add Users from an External Authentication System from an Organization's Users Tab
Add a User to a Locally Managed Group
Assign Roles to a User
Activate or Deactivate a User
Activate or Deactivate a User from the Users Page
Activate or Deactivate a User from the Edit User Page
Activate or Deactivate Users from the Edit Organization Page
Modify User Information
Reassociate Users
View a User’s Assets
Delete Users Using CentraSite Control
Delete Users from the Command Line
Move Users to a Different Organization
Adding and Managing Groups
Required Permissions
Add a Locally Managed Group
Add an Externally Managed Group
Bulk Load Groups from the External Authentication System
Assign Roles to a Group
Modify a Group
Delete Groups
Managing Roles and Permissions
Set Instance-Level Permissions
Required Permissions to Create and Manage Roles
Create a Custom Role
Modify a Custom or Predefined Role
Delete Custom Roles
Changing Passwords of Predefined Users and Login Users
Change the Password for a Predefined User
Change the Password for a Login User in the Password Store
Changing the SNMP Authentication Settings
AES192 and AES256 Protocol
Importing/Exporting Registry Objects
Introduction
Which Objects Can You Export and Import?
Overview of the Export/Import Process
Exporting an Object
How the Export Process Handles Object Ownership
How the Export Process Handles Instance Level Permissions
Objects That CentraSite Includes When It Exports an Object
Objects That CentraSite Does Not Include When It Exports an Object
Exporting Objects That Use Custom Associations
How the Export Process Handles Supporting Documents
How the Export Process Handles Other Versions of an Object
Exporting Objects Between Different Versions of CentraSite
Importing an Object
Understanding Object Identity
What Happens When an Imported Object Already Exists in the Target Registry?
How the Import Process Assigns the Ownership of an Imported Object
How Referenced Objects Are Handled During Import
How Lifecycle State Is Handled During Import
What Policies Are Triggered During an Import
Promotion
Exporting and Importing Specific Object Types
Organizations
Users
Asset Types and Virtual Types
Taxonomies
Lifecycle Models
Design/Change-Time Policies
Asset Instances
Report Templates
BPM Process Project
Integration Server Assets
Exporting and Importing Objects Using CentraSite Control
Exporting Objects Using CentraSite Control
Importing Objects from an Archive Using CentraSite Control
Hints for Importing
Handling of Missing Required Attributes of Assets When Importing
Exporting and Importing Objects from the Command Line
Exporting Objects from the Command Line
Importing Objects from an Archive Using the Command Line
Importing Objects Using the API
Overview of Importing Objects Using the API
Invoking an Importer from a Java Program
Importing a Web Service
setDescription
setOrganization
setOrganization
setPackageName
setPackageObject
setUsedObject
setUsesObject
setWebDAVFolder
Updating a Registered Web Service
Attaching a WSDL to a Registered Web Service
setAttachServiceID
Removing a Registered Web Service
removeService
removeServices
removeServiceByID
setDeleteTargetAssocs
setRemoveReferencedImports
setRemoveWsdl
Finding a Registered Web Service
findWebServiceByNamespace
findWebServices
Importing a Schema
Removing a Schema
remove
remove
removeCascading
removeCascading
Importing a BPEL Process File
setProjectName
setWarningIfPLTNotFound
Removing a Registered BPEL Object
remove
removeProcess
Importing an XPDL File
setOrganization
SetOriginalFilename
setProductConcept
setVersion
Invoking an Importer from a Java Class
Creating a Script File to Invoke an Importer
Creating a Script File for Windows (a .bat File)
Creating a Script File for UNIX (C-Shell Script)
Importer Class Names
Executing the Script File That Invokes an Importer
Importing a Web Service
Invoking the Web Service Administrator from the Command Line
Importing an XML Schema
Invoking the XML Schema Administrator from the Command Line
Importing an XML Service
Importing a REST Service
Importing a BPEL Process
Invoking the BPEL Administrator from the Command Line
Importing an XPDL File
Invoking an Importer From the Command Line
Importing a Web Service
Importing a REST Service
Importing an XML Schema
Importing a BPEL Process
Importing an XPDL File
Importing an Archive
Invoking an Importer Using the SOAP API
Viewing the WSDL for the Importers
Writing Your Own Importer
The Build Environment
The Plug-In Environment
Propagating the Plug-In
Generating all additionally needed files
Activating the Plug-In
Deactivating the Plug-In
Object Type Management
What Is a Type?
What is a Virtual Type?
The Properties of a Virtual Type
Basic Components of a Type
Attributes
Basic Attributes
Computed Attributes
Attribute Data Types
Attribute Names
Profiles
Generic Profiles
Computed Profiles
Assigning Permissions on Profiles
Who Can Create and Manage Types?
Creating a New Type
Before You Begin
Creating a New Type
Define Attributes for a Type
General Procedure
Using the Dialog
Defining Data Types
Defining a Computed Attribute
Implementation Guidelines for Java-Based Computed Attributes
Structure of Archive File
Sample Code
Loading a Computed Attribute into an Asset Type Definition
Define Profiles for an Asset Type
General Procedure
Defining a Computed Profile for CentraSite Control
Definition of Java-Based Computed Profile
Implementation Guidelines for Java-Based Computed Profiles
Structure of Archive File
Sample Computed Profiles
Load a Computed Profile into an Asset Type Definition
Defining a Computed Profile for CentraSite Business UI
Definition of Java-based Computed Profile
The Build Environment
Implementation Guidelines for Computed Profile
Structure of Archive File
Sample Computed Profile
Loading a Computed Profile into an Asset Type Definition
Viewing or Editing a Type
Before You Begin
How to View or Edit an Asset Type
How to View Multiple Asset Types
Removing an Attribute Using the Command Line Tool
Configuring Inheritance for Base Type Profiles, LCMs, and Policies
Inheriting Base Type Profiles to Sub Types
Cloning Base Type Profiles in Sub Types
Excluding Sub Types From CentraSite Business UI Search
Predefined Asset Types in CentraSite
Predefined Asset Types Installed with CentraSite
Modifications You Can Make to CentraSite's Core Asset Types
Customizing the User and Organization Types
Deleting a Type
Deleting an Asset Type
Deleting Multiple Asset Types in a Single Operation
Working with Composite Types
Shared vs Nonshared Components
Required Objects
Collectors
Defining Composite Asset Types
Semantics of Relationships and Operations
Association Relationship
Aggregation Relationship
Composition Relationship
Operation: Deleting an Asset
Operation: Creating a New Version of an Asset
Operation: Exporting an Asset
Operation: Setting Instance Permissions on an Asset
Operation: Moving an Asset to Another Organization
Operation: Changing the Owner of an Asset
Extended Rules
Changing Relationships
Updating Assets
Usage Scenarios
Overview
Delete Usage Scenarios
Association Relationship
Aggregation Relationship with Containing Constraint on Type A
Aggregation Relationship with Containing Constraint on Type B
Composition Relationship with Containing Constraint on Type A
Composition Relationship with Containing Constraint on Type B
Composition Relationship with Permission Scenario
Versioning Usage Scenarios
Versioning of IoB
Versioning of IoA
Permission Usage Scenarios
Association Relationship Permission Propagation
Composition/Aggregation with Weak Propagation
Composition/Aggregation Relationship Updating Sub-component
Composition/Aggregation Relationship with Full Propagation
Export Usage Scenarios
Export with Association Relationship
Export with Composition/Aggregation Relationship
Move Organization Usage Scenarios
Move Organization with Association/Aggregation Relationship
Move Organization with Composition Relationship
Change Ownership Usage Scenarios
Change Ownership with Association/Aggregation Relationship
Propagation of Profile Permissions
Predefined Composite Asset Types
Service
Virtual Service
XML/REST Service
Virtual XML/REST Service
OData Service
Virtual OData Service
XML Schema
BPEL Process
WS-Policy
BPM Process Project
BPM Process Step
IS Service Interface
Process
Process Pool
Process Swimlane
Web Application
Portlet
CAF Task Type
TN Group
Business Rules Project
Data Model
Working with Association Types
Who Can Create and Manage Association Types?
Adding an Association Type
Editing the Properties of an Association Type
Deleting an Association Type
Deleting a Single Association Type
Deleting Multiple Association Types in a Single Step
Customizing Lifecycle Management
Overview of Customizing Lifecycle Management
Overview of Lifecycle Management
Lifecycle Models
Stages for Lifecycle Registries
Defining a Lifecycle Model in CentraSite
States for Registry Objects
Applying Lifecycle Models to Asset Types
Applying Lifecycle Models to Virtual Types
Who Can Create and Manage Lifecycle Models?
Viewing or Editing a Lifecycle Model
Viewing and/or Editing a Lifecycle Model
Viewing Multiple Asset Types
Creating a Lifecycle Model
Defining the Basic Attributes of the Model
Defining the States and State Transitions of the Model
Associating an Asset Type with the Model
Defining the User and Group Permissions Associated with the States
Defining Policies Associated with the Model
Creating Lifecycle Stages
Defining Stage Transitions
Validating and Saving the Model
Activating a Lifecycle Model
Updating a Lifecycle Model
Deleting a State from a Model
Deleting a Lifecycle Model
Deleting the Most Recent Version of a Lifecycle Model
Deleting a Version and All Older Versions of a Lifecycle Model (Purging)
Deleting Multiple Lifecycle Models in a Single Operation
Lifecycle Model for Lifecycle Models (LCM for LCMs)
The Predefined Lifecycle Models Installed with CentraSite
Taxonomies
Introduction
Who Can Create and Manage Taxonomies?
Visibility of Taxonomies in CentraSite
Creating a Taxonomy
Adding a Taxonomy Using the Control UI
Adding a Taxonomy Using the Business UI
Associating Taxonomy to an Object Type
Setting Permissions on a Taxonomy
Viewing the Taxonomies List
Viewing the Taxonomies List from Control UI
Viewing the Taxonomies List from Business UI
Viewing or Editing the Properties of a Taxonomy
Viewing or Editing the Properties of a Taxonomy Using the Control UI
Viewing or Editing the Properties of a Taxonomy Using the Business UI
Adding a Category
Viewing or Editing the Properties of a Category
Deleting a Category
Deleting a Taxonomy
Deleting a Taxonomy Using the Control UI
Deleting a Taxonomy Using the Business UI
Predefined Taxonomies Installed with CentraSite
Logging
Overview of Logging
System-Defined CentraSite Logs
Configuring Logs
Configuring Log Settings from the Command Line
Creating a Configuration File to Define Log Setting
Define a Log Unit
Define Log Settings
Executing the Log Setting Command Tool
Monitoring Logs
Policy Log
Approval History Log
Audit Logs
Run-Time Event Logs
Run-Time Performance Logs
Audit Logs for User Information
Starting the Audit Logs
Storing the Audit Log Data
Overview of Purging
Purging Logs
Purging Log Records Using the Command Line Tool
Creating a Log Purging Configuration File
Define a Log Purge Setting
Define a Log Purge Type
Executing the Log Purging Command Tool
Exporting the Purged Log Records
Exporting the Purged Log Records from the Command Line
Configuring the Purger Properties for High Volume Data Handling
Removing Leftover Auditable Events
Registry Federations in CentraSite
Overview of Registry Federations in CentraSite
Overview of the Federation Process
Creating a Federation Configuration File
Adding a UDDI Federation to the Federation List
Triggering the UDDI Federation
Removing a UDDI Federation from the Federation List
Displaying the List of Target Registries Defined for Federation
Mapping UDDI Object IDs and tModels
Key Generator Processor
Adding a Key Generator Processor for Federation
Removing a Key Generator Processor
Taxonomy Processor
Adding a Taxonomy Processor
Removing a Taxonomy Processor
Users and Access Rights
Suite Usage Aspects
Overview of Suite Usage Aspects
Versioning Assets
Modifying or Deleting Assets
Publishing an Asset
Communication with Designer UI
Remote Connection from Designer
User Accounts
UDDI Clients
Using CentraSite with ARIS
Profile for ARIS Properties
Configuring CentraSite for Use with ARIS
Lifecycle Models That ARIS Uses
BPM Process Lifecycle Model
Service Lifecycle Model
Customizing the Predefined Lifecycle Model for Process Objects
Design/Change-Time Policies That ARIS Uses
Activating the Lifecycle Models and Design/Change-Time Policies That ARIS Uses
Activating the ARIS-Related LCMs and Policies
Configuring the ARIS Change-Notification Policies
Configuring the Enforce Unique Name Policy
Configuring the Reset Lifecycle State to Initial State Policy
Activating the ARIS-Related LCMs and Policies in CentraSite
Activate Policies for ARIS from a Java Class
Activate Policies for ARIS from a Command Line
Creating a Script File for Activating the ARIS LCM and Policies
Provisioning CentraSite Services into ARIS Architect
Object Type Representation for Integration Server Service
Object Type Representation for Web Service
Run-time Governance with CentraSite
Overview of Run-Time Governance
Components of the Run-Time Governance Environment
Run-Time Gateways
Virtualized Services in CentraSite Control
Virtualizing APIs Using the CentraSite Business UI
Run-Time Governance Reference Information
Consumer Applications
Introduction to Consumer Applications
Roles and Permissions Needed to Create and Manage Consumer Applications
Creating and Managing Consumer Applications
Overview
Adding and Managing Consumer Applications Using CentraSite Control UI
Adding a Consumer Application
Modifying Consumer Application Details
Configuring Consumer Application Profiles
The Identification Profile
The Permissions Profile
The Versions Profile
The Subscriptions Profile
The Audit Log Profile
The Object-Specific Properties Profile
Deleting Consumer Applications
Adding and Managing Consumer Applications Using CentraSite Business UI
Creating a Consumer Application
Modifying Consumer Application Details
Configuring Consumer Application Profiles
The Identification Profile
Deleting Consumer Applications
Registering Application Assets as Consumers of an Asset
Deploying or Publishing Consumer Applications to Gateways
Overview
Deploying Consumer Applications Using CentraSite Control UI
Publishing Consumer Applications Using CentraSite Business UI
Publishing Consumer Applications from the Search Results Page
Publishing a Consumer Application from the Actions Bar
Deploying Consumer Applications from the Command Line
Write a Script File to Invoke Deployment Operation (for Windows)
Write a Script File to Invoke Deployment Operation (for UNIX)
Synchronizing Consumer Applications in Mediator from the Command Line
Viewing the Deployment History Log Using CentraSite Control UI
Consumer Registrations
Introduction to Consumer Registration
Scope of Consumer Registration at Design-Time
Scope of Consumer Registration at Run-Time
Registering Application Assets as Consumers of an Asset
Permissions Needed to Register Consumers
The Design/Change-Time Policy Used for Consumer Registration
Implementing Consumer Registration
Overview
Design-Time Consumer Registration Scenario
Run-Time Consumer Registration Scenarios
Scenario A: Virtual Service without API Consumption Settings and Evaluate Policy Actions
Scenario B: Virtual Service without API Consumption Settings and with Evaluate Policy Actions
Scenario C: Virtual Service with API Consumption Settings and without Evaluate Policy Action
Scenario D: Virtual Service with API Consumption Settings and Evaluate Policy Action
Viewing Consumer Registration Requests
Monitoring Consumer Count of an Asset
Viewing or Modifying Details of a Consumer
Unregistering an Existing Consumer
Unregistering an Existing Consumer from the Consumed Asset Details Page
Unregistering an Existing Consumer from the Consumer Asset Details Page
Run-Time Gateways
Introduction to Gateways
Who Can Create and Manage Gateways?
Creating and Managing Gateways
Overview
Creating a Gateway Asset
Configuring Gateway Details
Deleting a Gateway Instance
Virtualized Services in CentraSite
Introduction to Virtualized Services
The Predefined Asset Types Installed with CentraSite for Virtualization
Who Can Create and Manage Virtual Services?
Creating Virtual Services
Creating a Virtual Service from Scratch
Virtualizing an Existing Service
Configuring SOAP-based Virtual Services
The Entry Protocol Step (SOAP)
The Request Processing Step (SOAP)
The Response Processing Step (SOAP)
The Routing Protocols Step (SOAP)
“Straight Through” Routing (SOAP)
“Content-based” Routing (SOAP)
Creating a Routing Rule for “Content-based” Routing (SOAP)
“Context-based” Routing (SOAP)
Creating a Routing Rule for “Context-based” Routing (SOAP)
“Load Balancing” Routing (SOAP)
The Routing Protocol for Services Exposed over JMS (SOAP)
Viewing REST/XML-based Virtual Services
The Entry Protocol Step (REST/XML)
The Request Processing Step (REST/XML)
The Response Processing Step (REST/XML)
The Routing Protocols Step (REST/XML)
The “Straight Through” Routing Protocol Step (REST/XML)
The “Content-based” Routing Protocol Step (REST or XML)
The “Context-based” Routing Protocol Step (REST or XML)
The “Load Balancing” Routing Protocol Step (REST or XML)
Viewing or Editing Virtualized Services
The Summary Profile
The Technical Details Profile
The Specification Profile
The Consumers Profile
The Permissions Profile
The Policies Profile
The Deployment Profile
The Performance Profile
The Events Profile
Revising Virtualized Services
Creating Run-Time Policies
Actions that Run-Time Policies can Execute
Who Can Create and Manage Run-Time Policies?
Creating a Run-Time Policy
Setting Permissions on a Run-Time Policy
Who Can Set Permissions on a Run-Time Policy?
Assigning Permissions to a Run-Time Policy
Activating a Run-Time Policy
Deactivating a Run-Time Policy
Viewing the Run-Time Policy List
Modifying a Run-Time Policy
Viewing or Changing a Run-Time Policy
Modifying Actions for a Run-Time Policy
Modifying the Actions List
Modifying Action Parameters
Modifying the Scope of a Run-Time Action
Viewing the List of Services To Which a Run-Time Policy Applies
Deleting a Run-Time Policy
System-Assigned vs. User-Assigned Version Identifiers
Asymmetric Binding Configuration
Asymmetric Binding
The Asymmetric Binding Components
Initiator Token Inclusion
Recipient Token Inclusion
Algorithm Suite
Layout
The Asymmetric Binding Configuration Command Tool
get Asymmetric Binding
set Asymmetric Binding
remove Asymmetric Binding
Deploying and Undeploying Virtualized Services to Targets
The Synchronous Deployment Model
Who Can Deploy Virtualized Services to Targets?
Conditions that Must be Satisfied for Effective Deployment of Virtualized Services
What Happens When You Deploy a Virtualized Service?
Deploying, Undeploying, and Redeploying Virtualized Services
Deploying Virtualized Services from a Service's Detail Page
Deploying Virtualized Services from the Operations > Deployment Page
Selecting a Target and Services to be Deployed on the Selected Target
Using a Keyword Search to Select a Target or Service to Deploy
Using a Advanced Search to Select a Target or Service to Deploy
Deploying Virtualized Services Using Command Line Tool
Deploy a Virtualized Service to Mediator
Undeploy a Virtualized Service from Mediator
Deploy, Undeploy or Redeploy Multiple Virtualized Services in Mediator
Configuring API Key Header Using Command Line Tool
Deploying Virtualized Services Using a Batch Process
Viewing the Deployment History Log
Deleting a Deployment Activity Log
Performing a Delete Operation Using the Deployed Assets Tab
Performing a Delete Operation Using the Deployment History Tab
Securing Communications with CentraSite for Synchronous Deployment
Virtualized APIs in CentraSite Business UI
Introduction to Virtualized APIs
Roles and Permissions Needed to Create and Manage Virtualized APIs
Preparing to Virtualize and Publish the Virtualized APIs
Run-Time Components of Virtualized API
Creating Virtualized APIs
Before You Begin
Ways in Which You Can Create Virtualized APIs
Creating a Virtualized API from an Existing Native API
Creating a Virtual SOAP API
Add a Virtual SOAP API
Assign Run-Time Actions for the Virtual SOAP API
Implement Virtualization and Publish the Virtual SOAP API to Gateways
Creating a Virtual REST API
Add a Virtual REST API
Assign Run-Time Actions for the Virtual REST API
Implement Virtualization and Publish the Virtual REST API to Gateways
Creating a Virtual OData API
Add a Virtual OData API
Assign Run-Time Actions for the Virtual OData API
Implement Virtualization and Publish the Virtual REST API to Gateways
Creating a Virtualized API from Scratch
Creating a Virtual SOAP API
Add a Virtual SOAP API
Upload an Input File
Assign Run-Time Actions to the Virtual SOAP API
Publish the Virtual SOAP API to Gateways
Creating a Virtual REST API
Add a Virtual REST API
Add Resources and Methods
Assign Run-Time Actions to the Virtual REST API
Publish the Virtual REST API to Gateways
Reconfiguring a Virtualized API
Ways in Which You Can Reconfigure Virtualized APIs
Reconfiguring a Virtualized API from the Native API Details Page
Reconfiguring a Virtualized API from the Virtualized API Details Page
Resource Synchronization in Virtual REST APIs
Resource Synchronization Usage Scenarios
Edit Resource Usage Scenario
Add Resource Usage Scenario
Delete Resource Usage Scenario
Combination of Usage Scenarios
Versioning Virtual API or Service
Creating a Version for Virtual API or Service
Publishing a Versioned Virtual API or Service
Runtime Versioning Support in Mediator
Viewing or Changing a Virtualized API
Viewing the Virtualized API Specific Profiles
Identification Profile
API Key Identification Profile
API Key Scope Profile
OAuth2 Identification Details Profile
Assigning Run-Time Actions to a Virtualized API
Before You Begin
Ways in Which You Assign Run-Time Actions to Virtualized APIs
Modifying the Action List
Configuring Policy Action Parameters
Publishing and Unpublishing APIs to and from Gateways
The Process of Publishing an API to Mediator
The Process of Publishing an API to API-Portal
Roles and Permissions Needed to Publish and Unpublish APIs
Important Considerations When Publishing and Unpublishing APIs
Use Cases for Publishing an API
Use Case A: Publish an API From the Native API Details Page
Use Case B: Publish an API From the Virtualized API Details Page
Use Case C: Publish an API from the Search Results Page
Publishing API(s) to Gateway(s)
Publishing an Individual API from the Native API Details Page
Publishing an Individual API from the Virtualized API Details Page
Publishing Multiple APIs from the Search Results Page
Unpublishing API(s) from Gateway(s)
Unpublishing an Individual API from the Native API Details Page
Unpublishing an Individual API from the Virtualized API Details Page
Unpublishing Multiple APIs from the Search Results Page
Exposing a Virtual SOAP API as Virtual REST API
Displaying Runtime Information for a Virtualized API
The Runtime Metrics
Displaying the Runtime Metrics
The Runtime Events
Displaying the Runtime Events
Obtaining Your API Keys and Access Tokens for Consumption
Fetching and Using Your API Keys for Consumption
The API Consumption Model
How Does Mediator Evaluate Consumers at Run Time?
How Does a Consumer Use the Generated API Key?
Request Header
Query String
What Happens When You Request for API Consumption?
What Happens When Consumption Fails?
Fetching and Using Your OAuth2 Access Tokens for Consumption
Ways for Clients to Provide the Inputs
Using HTTPS for Granting Access Tokens
Responses Returned to Clients
Managing Your API Keys
Fetching Details of Your API Keys
Viewing Details of an API Key Using the Email Notification
Viewing Details of an API Key Using the API Details Page
Viewing Details of an API Key Using the User Preferences
Renewing Your API Key
Revoking Your API Key
Deleting Your API Key
Deleting an Individual API key
Deleting Multiple API Keys in a Single Operation
Privileged User of a Virtualized API
Invoking webMethods IS Services in Virtual Services
Introduction
Using the Security API in webMethods IS Services
pub.mediator.security.ws:AddUsernameToken
pub.mediator.security.ws:AddX509Token
pub.mediator.security.ws:AddSamlSenderVouchesToken
pub.mediator.security.ws:AddTimestamp
pub.mediator.addressing:AddWSAddressingHeaders
Using Context Variables in Virtual Services
Introduction to Context Variables in Virtual Services
The Predefined Context Variables
The API for Context Variables
pub.mediator.ctxvar:getContextVariable
pub.mediator.ctxvar:setContextVariable
pub.mediator.ctxvar:declareContextVariable
pub.mediator.ctxvar:removeContextVariable
Sample Flow Service: Getting a Context Variable Value
Sample Flow Service: Setting a Context Variable Value
Important Considerations when Configuring SOAP-based Virtual Services
Handling Services with Multiple Ports and Bindings
Workaround Option 1
Workaround Option 2
Important Considerations when Configuring REST or XML Virtual Services
Introduction
Endpoint Manipulation of REST or XML Virtual Services
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
The Request Message’s HTTP Methods and Content-Types for REST and XML Services
Changing the HTTP Method of a REST or XML Request
The 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
Working with the JSON Content-Type
How Mediator Determines Which Builder and Formatter Classes to Use (and How You Can Override Them)
Scenarios for Requesting JSON Type Services
JSON Example 1: GET Request, JSON Response
JSON Example 2: POST/JSON Request, JSON Response (where POST is not supported)
JSON Example 3: GET Request, XML Response
Characteristics of the Mapped and Badgerfish JSON Conventions
Mapped JSON Convention
Badgerfish Convention
Multiple Root Nodes in JSON REST Services
Handling Virtual REST APIs with Multiple Resources
Scenario A
Scenario B
Straight-Through Routing Action
Workaround Option 1:
Workaround Option 2:
Content-Based Routing Action
Context-Based Routing Action
Run-Time Governance Reference
Run-Time Events and Key Performance Indicator (KPI) Metrics
The Run-Time Event Types
The Key Performance Indicator (KPI) Metrics
The Event Notification Destinations
Destinations for the Monitoring and Transaction Events
SMTP Email Servers
The Integration Server's Local Log
The Integration Server's Audit Log
The Metrics Tracking Interval
Configuring CentraSite to Receive Run-Time Events and Metrics
Components of the Event Receiver
Configuring the Event Receiver
Setting the Database Configuration Properties
Setting the SNMPv3 Transport Configuration Properties
Setting the SNMPv3 USM Configuration Properties
Setting the Events Queue Implementation Property
Setting the Properties for FileSystem or InMemory
Event Type Modeling
The “Target Type to Event Type Association” Object
Event Modeling
Viewing Run-Time Events and Metrics
Viewing Run-Time Events and Metrics for Targets
Viewing Run-Time Events and Metrics for Virtual Services
Viewing Run-Time Events and Metrics for APIs
Creating Custom Run-Time Events
Modifying Run-Time Events
Built-In Run-Time Actions Reference for Virtual Services
Summary of the Run-Time Actions for Virtual Services
WS-SecurityPolicy 1.2 Actions
Authentication Actions (WS-SecurityPolicy 1.2)
XML Security Actions (WS-SecurityPolicy 1.2)
Monitoring Actions
Additional Actions
Configuring Destinations for Alerts and Logs
The watt.server.auth.skipForMediator Property
Action Evaluation Order and Dependencies
Effective Policies
Usage Cases for Identifying/Authenticating Consumers
Run-Time Actions Reference for Virtual Services
Authorize Against Registered Consumers
Authorize User
Identify Consumer
Log Invocation
Monitor Service Performance
Monitor Service Level Agreement
Require Encryption
Require HTTP Basic Authentication
Require Signing
Require SSL
Require Timestamps
Require WSS SAML Token
Require WSS Username Token
Require WSS X.509 Token
Throttling Traffic Optimization
Validate Schema
Built-In Run-Time Actions Reference for APIs
Summary of the Run-Time Actions
Request Handling Actions
Policy Enforcement Actions
JMS Routing Actions
Logging and Monitoring Actions
Routing Actions
Security Actions
Traffic Management Action
Validation Action
Outbound Authentication Actions
Response Handling Actions
Error Handling Action
The watt.server.auth.skipForMediator Property
Effective Policies
Usage Cases for Identifying/Authenticating Clients
Run-Time Actions Reference
Content Based Routing
Context Based Routing
Conditional Error Processing
Failure Messages
Dynamic Routing
Enable REST Support
Evaluate Client Certificate for SSL Connectivity
Evaluate Hostname
Evaluate HTTP Basic Authentication
Evaluate IP Address
Evaluate Kerberos Token
Evaluate OAuth2 Token
Kerberos Authentication (Outbound Scenarios)
Evaluate WSS Username Token
Evaluate WSS X.509 Certificate
Evaluate XPath Expression
Validate SAML Audience URIs
HTTP Basic Authentication
Invoke webMethods Integration Server
JMS Routing Rule
Load Balancing and Failover Routing
Log Invocation
Monitor Service Level Agreement
Monitor Service Performance
NTLM Authentication
OAuth2 Authentication
Response Transformation
Request Transformation
Require Encryption
Require HTTP / HTTPS
Require JMS
Require Signing
Require SSL
Require Timestamps
Require WSS SAML Token
SAML Authentication
Set Custom Headers
Set JMS Headers
Set Media Type
Set Message Properties
Straight Through Routing
Throttling Traffic Optimization
Service Result Cache
Validate Schema
Computed Runtime Actions
Writing Your Own Computed Runtime Action
The Build Environment
Implementation Guidelines for Computed Runtime Action
Implementation for Computed Action UI
Implementation for Computed Action Parser
Setting up the Computed Action Plug-in
Activating the Computed Action
Sample Computed Runtime Action
Administering Mediator
About this Guide
Document Conventions
Online Information
Mediator
Overview of Mediator
Mediator in SOA Landscape
Mediator Key Capabilities
Components That Mediator Uses
Versioning Support in Mediator
WS-Addressing Processing in Mediator
Implementation of WS-Addressing in CentraSite
WS-Addressing for Mediator
Implementation of WS-Addressing in Mediator
Method 1: Creating an IS Flow Service for WS-Addressing
Method 2: Client Request Sending WS-Addressing Information
Mediator's GZIP Functionality
Mediator's Behavior in Various GZIP Scenarios
REST to SOAP Transformation
Invoking a REST-enabled SOAP API
Handling Multipart or Form Data
Enabling XSLT and webMethods Integration Server Service Transformations
Limitations
Axis Free Mediation
Mediator Configurations
Overview for Configuring Mediator
Before Configuring Mediator
Configuring Communication with CentraSite
Key Performance Indicator Metrics and Run-Time Event Notifications
The Key Performance Indicator (KPI) Metrics
The Run-Time Events
The Metrics Tracking Interval
The Event Notification Destinations
Destinations for the Monitoring and Transaction Events
EDA/Database Configuration for Publishing Run-Time Events and Metrics
Configuring Mediator to Publish Events and Metrics to EDA/Database
Key Performance Indicator Metrics and Run-Time Event Notifications to EDA
Transaction Events Table
Monitoring Events Table
Policy Violation Events Table
Error Events Table
Lifecycle Events Table
Performance Metrics Table
API-Portal Destination Configuration for Publishing Run-Time Events and Metrics
Configuring Communication with API-Portal
Elasticsearch Configuration for Publishing Run-Time Events and Metrics
Configuring Communication with Elasticsearch
Performance Metrics and Run-Time Events Schema Published to Elasticsearch and API-Portal
Transaction Events Type
Monitoring Events Type
Lifecycle Events Table
Policy Violation Events Type
Error Events Type
Performance Metrics Type
SNMP Destinations for Run-Time Events
Setting Mediator to Use the CentraSite SNMP Server
Setting Mediator to Use a Third-Party SNMP Server
Importing the MIB for Mediator's Traps
Setting Mediator to Use a Third-Party SNMP Server (SNMP v3 User-Based Security Model)
Setting Mediator to Use a Third-Party SNMP Server (SNMP v1 Community-Based Security Model)
Specifying the Events to Publish to SNMP Destination
SMTP Destinations for Alerts and Transaction Logging
Configuring an SMTP Destination
Configuring Keystore
Configuring Ports
Configuring Proxy Servers
Configuring Global Service Fault Responses
Configuring Global Service Fault Responses for All Virtual Services
The Fault Handler Variables
Configuring SAML Support in Mediator
ESB Service in Mediator for SAML Claims
Configuring Integration Server Keystores
Configuring SAML Holder-of-Key Processing
Run-Time Processing of Holder-of-Key Tokens
Configuring a Security Token Service (STS) for Holder-of-Key Processing
Configuring Axis2 STS for Holder-of-Key Processing
Configuring Integration Server, Mediator, and Virtual Services for Holder-of-Key
Configuring SAML Sender-Vouches Processing
Configuring a Security Token Service (STS) for Sender-Vouches Processing
Configuring Virtual Services for Sender-Vouches Processing
Configuring for SAML Bearer Token Processing
Configuring a Security Token Service (STS) for SAML Bearer Token Processing
Configuring Integration Server, Mediator, and Virtual Services for Bearer Tokens
Configuring Custom Content-Types
OAuth2 Inbound Configuration
The watt.server.auth.skipForMediator Parameter
The pg.oauth2 Parameters
The Service for Obtaining OAuth2 Access Tokens
Configuring SOAP Over JMS Protocol
Configuring SOAP-JMS Messaging
Creating SOAP-JMS Web Service Endpoint Aliases
Creating a SOAP-JMS Provider Web Service Endpoint Alias and Trigger
Viewing Thread Usage for SOAP-JMS Triggers
Increasing or Decreasing Thread Usage for All Triggers
Enabling, Disabling, and Suspending SOAP-JMS Triggers
Creating a SOAP-JMS Consumer Web Service Endpoint Alias
Creating a SOAP-JMS Consumer Web Service Endpoint Alias that Includes a JNDI Provider
Creating a SOAP-JMS Consumer Web Service Endpoint Alias that Includes a JMS Connection Alias
Built-In Services
Viewing the Services Deployed to Mediator
Viewing the Consumer Applications Deployed to Mediator
Clustering and Load Balancing
Overview of Clustering and Load Balancing
Nodes and Clusters
Load Balancers
Load Balancer URLs
Creating a Mediator Cluster
Load Balancing Configuration
Deployment in a Cluster
Processing Service Requests in a Cluster
Metric and Event Notification in a Cluster
Role of the Shared Cache in Metrics and Event Notification
Senior Node
Processing Interval
Reporting Non-Aggregated Run-Time Events
Reporting Aggregated Events and Performance Data in a Cluster
Load Balancing Service Providers
The Built-In Run-Time Actions
Summary of the Built-In Run-Time Actions
The Built-In Run-Time Actions for Virtual Services
WS-SecurityPolicy 1.2 Actions
Monitoring Actions
Additional Actions
The Built-In Run-Time Actions for Virtualized APIs
Request Handling Actions
Policy Enforcement Actions
Response Handling Actions
Error Handling Action
Outbound Authentication Actions
The Built-In Run-Time Actions for Virtual OData Services
Request Handling Actions
Policy Enforcement Actions
Response Handling Actions
Error Handling Action
Masking Native OData Service
Advanced Settings and Server Configuration Parameters
Advanced Settings
pg.3pSnmpSender.
pg.cs.snmpTarget.
pg.csSnmpSender.
pg.failedProxies.
pg.PgMenConfiguration.
pg.snmp.communityTarget.
pg.snmp.userTarget.
pg.jaasContextName
pg.default.enable.oldVersion
pg.use.native.contentType
pg.apikey.removeParameter
pg.apikey.header
pg.es.
pg.apiportal.
pg.mediator.rest-service-redirect
Server Configuration Parameters
watt.debug.
watt.net.
watt.pg.
watt.server.
Administering Integration Server
About this Guide
The Role of the Administrator
What Does an Administrator Do?
Typical Administrative Responsibilities
The Integration Server Administrator
Receiving Administrative Messages from the Server
The Administrator User
The Administrator's Password
Adding Backup Administrators
An Overview of the Server
The Role of the Server
About Integration Server Instances
Architecture
Services
Retrieving Data for Services
How the Server Executes Services
How the Server Loads Java Classes
Class Loaders
OSGi Bundle Class Loader
Integration Server Class Loaders
Classpaths
How the Integration Server Classpaths Are Specified
Changing Classpath Information at Startup
How Class Loading Works
Class Loading Process
Scenario One: Integration Server Knows Where the Class Lives
Scenario Two: Integration Server Does Not Know Where the Class Lives
Scenario Three: Package Class Loader Does Not Defer to the Integration Server Class Loader
Where to Place Classes and Jar Files for Packages
Where to Place Custom and Third-Party Jar Files
Accelerating Class Loading
Integration Server Security
Logging
Caching
Starting and Stopping the Server
Starting the webMethods Integration Server
Starting an Integration Server Instance on Windows
Starting Integration Server on UNIX
Starting a Server Instance from the Command Prompt
What Happens When You Start the Server?
How to Tell if the Server Is Running Correctly
Running Integration Server as a Windows Application vs. a Windows Service
Switching the Server from a Windows Service to a Windows Application
Switching the Server from a Windows Application to a Windows Service
Changing Settings in the Configuration File custom_wrapper.conf
Passing Java System Properties to Integration Server
Shutting Down the Integration Server
Shutting Down the Integration Server from Integration Server Administrator
Shutting Down Integration Server from Windows
Shutting Down Integration Server from the Command Prompt
Viewing Active Sessions
Killing Sessions
Viewing the Integration Server Process ID
Restarting the Integration Server
Server Recovery
Integration Server Data Integrity and Recoverability Considerations
Critical Integration Server Data Files
The Java Service Wrapper
The Java Service Wrapper Configuration Files
JVM Configuration
The Wrapper Log
Logging Properties
Fault Monitoring
Generating a Thread Dump
Running Multiple Integration Server Instances
Overview
Guidelines for Running Multiple Integration Server Instances on the Same Machine
About Creating a New Integration Server Instance
About the is_instance Script
Syntax
is_instance Script Commands
Creating a New Integration Server Instance
Installing and Updating Packages on a Server Instance
Deleting Packages from a Server Instance
Updating Language Packs on a Server Instance
Deleting a Server Instance
Using the Integration Server Administrator
What Is the Integration Server Administrator?
Starting the Integration Server Administrator
Starting Integration Server Administrator on Windows
Accessing Integration Server Administrator through My webMethods
Basic Operation
Logging Off the Integration Server Administrator
Getting Help
The Configuration File
Software AG Command Central
Managing Users and Groups
Users and Groups
Purpose of Users and Groups
Defining a User Account
Predefined User Accounts
Adding User Accounts
Removing User Accounts
Adding an Administrator User
Adding a Developer User
Changing Passwords
Setting Password Requirements
Disabling and Enabling Users
Disabling a User
Enabling a User
Defining Groups
Predefined Groups
Adding Groups
Adding Users to a Group
Removing Users from a Group
Viewing Group Membership
Removing Groups
Configuring the Server
Viewing and Changing Licensing Information
The License Key
Viewing Licensing Information
Changing Licensing Information
Renewal Reminders
Renewing a Key
Adding Licensed Features
Licensed Sessions
Viewing Active Sessions
Managing the Server Thread Pool
Managing Server Sessions
Setting the Session Timeout Limit
Setting the Stateful Session Limit
Configuring Outbound HTTP Settings
Specifying Outbound HTTP Settings
Setting Up Aliases for Remote Integration Servers
Adding an Alias for a Remote Integration Server
Testing the Connection to a Remote Server
Editing an Alias
Deleting an Alias
Specifying Third-Party Proxy Servers for Outbound Requests
How Integration Server Uses Proxy Servers
Creating a Proxy Server Alias
Editing a Proxy Server Alias
Disabling a Proxy Server Alias
Enabling a Proxy Server Alias
Specifying a Default Proxy Server Alias
Deleting a Proxy Server Alias
Bypassing a Proxy Server
Configuring Where the Integration Server Writes Logging, Status, and Other Information
Switching from the Embedded Database to an External RDBMS
Working with Extended Configuration Settings
Configuring Integration Server to Work with Servers Running HTTP 1.0 and Above
Specifying Character Encoding
Configuring the JVM
Specifying the JDK or JRE for Integration Server
Changing the JVM Heap Size Used by Integration Server
Publishing and Retracting Information about Integration Server Assets
Configuring Integration Server to Connect to CentraSite
Testing the Connection to CentraSite
Setting a Port for Remote Client JMX Monitoring
Configuring Integration Server to Accept a Debug Connection During Startup
Using CORS with Integration Server
How Integration Server Handles CORS Requests
Configuring Integration Server to Accept CORS Requests
Managing JDBC Pools
Overview
Managing Functional Alias Definitions
Assigning Connection Pools to Functional Aliases
Testing Functional Aliases
Restarting Functional Aliases
Using Fail-Fast Mode with a Functional Alias
Managing Pool Aliases
Creating Connection Pool Aliases Manually
Creating Connection Pool Aliases by Copying an Existing Pool Alias
Editing a Connection Pool Alias
Testing a Connection Pool Alias
Deleting a Connection Pool Alias
Managing Driver Aliases
Creating Database Driver Alias Definitions
Editing Database Driver Aliases
Deleting Database Driver Aliases
Configuring Ports
About Ports
Available Port Types
Default Ports
About the Port Alias
Package Associations
Considerations for Adding Ports
Reasons to Add Additional Ports
Considerations for Configuring Ports
AS/400 Considerations
Bind Addresses
Prerequisites to Configuring a Port for SSL
Port Usage and Security
Adding an HTTP Port
Advanced Controls
Editing Advanced Controls
Adding an HTTPS Port
About File Polling Ports
Adding a File Polling Port
Adding an FTPS Port
Adding an FTP Port
Adding an E-Mail Port
Security Considerations for E-Mail Ports
Adding an HTTP Diagnostic Port
Adding an HTTPS Diagnostic Port
Suspending an HTTP/HTTPS Port
Resuming an HTTP/HTTPS Port
Testing for HTTPS Requests
Using an FTP/FTPS Port Range
Specifying an FTP/FTPS Port Range
About the Primary Port
Changing the Primary Port
Deleting a Port
Editing a Port
About Enabling/Disabling a Port
Disabling a Port
Enabling a Port
Configuring How Ports Handle Client Certificates
Adding a Security Provider
Configuring the Allowed Protocols for JSSE per Port
Setting Up the Server Log
Overview of the Server Log
Specifying Amount and Type of Information to Include in the Server Log
Logging Levels
Specifying Whether to Queue Server Log Entries
Changing the Default Server Log Location
Configuring the Server Log to Rotate Based on Size
Limiting the Number of Server Log Files Kept by Integration Server
Sending Messages About Critical Issues to E-mail Addresses
Performing Additional Processing on Log Entries
Viewing the Server Log
Using an Alternative Server Log Entry Format
Changing the Log Displays
Specifying the Date and Time Format to Use in Log Entries
Displaying Logged Data in Different Languages
Changing the Display Permanently for All Logs
Changing the Display Temporarily for the Server Log
Overriding Logging Level and Server Log Location for a Session
Globalization
Configuring Integration Server for webMethods Messaging
Overview
Working with Messaging Connection Aliases
Predefined Messaging Connection Aliases
Creating a Broker Connection Alias
Creating a Universal Messaging Connection Alias
About Follow the Master
Editing a Messaging Connection Alias
Enabling a Messaging Connection Alias
About Disabling a Message Connection Alias
Disabling a Messaging Connection Alias
Messaging Connection Alias Status
Specifying the Default Messaging Connection Alias
Deleting a Messaging Connection Alias
Authenticating Connections to the Universal Messaging Server
Configuring Integration Server to Connect to an SSL-Enabled Port on Universal Messaging
Configuring a Universal Messaging Connection Alias for One-Way SSL
Configuring a Universal Messaging Connection Alias for Two-Way SSL
Specifying the Keep-Alive Mode for the Broker Connection
Setting Server Configuration Parameters for Keep-Alive Mode
Normal Mode
Listen Only Mode
Disabled
Synchronizing Broker Clients When the Primary Port for Integration Server Changes
Configuring Document Stores
Configuring the Default Document Store
About the Trigger Document Store
Configuring the Trigger Document Store
Maintaining Inbound Document History for Received Documents
Enabling Inbound Client-Side Queuing
About the Outbound Document Store
Configuring the Rate at which Integration Server Drains the Outbound Document Store
Setting the Capacity of the Outbound Document Store
Associating a User Account with webMethods Messaging Trigger Services
Specifying a User Account for Invoking webMethods Messaging Trigger Services
Load Balancing with a Non-Clustered Group of Integration Servers
Important Considerations
Configuring Integration Server for JMS Messaging
Overview
Working with JNDI Providers
Predefined JNDI Provider Aliases
Creating a JNDI Provider Alias
Editing a JNDI Provider Alias
Deleting a JNDI Provider Alias
Creating a JNDI Provider Failover List
Performing a Test Lookup for a JNDI Provider
JNDI Provider Cache and Timeout Behavior for Administered Objects
Working with JMS Connection Aliases
Connecting to webMethods Broker with the Native webMethods API
Predefined JMS Connection Aliases
Creating a JMS Connection Alias
Allowing Destinations to be Managed through the JMS Connection Alias and Designer
Allowing Multiple Connections for a JMS Connection Alias
About the Connection Client ID
Creating a Dedicated Listener for Receiving Replies
Configuring Producer Caching for Sending JMS Messages
Configuring Automatic Retry when Sending JMS Messages Using the pub.jms:send Service
About Retrying the pub.jms:send Service when webMethods Universal Messaging Is the JMS Provider
Editing a JMS Connection Alias
Enabling and Disabling a JMS Connection Alias
Deleting a JMS Connection Alias
Specifying a Connection Monitoring Period
Specifying a Retry Interval for Failed Connections
Specifying a Keep-Alive Interval
Creating Administered Objects
Monitoring a Connection Factory Object for Changes
Polling for Changes
Registering an Event Listener
How Integration Server Updates the Connection
Configuring Integration Server to Monitor a Connection Factory Object
Using SSL with JMS
Supported JMS Providers
About Using webMethods Universal Messaging as the JMS Provider
Adding JMS Provider Client Libraries to Integration Server Classpath
Configuring Endpoint Aliases for Web Services
Overview
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with HTTP/S
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with HTTP/S
Creating an Endpoint Alias for Message Addressing for Use with HTTP/S
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with JMS
Creating an Endpoint Alias for a Consumer Web Service Descriptor for Use with JMS
Creating an Endpoint Alias for Message Addressing for Use with JMS
Timestamps in the WS-Security Header
Configuring Reliable Messaging in Integration Server
Overview of Reliable Messaging
Understanding Reliable Messaging Terminology
Using Reliable Messaging in Integration Server
Persistent Storage Support for Reliable Messaging Data
Limitations When Using Reliable Messaging in Integration Server
Configuring Reliable Messaging in Integration Server
Reliable Messaging Sequence Reports
Client and Server Sequences
Viewing Reliable Messaging Sequence Reports
Closing a Sequence
Terminating a Sequence
Sending an Acknowledgement Request
Configuring Integration Server to Use Kerberos
Overview
About Kerberos
Kerberos Terminology
Kerberos Delegated Authentication
Prerequisites to Configuring Kerberos
Limitations When Using Kerberos Authentication in Integration Server
Configuring Integration Server to Use Kerberos
Order of Precedence for Principal Name and Password
JAAS Contexts for Kerberos
Troubleshooting Kerberos Configuration
Setting Up HTTP URL Aliases
Overview
Creating an HTTP URL Alias
Specifying the URL Path
Using Port Mappings with a URL Alias
Adding a Port Mapping to a URL Alias
Deleting a Port Mapping for a URL Alias
Using a URL Alias for the “Empty Path”
Creating a URL Alias for the Empty Path
Enabling Partial Matching of URL Aliases
Displaying HTTP URL Aliases
About HTTP URL Alias Association
Editing a URL Alias
Deleting a URL Alias
Portability of URL Aliases and Possible Conflicts
Configuring Integration Server to Connect to an SFTP Server
Overview of SFTP
Creating an SFTP Server Alias
Editing an SFTP Server Alias
Creating an SFTP User Alias
Editing an SFTP User Alias
Migration Impact on SFTP Configurations
Testing the Connection to the SFTP Server
Securing Communications with the Server
Overview
Anatomy of an Integration Server SSL Connection
Integration Server and SSL Connection Type
Integration Server as an SSL Server
Integration Server as an SSL Client
Roadmap for Configuring SSL
Creating Integration Server Keys and Certificates
Creating a Keystore and Truststore
Obtaining the Certificates and Keys of the Partner Application
Configuring an HTTPS or FTPS Port
Keystores and Truststores
Keystore File
Keystore File Formats
HSM-Based Keystores
Creating a Keystore
Truststore File
Truststore File Formats
How Integration Server Uses a Keystore and Truststore
Protecting Keystore and Truststore Files
Keystore, Truststore, and Key Aliases
Default Keystore and Truststore Aliases
Creating Keystore Aliases
Creating Truststore Aliases
Configuring Server-Side SSL Settings
Specifying the Integration Server SSL Authentication Credentials
Controlling Server SSL Security Level by Port
Storing SSL Information for the Integration Server JVM in a Secure Manner
Order of Precedence for the javax.net.ssl Properties
Specifying Cipher Suites for Use with SSL
Usage of CA Certificates: Technical Considerations
Handling Expired CA Certificates
Customizing Usage of the Trusted Certificates Directory
WS-Security and Integration Server
Using SAML for Web Service Client Authentication
Requirements for Using SAML for Authentication
Identifying Trusted STSs to Integration Server
Controlling Access to Resources
Overview
Controlling Access to Resources by Port
Restricting IP Addresses that Can Connect to a Port
Controlling IP Access to All Ports (Globally)
Allow Inbound Connections from Specified Hosts (Deny All Others)
Deny Inbound Connections from Specified Hosts (Allow All Others)
Allow Inbound Requests from Specified Hosts (Deny All Others)
Deny Inbound Requests from Specified Hosts (Allow All Others)
If You Inadvertently Deny IP Access to All Hosts
Resetting the Global Setting IP Access Setting
Resetting the IP Access Setting for an Individual Port
Restricting the Services or Web Service Descriptors Available from a Port
Allow Access to Specified Services (Deny All Others)
Deny Access to Specified Services (Allow All Others)
Resetting a Port to the Default Access
Controlling the Use of Directives
Controlling Access to Resources with ACLs
About ACLs
Package Replication
Implicit and Explicit Protection
Users that Belong to More than One Group
Predefined ACLs
When Does the Server Perform ACL Checking?
Creating ACLs
Allowing or Denying Group Access to ACLs
Deleting ACLs
Default Settings and Inheritance
What Happens When You Change Existing ACL Assignments
Assigning ACLs to Folders, Services, and Other Elements
Removing an ACL from a Folder or Service
Assigning ACLs to Files the Server Can Serve
Rules for Using .access Files
Removing ACL Protection from a File
Authenticating Clients
Overview
Basic Authentication
Digest Authentication
Kerberos Authentication
Client Certificates
Checklist for Using Client Certificates
Certificate Mapping
Ports and Certificate Mappings
Importing a Certificate (Client or CA Signing Certificate) and Mapping It to a User
Changing a Certificate Mapping
Client Certificates and Port Configuration
HTTPS Ports
FTPS Ports
Using Multiple Client Certificates
Checklist for Presenting Multiple Client Certificates
Importing Certificates
Setting Up a Remote Server Alias
Coding Your Flow Services
Client Authentication and Access Control
Accessing Integration Server Data through My webMethods
Configuring the MWS Single Sign-On Resource Setting
Customizing Authentication Using JAAS
Overview
Using JAAS with Integration Server
JAAS Configuration File
Pre-installed Login Modules
X509ValidatorModule
Pluggable Authentication Modules (PAMs)
Writing a Custom JAAS Login Module for Integration Server
Extend SagAbstractLoginModule
Implement Commit()
Place the JAR File in the Integration Server Classpath
Modify the JAAS Configuration File
JAAS Custom Login Module Example
JAAS Login Module for Integration Server: Sample Code
JAAS Custom Login Module: Code Explanation
JAAS Configuration File: Sample Module
Master Passwords and Outbound Passwords
Overview
Managing Outbound Passwords
Backing Up Outbound Password and Master Password Files
Changing the Master Password
Changing the Expiration Interval for the Master Password
About the configPassman.cnf File
Working with Outbound Password Settings
Controlling Name and Location of Outbound Password File
Controlling Encryption of Outbound Password File
Working with Master Password Settings
Storing the Master Password in a File
Prompting for the Master Password at Server Initialization
What to Do if You Lose or Forget Your Master Password
When Problems Exist with the Master Password or Outbound Passwords at Startup
Determining Whether You Can Restore the Passwords
Restoring the Master Password and Outbound Password Files
Resetting the Master Password and Outbound Passwords
E-mail Listeners and Package Replication
Securing Integration Server with CSRF Guard
What is CSRF?
How Does Integration Server Prevent CSRF Attacks?
Understanding CSRF Guard Terminology
Configuring CSRF Guard in Integration Server
Limitations when Configuring CSRF Guard in Integration Server
Configuring webMethods Enterprise Gateway
Overview
How Enterprise Gateway Works
Enterprise Gateway Ports
Enterprise Gateway Rules and Alerts
About Enterprise Gateway Rules
About Enterprise Gateway Alerts
Version Interoperability Between Enterprise Gateway Server and Internal Server
Advantages of Enterprise Gateway over Traditional Third-Party Proxy Servers
About Denial of Service Protection
About Trusted IP Addresses
About Mobile Application Protection
About Mobile Data Synchronization
About SQL Injection Protection
About Antivirus Scan Filter
About Custom Filter
Clustering in the Enterprise Gateway Configuration
Setting Up an Enterprise Gateway
Configuring the Enterprise Gateway Ports
Deleting Enterprise Gateway External and Registration Ports
Connecting Your Internal Server to an Enterprise Gateway Server
Viewing Connections to the Enterprise Gateway Registration Port
Performing Client Authentication on Enterprise Gateway Server
Working with Enterprise Gateway Rules
Creating an Enterprise Gateway Rule
Enabling an Enterprise Gateway Rule
Disabling an Enterprise Gateway Rule
Editing an Enterprise Gateway Rule
Copying an Enterprise Gateway Rule
Changing the Priority of an Enterprise Gateway Rule
Deleting an Enterprise Gateway Rule
Specifying Alert Options
Specifying Default Alert Options
Specifying Rule-Specific Alert Options
Preventing Denial of Service Attacks
Limiting Requests Globally
Limiting Requests by IP Address
Controlling Use of Mobile Applications
Frequently Asked Questions about Enterprise Gateway
Configuring OAuth
What Is OAuth?
Using OAuth with Integration Server
Integration Server as an OAuth Client
Integration Server as an Authorization Server
Integration Server as a Resource Server
Authorization Grant Types Supported by Integration Server
Authorization Code Grant
Implicit Grant
The Integration Server OAuth Services
Important Considerations for Using OAuth Features
Configuring the Authorization Server
Configuring OAuth Settings
Defining Clients
Registering Clients
Enabling and Disabling Clients
Editing Clients
Deleting Clients
Defining Scopes
Adding a Scope
Editing Scopes
Deleting Scopes
Associating Scopes and Clients
Adding Associations Between Clients and Scopes
Removing Client and Scope Associations
Viewing Associations Between Clients and Scopes
Viewing and Deleting Tokens
Viewing Tokens
Deleting Tokens
Customizing the Approval Page
About Using Integration Server as the Resource Server
Configuring a Central User Directory or LDAP
Before You Begin
Overview of How Integration Server Works with Externally Defined Users and Groups
How the Server Uses Externally Defined Users and Groups
When the Server Accesses Externally Defined Information
How Integration Server Authenticates Externally Defined Clients
Configuring Central User Management
Requirements for Central User Management
Considerations for My webMethods Server Query Roles
Overview of Using LDAP
About LDAP and Caching
Configuring the Server to Use LDAP
Defining an LDAP Directory to Integration Server
Mapping an LDAP User's Access to ACLs
Stopping Use of an LDAP as an External Directory
Considerations for User Accounts and Groups
About Keeping Internal and External User Accounts and Group Names Unique
About User Groups and Package Replication
About Granting Administrator Privileges to External Users
Granting Administrator Privileges to an Externally Defined User
Granting Developer Privileges to External Users
Granting Access to Services and Files to External Users
Managing Packages
Using Packages
Predefined Packages
The Package Repository
Sample Package
How the Server Stores Package Information
Manifest File
Finding Information about Your Packages
Viewing the Packages that Reside on Your Server
Filtering the List of Packages
Refining the Filtered Package List
Determining Whether the Server Successfully Loaded the Package
Determining Whether the Package Is Enabled or Disabled
Displaying Information about a Package
Package Information
Displaying Information about Services and Folders in a Package
Displaying Documentation for a Package
Accessing a Web Document for a Package
Working with Packages
Creating a Package
Activating a Package
Reloading a Package
Enabling a Package
Disabling a Package
Deleting a Package
Recovering a Package
Archiving a Package
Copying Packages from One Server to Another
Overview of Package Replication
Version Checking
Who Can Subscribe?
Guidelines for Using Package Replication
The Publishing Server
Displaying Subscribers for a Specific Package
Displaying Subscribers for all Packages
Adding Subscribers from a Publishing Server
Updating Subscriber Information
Removing Subscribers for a Package
Publishing a Package
Creating a Release
Sending a Release
Specifying File and Version Information for a Release or Archive
The Subscribing Server
Displaying Packages to Which Your Server Subscribes
Manually Pulling a Package
Subscribing to a Package from a Subscribing Server
Requesting a Subscription to a Package from Another Server
Updating Your Subscription Information
Canceling a Subscription
About Installing Packages Published by Another Server
Installing a Package Published by Another Server
Using a Package Class Loader
Hot Deployment of Packages
How Hot Deployment Works
Determining Package Dependencies during Hot Deployment
Limitations When Hot Deploying the Packages
Configuring the Hot Deployment Settings
Managing Services
About Services
Fully Qualified Service Names
Package Names and Service Names
HTTP URL Aliases for Services
Finding Information about Services and Folders
Listing Folders and Services
Displaying Information about a Service
Service Information
Manually Adding a Service to the Server
Testing Services
Canceling and Killing Threads Associated with a Service
Canceling or Killing a Thread
Running Services When Packages Are Loaded, Unloaded, or Replicated
What Is a Startup Service?
What Is a Shutdown Service?
What Is a Replication Service?
Guidelines for Using Startup, Shutdown, and Replication Services
Running Services in Response to Specific Events
Managing Global Variables
Creating a Global Variable
Deleting Global Variables
Scheduling Services
Overview
Tasks Provided by Integration Server
Scheduling a User Task
Viewing Scheduled User Tasks
Filtering the List of Scheduled Tasks
Updating Scheduled User Tasks
Suspending User Tasks
Suspending a Single User Task
Suspending All User Tasks
Resuming Suspended User Tasks
Resuming a Suspended User Task
Resuming All Suspended User Tasks
Canceling a Scheduled User Task
Viewing the Scheduled System Tasks
Simple Repeating Option
Complex Repeating Option
Target Node Options
Tasks in a Clustered Environment
How Transitioning to or from Daylight Savings Time Affects Scheduled Tasks
Caching Service Results
What Is Caching?
When Are Cached Results Returned?
Using a Public Cache for Service Results Caching
Resetting the Cache
Resetting the Cache for All Services
Resetting the Cache for a Specific Service
Monitoring Service Cache Usage
Viewing Service Results in a Public Cache
Configuring Guaranteed Delivery
About Guaranteed Delivery
Configuring the Server for Guaranteed Delivery
Settings Shared by Both Inbound and Outbound Transactions
Settings for Inbound Transactions
Settings for Outbound Transactions
Specifying an E-Mail Address and SMTP Server for Error Messages
Using Guaranteed Delivery with Multiple Servers that Share an ISInternal Database
Administering Guaranteed Delivery
Shutting Down Guaranteed Delivery
Reinitializing Guaranteed Delivery
Reinitializing Guaranteed Delivery for Inbound Transactions
Reinitializing Guaranteed Delivery for Outbound Transactions
Configuring Ehcache on Integration Server
What is Ehcache?
Caching Configurations
On-Heap Cache
Local Disk Store
BigMemory
Terracotta Server Array
Understanding Caches and Cache Managers
System Caches
Cache Manager Configuration Files
Specifying the Parameters for a Cache
Dynamic vs. Non-Dynamic Cache Parameters
Installing, Viewing, and Changing the Terracotta License
Determining if You Have a Terracotta License
Adding a Terracotta License
Configuring an On-Heap Cache
Considerations for Configuring On-Heap Cache
Configuring a BigMemory Cache
Allocating Direct Memory Space to Integration Server
Considerations for Configuring BigMemoryCache
Configuring a Distributed Cache
Configuring tc-config.xml on the Terracotta Server Array
Considerations for Configuring a Distributed Cache
Cache-Wide and Client-Specific Parameters for a Distributed Cache
Cache-Wide Parameters
Client-Specific Parameters
The Rejoin Behavior of a Distributed Cache
The Nonstop Behavior of a Distributed Cache
Making a Cache Searchable
Defining Attributes
Extracting Attributes by Class
Working with Cache Managers
Creating a Cache Manager
Viewing or Modifying a Cache Manager
Shutting Down a Cache Manager
Starting a Cache Manager
Reloading a Cache Manager
Deleting a Cache Manager
Reinitializing a Cache Manager
Adding a Cache Manager Configuration File to Integration Server
Manually Editing a Cache Manager Configuration File
Working with Caches
Creating a Cache
Viewing or Modifying Cache Settings
Modifying Settings for a Distributed Cache
Disabling a Cache
Enabling a Cache
Clearing a Cache
Deleting a Cache
Logging Ehcache Activity
Logging Ehcache Caching Services
Logging Cache Manager Activity in the Terracotta Server Array
Configuring the Enhanced XML Parser
What Is the Enhanced XML Parser?
How Does the Enhanced XML Parser Work?
When Is the Enhanced XML Parser Used?
What Services Consume an Enhanced Node?
Configuring the Enhanced XML Parser
Setting the Partition Size
Viewing Peak Usage Statistics
Locking Administration and Best Practices
Introduction
Choosing Local Server Locking or VCS Integration Locking
Disabling and Re-enabling Locking
Disabling Locking
Re-Enabling Locking
Best Practices
Remote Server Configuration
Server User Names
Package Replication and Publishing
Package and Folder Organization
Source Code
Upgrading webMethods Integration Server
Managing webMethods Messaging Triggers
Introduction
Managing Document Retrieval
Increasing or Decreasing Threads for Document Retrieval from webMethods Broker
When to Increase or Decrease Threads for Retrieving Documents from webMethods Broker
Decreasing the Capacity of Trigger Queues
Decreasing the Capacity and Refill Level for webMethods Messaging Triggers
Suspending and Resuming Document Retrieval
About Suspending and Resuming Document Retrieval for All Triggers
Suspending or Resuming Document Retrieval for All webMethods Messaging Triggers
About Suspending and Resuming Document Retrieval for a Specific Trigger
Suspending or Resuming Document Retrieval for a webMethods Messaging Trigger
Managing Document Processing
Increasing or Decreasing Threads for Processing Documents Received by webMethods Messaging Triggers
When to Increase or Decrease Threads for Processing Documents
Decreasing Document Processing for Concurrent Triggers
Decreasing Execution Threads for Concurrent webMethods Messaging Triggers
Suspending and Resuming Document Processing
About Suspending and Resuming Document Processing for all Triggers
Suspending or Resuming Document Processing for All webMethods Messaging Triggers
About Suspending and Resuming Document Processing for Specific Triggers
Suspending or Resuming Document Processing for a Specific webMethods Messaging Trigger
Limiting Server Threads for webMethods Messaging Triggers
Setting the Maximum Number of Server Threads for webMethods Messaging Triggers
Cluster Synchronization for webMethods Messaging Trigger Management
Configuring Cluster Synchronization
Cluster Synchronization at Run Time
Monitoring Cluster Synchronization
Modifying webMethods Messaging Trigger Properties
Managing Trigger Service Retries and Shutdown Requests
Delaying Polling Requests for webMethods Messaging Triggers
How Integration Server Delays a Polling Request for a webMethods Messaging Trigger
Serial Triggers Migrated to Integration Server 9.9 or Later from 9.8 or Earlier
Synchronizing the webMethods Messaging Trigger and Named Object on Universal Messaging
Managing JMS Triggers
Introduction
Enabling, Disabling, and Suspending JMS Triggers
Configuring Integration Server to Enable JMS Triggers Automatically after a Consumer Error
Controlling Thread Usage for JMS Triggers
Viewing Thread Usage for JMS Triggers
Throttling Thread Usage for JMS Triggers
Establishing a Threshold for Using Multiple Threads with a Concurrent JMS Trigger
Configuring Integration Server Session Reuse
Configuring JMS Session Reuse
Delaying Polling Requests for Concurrent JMS Triggers
How JMS Trigger Delays a Polling Request
Examples of Extended Polling Delay Configuration
About WS Endpoint Triggers
Editing WS Endpoint Triggers
Using a Document History Database with Exactly-Once Processing
Overview
Removing Expired Entries from the Document History Database
Clearing Expired Entries from the Document History Database
Viewing Exactly-Once Processing Statistics
Clearing Exactly-Once Processing Statistics
Using Integration Server to Manage XA Transactions
Overview of XA Transaction Management
How the Integration Server Persists the State of a Transaction
How the Integration Server Resolves Uncompleted Transactions
About Unresolved XA Transactions
Details for an Unresolved XA Transaction
Configuring XA Options in Integration Server
Enabling or Disabling XA Transaction Recovery
Configuring the XA Recovery Store
Configuring XA Server Parameters
Manually Resolving a Transaction
Content Handlers
How the Server Uses Content Handlers
How the Server Chooses a Content Handler for an HTTP Request
How the Server Chooses a Content Handler for an FTP Request
Content Handlers for HTTP and FTP Requests
About Content Handlers for HTTP Responses
Accept Header Field
About Content Handlers for FTP Responses
Quiescing the Server for Maintenance
Overview
What Happens when Integration Server Enters Quiesce Mode?
What Tasks Can You Perform in Quiesce Mode?
What Happens when Integration Server Exits Quiesce Mode?
Specifying the Quiesce Port
Quiescing Integration Server
Starting the Server in Quiesce Mode from the Command Prompt
Quiescing an Active Server from Integration Server Administrator
Restarting a Server in Quiesce Mode from Integration Server Administrator
Exiting Quiesce Mode
Deploying Quiesce Mode Configuration
Diagnosing the Integration Server
Introduction
Configuring the Diagnostic Port
Diagnostic Thread Pool Configuration
Diagnostic Port Access
Using the Diagnostic Utility
Diagnostic Utility Performance
Running the Diagnostic Utility from Integration Server Administrator
Running the Diagnostic Utility Service
Starting the Integration Server in Safe Mode
Starting Integration Server in Safe Mode
When the Server Automatically Places You in Safe Mode
Generating Thread Dumps
Generating a Dump of an Individual Thread
Generating a Dump of the JVM
Using Command Central to Manage Integration Server
Integration Server Instance Management
Creating Instances Using Command Central Web User Interface
Updating Instances Using Command Central Web User Interface
Deleting Instances Using Command Central Web User Interface
Managing Instances Using the Command Central Instance Management Commands
Accessing Integration Server Administrator through Command Central
Changing the Authentication Mode
Changing the Administrator User Password for Integration Server in Command Central
Configuring Integration Server for SSL Connection
Monitoring Integration Server Instances
Run-time Monitoring Statuses for IntegrationServer-instanceName
Run-time Monitoring States for IntegrationServer-instanceName
Monitoring KPIs of Integration Server Instances
Integration Server Configuration Types
Configuration Types that IntegrationServer-instanceName Supports
Working with Integration Server Configuration Types
Lifecycle Actions for Integration Server
Migrating an Integration Server Instance
Commands that Integration Server Supports
Using Unix Shell Scripts to Change Connection Credentials for Managed Products
Command Central Command Line Tool Upgrade
Integration Server Deployment Checklist
Introduction
Stage 1: Installation
Stage 2: Basic Configuration
Stage 3: Setting Up Users, Groups, and ACLs
Stage 4: Publishing Packages
Stage 5: Installing Run-Time Classes
Stage 6: Preparing Clients for Communication with the Server
Stage 7: Setting Up Security
Stage 8: Startup and Test
Stage 9: Archive Sources
Server Configuration Parameters
Introduction
watt.art.
watt.broker.
watt.brokerCoder.
watt.cachedirective.
watt.cds.
watt.config.
watt.core.
watt.debug.
watt.debug2.
watt.infradc.
watt.net.
watt.security.
watt.server.
watt.ssl.
watt.ssh.
watt.wm.tnextdc.
watt.tx.
watt.um
watt.xslt.
FIPS 140-2 Compliance
FIPS 140-2 Compliance
Using NTLM Authentication and Integrated Windows Authentication with Integration Server
Overview
Using NTLM Authentication when Integration Server Acts as the Client
Working with Integrated Windows Authentication
Activating and Deactivating Integrated Windows Authentication
Activating Integrated Windows Authentication
Deactivating Integrated Windows Authentication
Wireless Communication with the Integration Server
Overview
How Does the Integration Server Communicate with Wireless Devices?
Using URLs for Wireless Access to the Integration Server
Invoking a Service with a URL
Requesting a WML or HDML Page with a URL
WML and HDML Samples
Debugging Service Exceptions Using the Error Log
Introduction
Controlling the Level of Exception Logging Detail
Displaying the Error Log
Interpreting the Error Log
Understanding the Service Stack
Understanding the Error Messages
Understanding the Stack Trace
Server Log Facilities
About Server Log Facilities
Integration Server
WmMobileSupport Package
WmXSLT Package
Flat File
Mediator
CentraSite Developers Guide
Access via UDDI
Overview of the UDDI Standard
Summary of UDDI Support in CentraSite
CentraSite UDDI Architecture
Overview
Client Access via UDDI
Localization
Modeling of the Node Business Entity
Key Generator tModel
Node Business Entity
Inquiry Service
Publish Service
Security Service
Custody and Ownership Transfer Service
WSDL
UDDI Representation of the Object Model
Attributes
Key/Value Pair Attributes
Rich Text Attributes
Document Attributes
Relationship Attributes
Metrics Definition
Metrics Reference Taxonomy
Metrics Types Taxonomy
Total Request Count Taxonomy
Success Request Count Taxonomy
Fault Request Count Taxonomy
Average Response Time Taxonomy
Minimum Response Time Taxonomy
Maximum Response Time Taxonomy
Availability Taxonomy
Service Liveliness Taxonomy
Representing Targets and Target Types
Representing Status
Representing Version
Mapping WS-PolicyAttachments
Configuring the UDDI Environment
Configuration Properties
UDDI in a Multi-CAST Environment
CAST Registration/Deregistration
Deployment Descriptors
Changing the User ID/Password of the Web Application Login Account
Setting Global and Local UDDI Properties
Setting Global UDDI Properties
Setting Local UDDI Properties
Getting Global and Local UDDI Properties
Schema Validation of UDDI Requests
Checked Value Set Validation
Predefined Value Sets
Predefined tModels
UDDI V3 APIs
Overview
Classes and Interfaces
RegistryService
RegistryConfiguration
RegistryFramework
RegistryAgent
UDDI_Security_SoapService
UDDI_Inquiry_SoapService
UDDI_Publication_SoapService
UDDI_Taxonomy_SoapService
CentraSiteBusinessService
Examples
Getting the Value of an Attribute
Getting the Proxy Services for a Specified Target
Inquiring about a Business Service
Publishing a Business Service
Fetching Taxonomies
Using Third-Party IDE Tools with CentraSite
Overview
Supported IDE Tools
Specifying the Inquiry, Publish, and Security URLs
WTP Eclipse 1.5.2 Plug-In
IBM Rational Application Developer 6.0
Connecting to CentraSite
Publishing Entities
UDDI Extensions
Using WSDL in a UDDI Registry
Using WS-PolicyAttachment
Version 1.2 Support
Supported Policy Subjects
Referencing Remote Policy Expressions
Registering Reusable Policy Expressions
Registering Policies in UDDI Version 3
tModels to Support UDDI-Based WS-PolicyAttachments
Version 1.5 Support
Extending UDDI Publisher API Set to Enable Physical Deletion of tModels
Arguments
Behavior
Returns
Caveats
Application Framework
Introduction
RegistryBean
BeanPool
StandaloneRegistryProvider
Configuration
Bean Types Managed by CSAF
Bean Modes
Persistence Modes
Cache Configuration
Re-Reading Outdated Objects
Mapping Beans to Registry Objects with Annotations
Introduction to Bean Mapping
Standard Mappings
Standard Mappings Usage Sample
Generating Beans from the Command Line
Querying the Registry
Application Framework Simple Search
Creating a Search Object
Restricting the Search Results by Adding Search Predicates
Defining the Order of the Search Results
Invoking the Search
Extending the Application Framework
Application Framework JAXR-Based Search
Event Mechanism
Asset Types
Usage Sample for Type Management
Association Types
Usage Sample for Association Type Management
Lifecycle Management
Usage Sample for LCM
Revision Management
Usage Sample for Revision Management
Multi-User Scenarios
Setting the Classpath
Examples
CRUD Example
API for JAXR
Introduction to the CentraSite API for JAXR
Creating and Closing a JAXR-based Connection
Creating a JAXR-based Connection
Closing a JAXR-based Connection
Defining a Service
Service that Uses Another Service
Service with Additional Information
Pre-Defined Classification Schemes (Taxonomies)
Impact Analysis
CentraSite API for JAXR Reference Information
Creating User-Defined Objects
Direct XQuery Access to the Stored Data
Unique Keys
Simultaneous Database Access and Locking
Caller
Semantics of Remove Operations
Delete Operation
RegistryObject
Association
AuditableEvent
Classification
ClassificationScheme
Concept
ExternalIdentifier
ExternalLink
Organization
RegistryEntry
RegistryPackage
Service
ServiceBinding
SpecificationLink
User
Unsupported Methods
Unsupported FindQualifiers
Using Wildcards
Using Namespaces
Method createSlot
Caching Considerations
JAXR-based Caching Strategy
Caching in User Interfaces
Dynamically Loaded JAR Files
Cache Location
API for XQJ
Introduction to the API for XQJ
What is XQJ?
Features of the XQJ Interface
Working with the XQJ Interface
Executing an XQuery with a Standard XQExpression
Executing an XQuery with an XQPreparedExpression
Working with a Materialized XQSequence
Examples
CentraSite-Specific Extensions to XQJ
Updating a Database Using XQJ
Inserting a Document in the Registry/Repository
XQDataSource Properties
Java Management Interface
Introduction the Java Management Interface
Description
Attributes and Operations
Attributes
Registry/Repository Start/Stop Operations
Web Service Interfaces
Introduction to the Web Service Interfaces
Approval Service
About the Approval Service
Invoking Operations from the Approval Service
Specifying the Authenticated User
Specifying the Location of the Approval Log
Retrieving the List of Approval Requests that a User Has Submitted
ApprovalRequestList Message
Getting Details about the Actions of the Approvers Associated with a Request
Approving or Rejecting Approval Requests
Scrolling Through the List of Returned Approval Requests
Reverting a Pending Approval Request
Operations
getPendingApprovals
getApprovalRequests
getApprovalActions
approve
reject
getApprovalHistory
revertPendingStateChange
ApprovalRequestList
ApprovalActionResult
Customizing CentraSite
Customization of CentraSite Business UI
Customizing the Login Page
CentraSite Business UI Configuration Files
Configurations for a Custom Login Page
Customizing the Welcome Page
Configurations for a Custom Welcome Page
Customizing Content Pages
Log in to CentraSite Business UI
Request an Account
Extending Activity Menu
Implement Activity as a GTW Extension
Enable Activity through Configuration
Replace Standard Search Widget
Advanced Search Criteria
Browse Link
Browse Search Criteria
Extend Search View
Replace Standard Asset Detail Page
Adding Action Menu
Implement Action as an Extension
Enable Action through Configuration
Adding Portlets
Implement Portlet as a GTW Extension
Enable Portlet through Configuration
Computed Runtime Actions
Implement Runtime Action as an Extension
Enable Runtime Action through Configuration
Installing an Extension
Setting up the GTW
Configuring an Extension
Uninstalling an Extension
Creating a Custom Extension
Customization of CentraSite Control
Customizing the Welcome Page
Implementation of Welcome Page
Installing the Customized Welcome Page
Sample Customized Welcome Page
Customizing CentraSite i18n Messages
Understanding Message Bundles
Customizing i18n Messages
Fetching a Message Key
Changing a Message Value
Implementing the Sample Customized Welcome Page
Customizing Content Pages
Extension Points
Activating the IDE
Setting Preferred Plug-in and Order of Plug-ins
Special and Advanced Topics
Creating a Sample Customized Plug-in for Content Pages
Eclipse Prerequisites
Setting up the Plug-in Project
Plugging into CentraSite Control
Including Your Own Layouts to the Screen
Legal Notices
Copyright
API Management
Copyright
to-soagov_apimgmt_landing_page
to-quickstart
to-bus_process_mgmt
to-analytics_decisions
api_management
to-application_integration
to-b2b_integration
to-in_memory_data_mgmt
to-master_data_mgmt
to-webm_products_using_terracotta
to-licensingRequirements
to-installing_terracotta_server_array
to-using_cc_to_manage
to-system_cache
to-overview_of_api_management_solutions
co-centrasite_and_api_management
co-getting_started_with_api_management
ta-creating_an_api
co-view_api_list
ta-viewing_details_for_an_api
ta-editing_the_properties_of_an_api
to-setting_permissions_on_an_api
to-configuring_the_api_consumption_settings
to-managing_api_keys_and_oauth_2.0_tokens
to-approving_a_request
to-deleting_an_api
to-export_import_api
to-working_with_email_notifications
to-working_with_predefined_policies
to-overview_of_administering_the_business_ui
co-conceptual_overview_of_the_business_user_interface
to-working_with_the_business_user_interface
to-working_with_organizations_users_groups_and_roles
to-exporting_and_importing_registry_objects
to-managing_assets
to-managing_the_catalog
to-working_with_approval_workflows
to-message_handling_and_diagnostics
to-working_with_portlets
to-business_user_interface_pluggable_architecture
to-built-in_portlets_reference
to-OData_heading
co-overview_odata_service
co-overview_odata_edm_components
co-metadata_odata_service
co-about_centrasite_odata_model
co-odata_resource_urls
co-add_odata_services
ta-creating_odata_service_method1
ta-creating_odata_service_method2
co-creating_odata_service_method3
ta-viewing_list_of_odata_services
ta-viewing_or_editing_the_properties_of_an_odata_service
ta-versioning_an_odata_service
co-changing_ownership_of_odata_services
co-virtualizing_an_odata_service
co-publishing_odata_services
co-deleting_odata_services
co-introduction_to_managing_users_and_organizations
to-basic_organization_structure
co-planning_your_organization_structure
co-who_can_create_and_manage_organizations
co-organization_administrators_and_primary_contacts
ta-adding_a_top-level_organization
ta-viewing_or_editing_the_properties_of_an_organization
ta-adding_a_child_organization_to_an_organization
ta-deleting_an_organization
co-overview_asset_navigator
co-graphical_visualization
co-navigate_activity_bar
co-navigate_actions_bar
co-types-of-charts
re-treechart
re-sunburst
re-icicle
re-graph
co-configuration_settings
co-add_custom_usecases
to-working_runtime_policies
to-working_runtime_aliases
to-using_centrasite_with_api-portal
to-ag_about_this_guide
co-oview_why_expose_apis
co-oview_what_is_api_management
co-oview_what_is_api_portal
co-config_before_you_configure_api_portal
co-config_security_overview
co-config_securing_client_requests
ta-config_options_method
ta-config_secure_password
co-config_sending_email_notifications
co-config_configuring_smtp_mail_server
ta-config_configuring_smtp_mail_server_umc
ta-config_configuring_smtp_mail_server
co-config_usage_reports
ta-config_creating_usage_report
co-config_ports_overview
co-config_about_enablingdisabling
ta-config_disabling_port
ta-config_enabling_port
co-config_testing_https_requests
co-config_considerations_multiple_nwinterfaces
ta-config_reconfiguring_load_balancer
co-config_reconfig_loadbalancer_dmzproxy
ta-config_reconfig_loadbalancer_dmzproxy
ta-config_update_sslcert
co-config_configuring_components
re-config_apipportal_config_param
re-config_preparing_to_publish_unpublish_api
co-config_license_file
ta-config_license-file-ACC
ta-config_license-file-UMC
co-config_registering_users
ta-register_apiportal
ta-config_approval_workflow
ta-config_assign_users_approver_group
ta-config_your_approval_workflow
ta-config_working_pending_approvals
ta-config_email_confirm_user_reg
ta-config_auto_user_reg
co-config_view_manage_users
co-config_email_notif_templates_tokens
ta-config_customize_email_template
re-config_email_tokens
co-config_advanced_configuration_api_portal
co-config_configuration_api_portal_external_db
ta-config_apiportal_ms_sqlserver
ta-config_apiportal_oracle_db
co-config_user_reg_social_network
ta-config_google_login
ta-config_facebook_login
re-config_oauth_properties_social_login
ta-config_removing_social_login
ta-config_connect_to_spec_server
co-ha_setup
ta-setting_up_HA_setup
co-config_manage_tenants
ta-config_create_tenants
ta-config_delete_tenants
co-apmgt_overview
co-apmgt_initialization_steps
ta-apmgt_starting_api_portal_windows
ta-apmgt_starting_api_portal_linux
ta-apmgt_stopping_api_portal_windows
ta-apmgt_stopping_api_portal_linux
ta-apmgt_opening_api_portal_ui
re-apmgt_api_portal_server_components
re-apmgt_verifying_status_api_portal_components
re-apmgt_understanding_api_portal_component_status
re-apmgt_starting_stopping_api_port_components
co-um_overview_managing_users
co-um_users_groups_roles_permissions
re-um_predefined_roles_centrasite
co-um_other_users_centrasite
re-um_predefined_roles_api_portal
co-um_other_users_api_portal
co-comm_overview
co-assetmgt_planning_for_api_mgmt
co-assetmgt_about_api_portal_assets
co-assetmgt_api_portal_profile_in_centrasite
co-assetmgt_publishing_apis_to_api_portal
co-assetmgt_handling_requests_for_api_access_tokens
co-assetmgt_api_portal_extension_points
co-assetmgt_managing_keymgmt_providers
co-assetmgt_managing_access_tokens_912
co-api_packages_plans
ta-package_create
ta-package_create_plan
ta-package_link_plan
ta-package_unlink_plan
ta-package_delete
ta-package_link_api
ta-package_unlink_api
ta-package_link_provider
ta-package_unlink_provider
co-configuring_audit_log
co-purging_logs
ta-purging_logs_using_rest
ta-purging_from_ui
co-backup_restore_tenant_data
co-config_prereq_backup_restore
ta-config_using_acc_rest
ta-config_using_config_file
ta-config_backup_tenant_data
ta-config_restore_tenant_data
co-troubleshoot_backup_restore
to-chapter_heading_about_rest
co-overview_rest_model
co-overview_applications
co-overview_resources
co-overview_resources_methods
co-overview_parameters
co-overview_content_types
co-overview_status_codes
co-overview_requests_and_responses
to-chapter_heading_create_importer
co-documenting_importer_overview
co-import_raml_concept
ta-import_raml_file
re-import_raml_mappings
co-import_swagger_concept
ta-import_swagger_file
re-import_swagger_mappings
to-chapter_heading_create_scratch
co-documenting_pragmatic_api
ta-scratch_add_simple_api
ta-scratch_configure_baseuri
ta-scratch_add_resource
ta-scratch_add_method
ta-scratch_add_parameter
ta-scratch_add_request
ta-scratch_add_response
ta-scratch_add_message
to-chapter_heading_managing
co-manage-view-concept
ta-manage_view_bulk
ta-manage_view_single
co-manage-edit-concept
ta-manage_edit_basic
ta-manage_edit_extended
co-manage-delete-concept
ta-manage_delete_details_page
ta-manage_delete_results_page
ta-generate_swagger_spec
to-centrasites_role_in_todays_soa
to-features
to-topology_and_architecture
to-the_information_model
to-editions
to-implementation_decisions_and_configuration_tasks
to-choosing_a_deployment_strategy
to-defining_your_organizational_structure
to-setting_up_users_and_groups
to-customizing_your_asset_catalog
to-defining_lifecycle_models
to-defining_design-change-time_policies
to-working_with_versions_and_revisions
to-planning_your_run-time_environment
to-implementing_the_mediation_environment
to-managing_run-time_policies
to-managing_virtualized_services
to-identifying_the_consumers_of_virtual_services
to-managing_endpoints
to-overview_of_basic_operations
co-start_and_stop_centrasite
to-administering_the_license_key
to-before_you_start_using_centrasite
to-maintaining_the_centrasite_internal_database
to-configuring_the_authentication_settings
to-configuring_port_numbers
to-configuring_secure_communication_between_components
to-configuring_the_registry_cache_settings
to-configuring_the_email_server
to-overview_of_the_administration_tools
to-usage_of_the_centrasite_command_tools
to-usage_of_the_centrasite_toolbox_scripts
to-your_user_account
to-ways_to_interact_with_centrasite
to-using_the_user_interface
to-overview_of_authentication_topics_and_ldap
to-overview_of_user_repositories
to-creating_authentication_configurations
to-configuring_the_internal_authentication_type
to-configuring_ldap
to-performing_maintenance_on_authentication_configurations
co-creating_an_administration_user_from_the_command_line
to-logging_of_login_authentication_messages
co-transform_and_migrate_LDAP_data
to-notes_on_authentication_in_centrasite
to-about_users
to-about_groups
to-about_roles_and_permissions
to-changing_passwords_of_predefined_users_and_login_users
to-introduction_to_importing-exporting_registry_objects
to-exporting_and_importing_specific_object_types
to-exporting_and_importing_objects_using_centrasite_control
to-exporting_and_importing_objects_from_the_command_line
to-overview_of_importing_objects_using_the_api
to-invoking_an_importer_from_a_java_program
to-invoking_an_importer_from_a_java_class
to-invoking_an_importer_from_the_command_line
to-invoking_an_importer_using_the_soap_api
to-writing_your_own_importer
co-what_is_a_type
co-classifications_of_a_type
co-components_of_a_type
co-who_can_create_and_manage_types
to-creating_a_new_type
co-viewing_or_editing_a_type
to-using_inherit_profiles
ta-cloning_profiles
ta-excluding_subtypes
to-the_predefined_asset_types_in_centrasite
ta-customizing_the_user_and_organization_types
co-deleting_a_type
to-working_with_composite_types
to-working_with_association_types
to-chapter8_heading
to-overview_of_customizing_lifecycle_management
to-introduction_to_customizing_lifecycle_management
co-who_can_create_and_manage_lifecycle_models
co-viewing_or_editing_a_lifecycle_model
to-creating_a_lifecycle_model
ta-activating_a_lifecycle_model
ta-updating_a_lifecycle_model
ta-deleting_a_state_from_a_model
co-deleting_a_lifecycle_model
co-lifecycle_model_for_lifecycle_models_(lcm_for_lcms)
co-the_predefined_lifecycle_models_installed_with_centrasite
to-chapter9_heading
to-introduction_to_taxonomies
co-who_can_create_and_manage_taxonomies
co-visibility_of_taxonomies_in_centrasite
co-creating_a_taxonomy
ta-creating_a_taxonomy_control
ta-creating_a_taxonomy_business
ta-associating_taxonomy_to_object_type
ta-setting_permissions_on_taxonomy
co-viewing_the_taxonomies_list
ta-viewing_the_taxonomies_list_control
ta-viewing_the_taxonomies_list_business
co-viewing_or_editing_the_properties_of_a_taxonomy
ta-viewing_or_editing_the_properties_of_a_taxonomy_control
ta-viewing_or_editing_the_properties_of_a_taxonomy_business
ta-adding_a_category
ta-viewing_or_editing_the_properties_of_a_category
ta-deleting_a_category
co-deleting_a_taxonomy
ta-deleting_a_taxonomy_control
ta-deleting_a_taxonomy_business
co-predefined_taxonomies_in_centrasite
to-chapter10_heading
to-overview_of_logging
to-configuring_logs
to-monitoring_logs
to-audit_log_for_user
co-overview_of_purging
to-purging_logs
to-exporting_the_purged_log_records
ta-configuring_the_purger_properties_for_high_volume_data_handling
to-chapter11_heading
to-overview_of_registry_federations_in_centrasite
co-overview_of_the_federation_process
co-creating_a_federation_configuration_file
co-adding_a_uddi_federation_to_the_federation_list
co-triggering_the_uddi_federation
co-removing_a_uddi_federation_from_the_federation_list
co-displaying_the_list_of_target_registries_defined_for_federation
to-mapping_uddi_object_ids_and_tmodels
co-users_and_access_rights
to-chapter12_heading
to-overview_of_suite_usage_aspects
co-versioning_assets
co-modifying_or_deleting_assets
co-publishing_an_asset
to-communication_with_designer_ui
co-user_accounts
co-uddi_clients
to-using_centrasite_with_aris
to-chapter1_heading
to-components_of_the_run-time_governance_environment
to-chapter2_heading
co-introduction_to_consumer_applications
co-who_can_create_and_manage_consumer_applications
to-creating_and_managing_consumer_applications
to-deploy_consumer_applications
to-chapter3_heading
co-introduction_consumer_registration
co-register_consumer_applications
co-required_permissions_for_registration
co-dt_policy_for_consumer_registration
to-implementing_consumer_registration
co-viewing_consumer_registration_requests
co-monitoring_consumer_count
ta-viewing_consumer_details
ta-unregistering_an_existing_consumer
to-chapter4_heading
co-introduction_to_run-time_gateways
co-who_can_create_and_manage_gateways_and_gateway_types
to-creating_and_managing_gateway_types
to-chapter5_heading
co-introduction_to_virtualized_services
co-who_can_create_and_manage_virtualized_services
to-creating_virtualized_services
to-configuring_soap-based_virtual_services
to-configuring_rest_or_xml_virtual_services
ta-viewing_or_editing_the_profiles_of_virtualized_services
to-creating_run-time_policies
to-deploying_virtualized_services_and_consumer_applications
to-chapter6_heading
co-intro_virtual_api
co-who_can_manage_virtual_apis
to_preparing_virtualize_publish
to-runtime_components_virtualapi
to-creating_a_virtual_api
to-reconfiguring_a_virtual_api
co-synchronize_resources_virtual_apis
to-versioning_virtual_service_or_api
ta-editing_the_properties_of_an_api_proxy
to-configure_runtime_actions
to-publish_and_unpublish_api
co-exposing_soap_as_rest
to-displaying_runtime_information_for_an_api_proxy
to-obtaining_your_api_keys_and_access_tokens_for_consumption
to-managing_your_api_keys
co-privileged_user_of_an_api_proxy
to-invoking_webmethods_is_services_in_virtualized_services
to-using_context_variables_in_virtualized_services
to-important_considerations_when_configuring_soap-based_virtual_services
to-important_considerations_when_configuring_rest_or_xml_virtual_services
to-chapter7_heading
to-run-time_events_and_key_performance_indicator_(kpi)_metrics
to-built-in_run-time_actions_reference_for_virtual_services
to-built-in_run-time_actions_reference_for_apis
to-computed_runtime_actions
re-document_conventions
re-webm_online_information
co-what_is_mediator
co-mediator_soa_landscape
co-mediator_key_capabilities
co-components_mediator_uses
co-versioning_support_mediator
co-ws_addressing_processing_mediator
co-implementation_ws_addressing_centrasite
co-ws_addressing_scenarios_mediator
co-implementing_ws_addressing_mediator
ta-creating_is_flow_service_ws_addressing
co-client_request_sending_ws_addressing_information
co-mediator_gzip_functionality
co-mediator_behaviour_various_gzip_scenarios
co-rest_to_soap_transformation
co-invoking_rest_enabled_soap_api
co-handling_multipart_from_data
co-enabling_xslt_is_service_transformations
co-limitations
co-axis_free_rest_med_stack
co-overview_configuring_mediator
ta-before_configuring_mediator
ta-configuring_communication_with_centrasite
co-overview_kpi_and_events_ag
co-kpi_metrics
co-run_time_events
co-metrics_tracking_interval
co-event_notification_destinations
co-destinations_monitoring_transaction_events
co-eda_configuration_publishing_events_metrics
ta-preq_configuring_mediator_publish_to_eda
re-key_metrics_runtime
re-transaction_events_table
re-monitoring_events_table
re-policy_violation_events_table
re-error_events_table
re-lifecycle_events_table
re-performance_metrics_table
co-api_portal_configuration_publishing_events_metrics
ta-configuring_communication_with_api_portal
co-es_configuration_publishing_events_metrics
ta-configuring_communication_with_elasticsearch
re-key_metrics_runtime_elasticsearch
re-transaction_events_elasticsearch
re-monitoring_events_elasticsearch
re-lifecycle_events_elasticsearch
re-policy_violation_events_elasticsearch
re-error_events_elasticsearch
re-performance_events_elasticsearch
co-snmp_destinations_run_time_events
ta-setting_mediator_use_centrasite_snmp_server
ta-setting_mediator_use_thirdparty_snmp_server
ta-importing_mib_mediator_traps
ta-setting_mediator_use_thirdparty_snmp_security_server
ta-setting_mediator_use_thirdparty_snmp_community_server
ta-specifying_events_to_publish
co-smtp_destinations_alerts_transaction_logging
ta-configuring_smtp_destination
ta-configuring_keystore
ta-configuring_ports
co-configuring_proxy_servers
co-configuring_global_service_fault_responses
ta-configuring_global_service_fault_response
re-fault_handler_variables
co-saml_support_mediator
co-esb_service_saml_token
ta-configuring_is_keystores
co-configuring_saml_holder_key_processing
ta-run_time_processing_holder_key_tokens
co-configuring_sts_holder_key_processing
ta-configuring_sts_holder_key_processing
ta-configuring_is_virtual_services_holder_key
co-configuring_saml_sender_vouches_processing
ta-configuring_sts_sender_vouches_processing
ta-configuring_virtual_services_sender_vouches
co-configuring_saml_bearer_token
ta-configuring_sts_saml_bearer_token_processing
co-configuring_is_mediator_virtual_service_bearer
co-configuring_custom_content_type
co-oauth2_inbound_configuration
ta-watt_server_auth_skip_for_mediator_parameter
co-pg_oauth2_parameters
co-service_obtaining_oauth2_access_token
co-overview_soap_jms
ta-configuring_soap_jms_messaging
co-creating_soap_jms_web_service_endpoint_aliases
ta-creating_soap_jms_web_service_endpoint_alias_trigger
ta-viewing_thread_usage_soap_jms_triggers
ta-increasing_decreasing_thread_usage_all_triggers
ta-enabling_disabling_suspending_soap_jms_trigger
co-creating_soap_jms_consumer_web_endpoint_alias
ta-creating_soap_jms_web_service_endpoint_jndi_provider
ta-creating_soap_jms_web_service_endpoint_alias_jms_connection
co-built_in_services
ta-viewing_services_deployed_mediator
ta-viewing_consumer_applications_deployed_mediator
co-overview_clustering_balancing
co-nodes_clusters
co-load_balancers
re-load_balancer_urls
co-creating_mediator_cluster
ta-load_balancing_configuration
co-deployment_in_cluster
co-processing_service_requests_cluster
co-metric_event_notification_cluster
co-role_shared_cache_metrics_event
co-senior_node
co-processing_interval
co-non_aggregated_run_time_events
co-aggregated_events_performance_data
co-load_balancing_service_providers
co-summary_built_in_run_time_actions
co-built_in_run_time_virtual_services
co-ws_security_policy_action
co-monitoring_actions
co-additional_actions
co-built_in_run_time_virtualized_apis
co-request_handling_actions
co-policy_enforcement_actions
co-response_handling_actions
co-error_handling_action
co-outbound_authentication
co-built_in_run_time_virtual_odata_services
co-request_handling_actions_odata
co-policy_enforcement_actions_odata
co-response_handling_actions_odata
co-error_handling_action_odata
co-masking_odata_service
re-advanced_settings
re-advanced_settings_overview
re-pg_3psnmpsender
re-pg_cs_snmp_target
re-pg_cs_snmp_sender
re-pg_failed_proxies
re-pg_pg_men_configuration
re-snmp_community_target
re-pg_snmp_user_target
re-pg_jaas_context_name
re-pg_default_enable_old_version
re-pg_use_native_content_type
re-pg_apikey_remove_param
re-pg_apikey_header
re-pg_es
re-pg_apiportal
re-pg_rest_service_redirect
re-server_configuration_parameters
re-watt_debug
re-watt_net
re-watt_pg
re-watt_server
to-about_this_guide
to-role_of_administrator
to-overview_of_server
to-start_stop_server
to-multi_IS_instances
to-use_server_administrator
to-manage_users_groups
to-configure_the_server
to-jdbc_pools
to-configure_ports
to-server_log
configure_wm_msg_toc
configure_wm_msg_overview
configure_wm_msg_connection_alias
configure_wm_msg_um_authentication
configure_wm_msg_um_ssl
configure_wm_msg_broker_keep_alive
configure_wm_msg_broker_client_sync_primary_port
configure_wm_msg_document_stores
configure_wm_msg_load_balancing
configure_jms_toc
configure_jms_overview
configure_jms_working_with_jndi
configure_jms_working_with_jms_conn_alias
configure_jms_create_admin_objects
configure_jms_monitor_conn_factory_object
configure_jms_using_ssl
configure_jms_supported_providers
configure_jms_adding_libraries_to_classpath
to-ws_endpoint_alias
to-reliable_messaging
to-kerberos
to-http_url_alias
to-sftp
to-secure_communications
to-control_access_to_resources
to-authenticate_clients
to-auth_using_jaas
to-outbound_passwords
to-csrf_guard
to-enterprise_gateway
to-configure_oauth
to-external_directory
to-manage_packages
to-manage_services
to-schedule_services
to-cache_service_results
to-configure_guaranteed_delivery
to-configuring_ehcache_on_integration_server
to-xml_enhanced_parser
to-lock_administration
to-optimize_pub_sub
esb.blt.messageProcessing.serial.migrated
esb.blt.messageProcessing.change.UM.sync
to-jms_triggers_toc
co-jms_triggers_intro
ta-jms_triggers_enable_disable_suspend
co-jms_triggers_control_thread_usage
co-jms_triggers_config_is_session_reuse
co-jms_triggers_config_jms_session_reuse
co-jms_triggers_delay_poll_requests
co-jms_triggers_about_ws_endpoint
to-doc_history-database
to-xa_doc
to-content_handlers
to-quiesce_server
to-diagnose_is
using_cc_to_manage_is_toc
integration_server_instance_management
cce.instance.create
cce.instance.update
cce.instance.del
re-managing_is_instances_using_cli
cce.accessing.admin.interfaces.through.cc
cc.authentication.mode
ta-changing_the_administrator_user_password_for_managed_products_in_command_central
ta-configuring_is_for_ssl_connection
co-monitoring_is_instances
is_cli_instance_monitoring_runtimestatus
is_cli_instance_monitoring_runtimestates
cce.monitoring.kpi.is
co-is_configuration_types
is_cli_configuration_cfgtypes
cce.is.configurationtypes.workingwith
is_cli_lifecycle_actions
re-migrating_an_integration_server_instance
is_cli_supported_commands
re-using_unix_shell_scripts_to_change_connection_credentials_for_managed_products
IS_CLI_upgrade
to-server_deployment_checklist
chapter_toc
introduction
watt_art
watt_broker
watt_brokercoder
watt_cachedirective
watt_cds
watt_config
watt_core
watt_debug
watt_debug2
watt_infradc
watt_net
watt_security
watt_server
watt_ssl
watt_ssh
watt_wm_tnextdc
watt_tx
watt_um
watt_xslt
to-fips_140-2_compliance
to-integrated_win_auth
to-wireless_communication
to-debug_service_exceptions
to-server_log_facilities
co-overview_of_the_uddi_standard
co-summary_of_uddi_support_in_centrasite
to-centrasite_uddi_architecture
to-uddi_representation_of_the_object_model
to-configuring_the_uddi_environment
co-predefined_value_sets
co-predefined_tmodels
to-uddi_v3_apis
to-using_third-party_ide_tools_with_centrasite
to-uddi_extensions
to-introduction_to_application_framework
to-configuration
to-mapping_beans_to_registry_objects_with_annotations
to-querying_the_registry
co-event_mechanism
to-asset_types
to-association_types
to-lifecycle_management
to-revision_management
co-multi-user_scenarios
co-setting_the_classpath
to-examples
co-overview_of_the_centrasite_api_for_jaxr
to-creating_and_closing_a_jaxr-based_connection
co-defining_a_service
co-a_service_that_uses_another_service
co-a_service_with_additional_information
co-pre-defined_classification_schemes_(taxonomies)
co-impact_analysis
to-part_heading_jaxr_reference
ta-user-defined_objects
co-direct_xquery_access_to_the_stored_data
co-unique_keys
co-simultaneous_database_access_and_locking
co-the_caller
co-semantics_of_remove_operations
to-delete_operation
co-unsupported_methods
co-unsupported_findqualifiers
co-using_wildcards
co-using_namespaces
co-the_method_createslot
to-caching_considerations
to-overview_of_the_api_for_xqj
to-what_is_xqj
to-working_with_the_xqj_interface
to-centrasite-specific_extensions_to_xqj
co-xqdatasource_properties
co-introduction_to_java_management_interface
co-description
to-attributes_and_operations
to-overview_of_web_service_interfaces
to-approval_service
co-customize_bui
ta-customize_login_page_bui
re-customize_config_files_bui
re-customize_config_login_page_bui
ta-customize_welcome_page_bui
re-customize_config_welcome_page_bui
co-customize_content_pages_bui
re-customize_login_ext_bui
re-customize_req_account_bui
ta-customize_extend_actmenu_bui
re-customize_implement_act_ext_bui
ta-customize_enable_act_config_bui
re-customize_replace_serch_wdgt_bui
re-customize_advncd_search_criteria_bui
re-customize_browse_link_bui
re-customize_browse_search_bui
re-customize_extend_search_bui
re-customize_replace_std_assetpage_bui
ta-customize_add_action_menu_bui
re-customize_implement_action_bui
ta-customize_enable_action_config_bui
ta-customize_add_portlets_bui
re-customize_implement_portlet_bui
ta-customize_enable_portlet_bui
ta-customize_computed_runtime_bui
re-customize_implement_runtimeaction_bui
ta-customize_enable_runtimeaction_config_bui
ta-customize_install_extension_bui
ta-customize_settingup_gtw_bui
ta-customize_config_extension_bui
ta-customize_uninstall_extension_bui
ta-customize_create_custom_extension_bui
co-customize_cui
co-customize_welcome_page_cui
co-customize_implement_welcome_page_cui
ta-customize_install_welcome_page_cui
co-customize_sample_customized_welcome_page_cui
co-customizing_cs_i18n_mesage
ta-customize_implement_sample_welcome_page_cui
co-customize_content_pages_cui
re-customize_extension_points_cui
co-customize_activate_ide_cui
co-customize_setting_preferred_plugin_cui
re-customize_special_adv_topics_cui
co-customize_sample_customized_content_page_cui
co-customize_eclipse_prereq_cui
ta-customize_settingup_plugin_proj_cui
ta-customize_plugginginto_cs_cui
ta-customize_include_layouts_cui
to-online-copyright-page