API Management
General Information
Document Conventions
Online Information and Support
Data Protection
Using BigMemory 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
webMethods Event Routing (Deprecated)
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 Module for HIPAA
SoftwareAG.IS.HIPAA.CodeSourceCache
SoftwareAG.IS.HIPAA.DefaultCache
webMethods RosettaNet Module
SoftwareAG.IS.RosettaNet.RNModelSessionCache
webMethods Event Routing (Deprecated)
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
API Gateway Quick Start
Let's get you started
API Gateway Overview
Quick Start Milestones
Install API Gateway
How Do I Install API Gateway?
How Do I Install API Gateway using an Image in Windows system?
How Do I Install API Gateway using an Image in Linux system?
How Do I Install API Portal?
Getting Started
How Do I Launch and Log on to API Gateway?
How Do I Launch and Log on to API Portal?
Create an API
How Do I Create an API?
How Do I Create an API by Importing from a File?
How Do I View API Details?
How Do I Enforce Policies to Protect My APIs?
How Do I Enable Transaction Logs?
Publish an API
How Do I Configure Destination for Publishing APIs?
How Do I Publish an API?
How Do I View the published API?
Try an API
How Do I Request API Key to Access a Protected API?
How Do I Test a REST API in API Portal?
API Analytics
How Do I View API Analytics?
Quick Start.. In a Jiffy!
Quick Start Cheat-sheet
Administrating API Gateway
Deployment
Concepts
Security Considerations
API Gateway Editions
API Gateway Components
Deployment Models
Development Environment
Production Environment
High Availability, Disaster Recovery, and Fault Tolerance
Disaster Recovery vs Fault Tolerance
Cluster Deployment Options
External Dependencies
Reference Architectures
Recommended High Availability Architecture
High Availability and Disaster Recovery (HADR) solution
High Availability and Fault Tolerance (HAFT) solution
API Analytics
Containerization
Product Configurations
Deployment Configurations
Cluster Deployment
API Gateway Cluster Configuration
Enabling Clustering for API Gateway through the User Interface
Terracotta Server Array Configuration
API Data Store Cluster Configuration
Configuring Elasticsearch Cluster
Adding New Nodes to an Elasticsearch Cluster
Load Balancer Configuration
Ports Configuration
Configuring Multiple Instances of API Gateway in a Single Installation
Paired Deployment
Configuring Reverse Invoke Setup
Paired Deployment with Integration Server in Green Zone
Importing a Certificate and Mapping to User
Troubleshooting Tips: API Gateway and DMZ Connectivity
Connecting to an External Elasticsearch
Troubleshooting Tips
API Data Store
External Elasticsearch
Connecting to an External Kibana
Externalizing Configurations
Using the Externalized Configuration Files
Default Scenario
Troubleshooting
API Gateway Standard and Advanced Editions Capability Matrix
API Gateway, Elasticsearch, Kibana, and TSA Compatibility Matrix
Operating API Gateway
Administering API Gateway through API Gateway User Interface
Starting and Stopping API Gateway
Starting and Stopping API Gateway Using Scripts
Shut down or Restart API Gateway Using User Interface
Data Management
Types of Data and their Storage
Difference between Archive and Backup
Data Housekeeping
Archive and Purge using API
Restoring Archived Data using API
Archive and Purge using UI
Archiving Data
Purging Data
Restoring Archived Data using UI
List of events that can be archived or purged
Job Listing
Archive and Purge Configuration
Data Backup
Backup Requirements Analysis
Backup Repository Capacity Sizing
Backup Considerations
Backup Operation
Data Store Backup
Configuring a Backup Repository
Configuring a Local File System Repository
Configuring a Network File System Repository
Configuring a Cloud Repository in Amazon S3
Creating API Data Store Backup
Advanced Backup Options
Creating Backup of specific Indexes
Creating Rollover of an Index
Conditions that can be given with rollover command
Viewing Backup Files List
Verifying Backup Status
Deleting a Backup File
Specifying Log File Details
Viewing Exit Codes for Backup Script Operations
List of Indexes that can be included in backup
List of Indexes that can be backed up individually
Platform Data Backup
Creating Platform Data Backup using Script
Creating Platform Data Backup Manually
Backup folders monitoring
Troubleshooting a Failed Backup
Troubleshooting Tips: API Data Store Backup
Restore Operation
Pre-requisites
Restoring Data Store Backup
Verifying Restore Status
Restoring Platform Data
Restoring Platform Data backed up using the Script
Restoring the manually backed up Platform data
Troubleshooting a Failed Restore
Adding New Nodes to an Elasticsearch Cluster
API Data Store
Monitoring API Gateway
Cluster-level Monitoring
Troubleshooting: Cluster-level Monitoring
Node-level Monitoring
Application Monitoring
Monitoring API Gateway
Application Metrics
API Operational Metrics
Infrastructure Metrics
Container Metrics
Troubleshooting: Monitoring API Gateway
How Do I Generate Thread Dump?
How Do I Generate Heap Dump?
Causes for timeout errors
Monitoring API Data Store
Application Metrics
Infrastructure Metrics
Container Metrics
Troubleshooting: Monitoring API Data Store
Monitoring Terracotta
Infrastructure Metrics
Container Metrics
Troubleshooting: Monitoring Terracotta Server Array
Monitoring Kibana
Troubleshooting Tips: Monitoring Performance
General Administration Configuration
Clusters and Load Balancers
Configuring Load Balancer URLs
Configuring Extended Settings
Configuring API Fault Settings
Approval Configuration
Configuring Approvals for Creating an Application
Configuring Approvals for Registering Application
Configuring Approvals for Updating Application
Configuring Approvals for Subscribing Package
Configuring Approvals for Updating Subscription
Configuring Approvals for Deleting Subscription
Managing Pending Requests
Deleting Requests
Outbound Proxy
Configuring Proxy Server Alias
Modifying a Proxy Server Alias
Deleting a Proxy Server Alias
Proxy Bypass
Adding a Proxy Bypass
Modifying a Proxy Bypass
Deleting a Proxy Bypass
URL Aliases
Creating URL Alias
Using Port Mappings with URL Alias
Adding Port Mapping to URL Alias
Deleting Port Mapping for URL Alias
Enabling Partial Matching of URL Aliases
Modifying a URL Alias
Deleting a URL Alias
Example: Usage Scenarios of URL Aliases
Custom Content-types
Configure Custom Content-types
Cache Configuration
Configuring Cache to Improve Performance
Application Log Configurations
Configuring Log Levels
Downloading the Log Files
Configuring Log Aggregation
Filebeat
Logs Housekeeping
License Configuration
Viewing Licensing Information
Configuring Licenses
Configuring API Callback Processor Settings
Messaging
Creating a JNDI Provider Alias
Creating a JMS Connection Alias
Web Services Endpoint Alias
Creating an Endpoint Alias for a Provider Web Service Descriptor
Creating an Endpoint Alias for a Consumer Web Service Descriptor
JMS Triggers
Updating JMS triggers
Transaction Alerts
Configuring Criteria for Transaction Alert Notification
Modifying License Alert Configurations
Deleting a Transaction Alert Configuration
Destination Configuration
Configuring Events for API Gateway Destination
Troubleshooting Tips: API Gateway Destination
Configuring API Portal Destination
Configuring Events for API Portal Destination
Configuring Transaction Logger Destination
Configuring CentraSite Destination
Configuring Events for CentraSite Destination
Configuring Events for Database Destination
Configuring Events for Digital Events Destination
Configuring Elasticsearch Destination
Troubleshooting Tips: Elasticsearch Destination
Configuring Events for Elasticsearch Destination
Configuring Email Destination
Configuring Email Templates
Configuring SNMP Destination
Configuring Events for SNMP Destination
Custom Destination
How Do I Publish Data to an External Endpoint using Custom Destination?
How Do I Publish API-specific Traffic Monitoring Data to a Custom Destination?
How Do I Publish Data to an Integration Server Service using Custom Destination?
How Do I Publish Data to an AWS Lambda Function using Custom Destination?
How Do I Publish Data to a Message Queue using Custom Destination?
Troubleshooting Tips: API Gateway - API Portal Integration
Audit Logging
Configuring Audit Logs
Viewing Audit Logs
Filtering Audit Log Results
Downloading Audit Logs
System Settings
Modifying API Gateway Configuration Parameters
SAML SSO
SAML Assertion
How to enable SAML SSO in API Gateway?
Precedence in Group Mapping
Troubleshoot tips for SSO configuration
Configuring External Accounts
Adding a Service Registry
Removing a Service Registry
Configuring an AWS Alias
Configuring Integration Server Instance for API Implementation
Configuration Types and Properties
webApp Configuration Properties
API Gateway Package Configuration Properties
Troubleshooting Tips: wmAPIGateway Package
Security Configuration
Overview of Keystore and Truststore
Keystore and Truststore
Configuring Keystore Information
Modifying Keystore Information
Deleting Keystore Information
Configuring Truststore Information
Modifying Truststore Information
Deleting Truststore Information
Configuring Keystore and Truststore Information for Inbound Messages
Configuring Keystore and Truststore Information for Outbound Connections
Ports
Adding an HTTP Port
Adding an HTTPS Port
Adding an API Gateway External Port
Configuring the API Gateway Internal listener
Configuring the WebSocket Listener
Configuring IP Access Mode for a Port
Allowing Access to All IP Hosts
Denying Access to All IP Hosts
Configuring Access Mode for a Port
Global IP Access Settings For Ports
Allowing Connections from Specified Hosts
Denying Connections from Specified Hosts
If You Inadvertently Deny IP Access to All Hosts
Configuring Restriction to IP Address based on Authentication
SAML Issuer
Custom Assertions
Creating a Custom Assertion
Viewing Custom Assertion List and Assertion Configuration
Modifying Custom Assertion
Deleting Custom Assertion
Example: Custom Assertions
Kerberos Settings
Configuring API Gateway to Use Kerberos
Master Password Management
Backing up the Password and Master Password Files
Updating the Master Password
Managing Master Password Expiry Interval
Advanced Configuration to Manage Master Password
Restoring the Password and Master Password Files
Resetting the Master Password
OAuth, JWT, and OpenID Configuration
OAuth Authentication Use case and Workflow
Retrieving OAuth Token
JWT Authentication Use case and Workflow
Retrieving JWT Token
Retrieving JWT Token with Claim
OpenID Authentication Use case and Workflow
Configuring the Internal Authorization Server
Adding a Provider
Adding an External Authorization Server
Mapping OAuth or OpenID Scopes
Viewing Scope Mapping Details
Viewing Provider List and Provider Configuration
Modifying the Provider Configuration
Viewing Authorization Server List and Server Configuration
Modifying Authorization Server Configuration
Deleting an Authorization Server
Deleting a Provider
Configuring Communication Details for Microgateway
Securing API Gateway Communication using TLS
How Do I Secure API Gateway Server Communication with API Clients?
How Do I Secure API Gateway Server Communication with Backend Services?
How do I Secure API Gateway User Interface Communication?
How do I Configure a Secure Communication Channel between API Gateway and API Portal?
How do I Secure API Data Store Communication using HTTPS?
How do I Secure API Data Store Communication using HTTPS with ReadonlyREST Plugin?
How do I Secure API Data Store Communication using HTTPS with Search Guard Plugin ?
Search Guard Properties
Creating a Custom Keystore with Self-Signed Certificates
Troubleshooting Tips: Securing API Data Store (Elasticsearch)
Container-based Provisioning
Docker Configuration
Building the Docker Image for an API Gateway Instance
Retrieving Port Information of the API Gateway Image
Running the API Gateway Container
Load Balancer Configuration with the Docker Host
Stopping the API Gateway Container
Managing API Gateway Images
API Gateway Docker Container with Externalized Elasticsearch and Kibana
API Gateway Container Cluster Configuration
Running API Gateway Docker Containers with Docker Compose
Running a Single API Gateway and an Elasticsearch Container
Running Clustered API Gateway Containers and Elasticsearch Containers
Running Clustered API Gateway and Elasticsearch Containers and a Kibana Container
Troubleshooting Tips: Docker Configuration
Kubernetes Support
Deploying API Gateway Pod with API Gateway and Elasticsearch Containers
Deploying API Gateway Pod with API Gateway Container connected to an Elasticsearch Kubernetes Service
API Gateway Clustering on Kubernetes
Kubernetes Sample Files
Helm Chart
Using Helm to Start the API Gateway Service
OpenShift Support
Building a Docker Image for an API Gateway Instance in OpenShift Environment
Running the API Gateway Docker Image with the sagadmin User
OpenShift Sample Files
High Availability, Disaster Recovery, and Fault Tolerance
High Availability
Disaster Recovery vs Fault Tolerance
Keypoints about High Availability and Disaster Recovery (HADR) solution
Keypoints about High Availability and Fault Tolerance (HAFT) solution
High Availability and Disaster Recovery
What is Cold Standby Mode?
How Do I Set Up Data Center in Cold Standby Mode?
How Do I Set Up Data Center in Cold Stand By Mode With Backup of Assets Data Only?
What is Warm Standby Mode?
How Do I Set Up Data Center in Warm Standby Mode?
High Availability and Fault Tolerance
What is Hot Standby Mode?
What is Active-Active Mode?
Data Synchronization in Hot Standby and Active-Active Modes
How Do I Set Up the Data Centers in Hot Standby Mode Using Basic Operation?
How Do I Set Up the Data Centers in Hot Standby Mode Using Composite Operation?
How Do I Set Up the Data Centers in Active-Active Mode Using Basic Operation?
How Do I Set Up the Data Centers in Active-Active Mode Using Composite Operation?
How does Cross-DC Support Detect Data Center Failures?
How Do I Monitor the Health Status of the Data Center?
How Do I Bring Down a Single Data Center from Active-Active or Hot Standby Mode to Standalone Mode?
How Do I Bring Down Multiple Data Centers from Active-Active or Hot Standby Mode to Standalone Mode?
How Do I Read the Current Configuration of the Data Center?
Cross-DC Extended Settings
Performance Tuning and Scaling
Hardware and Product Configurations
Resource Sizing Guidelines
Logging Configurations
Product Configurations Guidelines
Changing the JVM Heap Size to Tune API Gateway Performance
Data Separation
Storing Analytics Data in external Elasticsearch
Scaling
Scaling up API Gateway
Scaling up API Gateway in a Reverse Invoke setup
Scaling up API Data Store
Scaling down API Gateway
Scaling down API Gateway in a Reverse Invoke setup - DMZ Zone
Scaling down API Gateway in a Reverse Invoke setup - Green Zone
Scaling down API Data Store
API Gateway Configuration with Command Central
Overview
Install API Gateway using Command Central
Installing API Gateway using Command Central Commands
Manage API Data Store Configurations in Command Central
Administering API Data Store
Starting, Stopping, and Restarting API Data Store
Starting and Stopping API Data Store in Command Central
Starting, Stopping, and Restarting API Data Store on Windows
Starting, Stopping, and Restarting API Data Store on LINUX
Changing the API Data Store HTTP Port
Changing the API Data Store HTTP Port using Template
Changing the API Data Store TCP Port
Configuring an API Data Store Cluster
Configuring Data Store Cluster using Template
Configuring Custom API Data Store Properties
Configuring Elasticsearch Properties
Configuring Elasticsearch Properties using Template
Monitoring API Data Store
Manage API Gateway Product Configurations in Command Central
Configuring Properties
Configuring Keystores
Configuring Keystores using Template
Configuring Licenses
Configuring Loggers
Configuring HTTP Port
Configuring HTTPS Port
Configuring HTTPS Port using Template
Configuring Truststores
Configuring Truststores using Template
Manage Inter-component and Cluster configurations
Configuring Elasticsearch Connection Settings
Configuring External Elasticsearch using Template
Configuring Kibana Connection Settings
Configuring Kibana using Template
Configuring API Gateway Cluster
Configuring Cluster using Template
Command Line to Manage API Data Store
Commands that API Data Store Supports
Configuration Types that API Data Store Supports
Run-Time Monitoring Statuses for API Data Store
Lifecycle Actions for API Data Store
Troubleshooting Tips: API Gateway Configuration with Command Central
Using API Gateway
webMethods API Gateway
Introduction to webMethods API Gateway
Searching Data in API Gateway
Configuring the Number of APIs listed on a Page
Using Help in API Gateway
User Management
Manage Users, Groups, and Teams
Adding a User
Modifying User Details
Deleting a User
User Groups
Adding a Group
Modifying a Group
Deleting a Group
API Gateway Functional Privileges
Setting Password Restrictions
Setting Password Expiry Restrictions
Configuring Account Locking Settings
Unlocking User Accounts
Restricting User Accounts
Configuring API Gateway to Use LDAP
Managing LDAP Directories
Manage Your User Settings and Preferences
Changing Your Account Settings
Changing Your Password
Changing Your Display Language
Viewing Your Roles and Permissions
APIs
Creating APIs - Overview
Creating an API by Importing an API from a File
Creating an API by Importing an API from a URL
Creating an API from Scratch
Overview of Creating a REST API from Scratch
Creating a REST API
Creating a WebSocket API
API Mashups
Creating an API Mashup
Viewing API List and API Details
REST API Details
SOAP API Details
OData API Details
GraphQL API Details
Filtering APIs
Activating an API
Deactivating an API
Publishing APIs
Publishing APIs to API Portal
Publishing a Single API to API Portal
Publishing Multiple APIs to API Portal in a Single Operation
Publishing APIs to Service Registries
Publishing a Single API to Service Registries
Publishing Multiple APIs to Service Registries in a Single Operation
Unpublishing APIs
Unpublishing APIs from API Portal
Unpublishing a Single API from API Portal
Unpublishing Multiple APIs from API Portal in a Single Operation
Unpublishing APIs from a Service Registry
Unpublishing a Single API from Service Registries
Unpublishing Multiple APIs from Service Registries in a Single Operation
Modifying API Details
Updating APIs
Updating an API by Importing an API from a File
Updating an API by Importing an API from a URL
API Mocking
Enabling API Mocking
Modifying API Mocking Details
Custom Replacer
Attaching Documents to an API
SOAP to REST Transformation
Activating SOAP to Rest Transformation
Modifying the REST Definitions for SOAP Operations
Supported Content-types and Accept Headers
REST API Endpoints
Samples for REST Request
Limitations
CentraSite Provided APIs
Versioning APIs
Creating New API Version
API Scopes
Creating an API Scope
Viewing List of API Scopes and Scope Details
Modifying API Scope Details
Deleting an API Scope
Example: Usage Scenarios of API Scopes
Exposing a REST API to Applications
Exposing a SOAP API and GraphQL API to Applications
API Grouping
API Tagging
Adding Tags to an API
Exporting APIs
Exporting Specifications
Deleting APIs
Deleting a Single API
Deleting Multiple APIs in a Single Operation
Example: Managing an API
Troubleshooting Tips: APIs
Policies
Policies - Overview
Policy Validation and Dependencies
Managing Threat Protection Policies
Configuring Global Denial of Service Policy
Configuring Denial of Service by IP Policy
Managing Denied IP List
Configuring Rules
Registering a Mobile Device or Application
Configuring Alert Settings
System-defined Stages and Policies
Variable Framework
Transport
Enable HTTP/HTTPS
Enable JMS/AMQP
Configuring API Gateway for JMS with AMQP Protocol
Using Enable JMS/AMQP for a SOAP API
Using Enable JMS/AMQP for a REST API
Set Media Type
Identify and Access
Inbound Auth - Message
Authorize User
Identify & Authorize
Request Processing
Invoke webMethods IS
Request Transformation
Validate API Specification
Data Masking
Routing
Content-based Routing
Conditional Routing
Dynamic Routing
Load Balancer Routing
Straight Through Routing
Custom HTTP Header
Outbound Auth - Transport
Outbound Auth - Message
JMS/AMQP Policies
JMS/AMQP SOAP Routing
JMS/AMQP REST Routing
JMS/AMQP Properties
Traffic Monitoring
Log Invocation
Uncompressing a payload
Monitor Performance
Monitor SLA
Traffic Optimization
Service Result Cache
Response Processing
Invoke webMethods IS
Response Transformation
Validate API Specification
CORS
Data Masking
Error Handling
Conditional Error Processing
Data Masking
System Context Variables
The API for Context Variables
Managing Global Policies
Creating a Global Policy
Modifying the Scope of a Global Policy
Refining the Scope of a Global Policy
Associating Policies to a Global Policy
Configuring Properties for a Global Policy
Viewing List of Global Policies and Policy Details
Modifying Global Policy Details
Activating a Global Policy
Deactivating a Global Policy
Deleting a Global Policy
Copying a Global Policy
Exporting Global Policies
Managing API-level Policies
Assigning a Policy to an API
Viewing API Policy Details
Modifying API Policy Details
Managing Scope-level Policies
Creating a Scope-level Policy
Viewing List of Scope-level Policies and Policy Details
Modifying Scope-level Policy Details
Deleting a Scope-level Policy
Managing Policy Templates
Creating a Policy Template
Associating Policies with a Policy Template
Configuring Properties for a Policy Template
Viewing List of Policy Templates and Template Details
Modifying Policy Template Details
Deleting a Policy Template
Copying a Policy Template
Applying a Policy Template on the API Details Page
Modifying a Policy Template on the API Details Page
Saving Policy Definition of an API as Policy Template
Supported Alias and Policy Combinations
Aliases
Overview
Creating a Simple Alias
Creating an Endpoint Alias
Creating an HTTP Transport Security Alias
Creating a SOAP Message Security Alias
Creating a webMethods Integration Server Service Alias
Creating an XSLT Transformation Alias
Applications
Overview
Creating an Application
Viewing List of Applications and Subscriptions
Regenerating API Access Key
Modifying Application Details
Registering an API with Consumer Applications from API Details Page
Suspending an Application
Activating a Suspended Application
API Packages and Plans
Overview
Creating a Package
Creating a Plan
Activating a Package
Publishing a Package
Viewing List of Packages and Package Details
Viewing List of Plans and Plan Details
Viewing a List of Subscriptions
Modifying a Package
Deleting a Package
Modifying a Plan
Deleting a Plan
Export and Import Assets and Configurations
Overview
Importing Asset and Configuration Archives
Troubleshooting Tips: Import and Export Assets
API Gateway Analytics
Analytics Dashboards
API Gateway Dashboard
API-specific Dashboard
Creating custom dashboards
Runtime Events and Metrics Data Model
API Gateway
API Portal
Audit Log
CentraSite
Elasticsearch
Email
JDBC
Local Log
Microgateway Management
Overview
Microgateway Groups
Microgateway Group Analytics
Microgateway Details
Deleting Microgateway Instances
Deleting a Microgateway
Deleting Multiple Microgateways
REST APIs in API Gateway
API Gateway Administration
Alias Management
Application Management
API Gateway Archive
API Gateway Availability
Document Management
Data Center Management
Internal Service
Port Configuration
Policy Management
Promotion Management
Public Services
API Gateway Search
Server Information
Service Management
Transaction Data
User Management
Subscription Management
Backward compatibility support for REST APIs
Remove User Data from API Gateway
Removing User Data
Usage Scenarios
Change Ownership of Assets
How Do I Change the Ownership of an Application?
How Do I Change the Ownership of an API?
How Do I Change the Ownership of Multiple Assets?
How Do I Configure the Approval Process for Ownership Change of Assets?
Custom Policy Extension
How Do I Invoke an API through HTTP or HTTPS using Custom Extension?
How Do I Invoke an IS Service using a Custom Extension?
How Do I Invoke an AWS Lambda Function using Custom Extension?
How Do I Invoke an API Asynchronously through JMS/AMQP using a Custom Extension?
How Do I Define a Custom Variable?
Custom Extension Properties
Data Objects and Variables Available in API Gateway
Team Support
Creating Teams
How do I Assign Teams during Asset Creation?
How do I Assign Teams Using Team Assignment Rule?
How do I Modify Teams Assigned to an API?
How do I Change the Ownership of Multiple Teams?
Enabling Teams Support
Team Support Considerations
API Gateway Functional Privileges
API First Implementation
API First Implementation using Integration Server
Configuring Integration Server Instance for API Implementation
API First Implementation using a Third-party Server
List of Parameters used in API Implementation
Gateway Endpoints
How do I Define API-specific Gateway Endpoints?
How do I Define Global Gateway Endpoint?
How do I Edit Global Gateway Endpoint?
How do I Delete Global Gateway Endpoint?
Other Gateway Endpoint Usecases
Secure API using OAuth2 with refresh token workflow
Configuring OAuth2 Authentication with Refresh Token
Refresh Token Process Flow
How to get the access token with resource owner permission?
How to get the access token without resource owner permission using refresh token in the subsequent attempts?
Request and Response Processing
Request and Response Transformation Policies
How do I transform a request using Request Transformation Policy?
Request Transformation Policy Properties
How do I transform a request and its response using Transformation Policy?
Response Transformation Policy Properties
Invoke webMethods IS Policy
How do I transform a request using Invoke webMethods IS policy?
Invoke webMethods IS Policy Properties for Request Processing
How do I transform a response using Invoke webMethods IS policy?
Invoke webMethods IS Policy Properties for Response Processing
Securing Access Token Calls with PKCE
How do I enforce PKCE globally?
How do I enforce PKCE at application level?
How do I secure the access token by directly calling API Gateway's REST APIs?
How do I test the access token with Authorization Code (With PKCE) grant type using postman?
How do I enforce PKCE selectively for each access token call?
How do I generate code verifier and code challenge using JAR files?
Trace API
How do I enable tracing?
How do I filter the runtime request?
How do I view the trace details?
How do I inspect failed runtime requests using tracer?
How do I import runtime requests?
How do I export or download runtime requests?
How do I archive or purge the tracer details?
How do I archive and purge the tracer details using REST API Calls?
AppMesh Support in API Gateway
Overview of webMethods AppMesh
Configure API Gateway to Connect to a Service Mesh Environment
Creating a Microgateway Image
AppMesh Deployment
Service Discovery
APIfy
Update API Definition and Policies
Deploy AppMesh
Undeploy AppMesh
Provisioning of API and Policy Updates
Accessibility Profile
Overview
Staging and Promotion in API Gateway
Stages
Stages, Promotions, and Rollbacks
Manage Stages
Adding a Stage
Viewing Stage List and Stage Details
Modifying Stage Details
Deleting a Stage
Promotion
Manage Promotions
Promoting Assets from API Gateway User Interface
Viewing Promotion List and Promotion Details
Repromoting Assets
Promoting Assets Using Deployer
Promoting Assets Using Promotion Management API
Rollbacks
Manage Rollbacks
Viewing Rollback List and Rollback Details
Upgrade and Migration in API Gateway
Upgrading API Gateway
Introduction
Upgrading standalone API Gateway
Upgrading API Gateway cluster
Upgrade configurations
Upgrade recovery
Troubleshooting Tips
Upgrading API Gateway in Zero Downtime
Introduction
API Gateway Quiesce Mode
Migration REST API
Webhook Notifications
Shutdown REST API
Upgrading Major Versions in Zero Downtime
Start the new API Gateway instance
Clean the data in the new API Data Store
Put the old API Gateway instances in quiesce mode for design time
Migrate the design time data
Transform the design time data
Restart new API Gateway instances
Add traffic to the new API Gateway instance
Put the old API Gateway instances into quiesce mode for all
Migrate the analytics data
Shutdown the old API Gateway instance
Upgrading Minor Versions in Zero Downtime
Upgrade Standalone Deployment
Upgrade Cluster Deployment
Quiesce Mode
Upgrading API Gateway with external Elasticsearch and Kibana
Migrating from Mediator to API Gateway
Administering CentraSite
Configuring CentraSite
Overview
Enabling JavaScript in Web Browser
Starting and Stopping the Application Server Tier and Registry Repository
Administering the License Key
Changing the License Key
Working with Time-limited Licenses
Configuring Application Server Tier
Changing the Default Java Location for CentraSite
Configuring Java Service Wrapper
Configuring a Proxy
Printing on UNIX and Linux Systems
Maintaining the CentraSite Internal Database
Repository Monitoring
Displaying the Database Activity
Displaying the Database Space
Displaying Backup List
Backing Up the Database
Restoring the Database from a Backup
Deleting a Backup
Moving a Database to Another Location
Configuring CentraSite Database Locations
Database Configuration Parameters
Reclaiming Disk Space in CentraSite Database
Setting Up Replication Instances of Registry Repository
Configuring High Availability
Configuring Port Numbers
Changing Port Numbers of CentraSite Registry Repository
Changing Port Number on CentraSite Registry Repository
Changing Software AG Runtime Port Numbers
Configuring Secure Communication Between Components
Securing Communication Between the CRR and the CAST
Obtaining Security Configuration of CentraSite Registry Repository
Setting Security Configuration for CentraSite Registry Repository
Obtaining Security Configuration of CentraSite Application Server Tier
Setting Security Configuration for CentraSite Application Server Tier Components
CAST Stores
Identifying the Communication Method Between CAST and CRR
Allowing HTTP Communication Between CAST and CRR
Securing Communication Between Software AG Runtime and External Clients
Securing Communications with CentraSite for Synchronous Deployment
Configuring CentraSite to Use SSL
Configuring CentraSite Client to Use One-way SSL
Configuring CentraSite Client to Use Two-way SSL
Configuring CentraSite Client for SSL Using CTP Server.xml File
Configuring webMethods Integration Server to Use SSL
Configuring Integration Server to Use One-way SSL
Configuring Integration Server to Use Two-way SSL
Configuring Registry Cache Settings
Displaying Registry Cache Configuration
Modifying Registry Cache Configuration
Configuring User Authentication and Repositories
User Authentication Configurations
Creating and Maintaining Authentication Configurations
Specifying Domain Name
Mapping User and Group Fields
File Structure of Login Authentication Configuration
Configuring Internal Authentication Type
Configuring LDAP Authentication Type
Configuring LDAP Authentication
LDAP Authentication Configuration Parameters
Logging of Login Authentication Messages
Transforming and Migrating Internal and LDAP Configuration Data
Creating Technical User for Reconfiguring Migrated Configuration
Securing Login Information of Technical User
Configuring Email Server
Configuring Email Server Settings
Fetching Email Server Settings
Implementing CentraSite
Configuration Checklist
Choosing a Deployment Strategy
Implementing the Mediation Environment
Docker Configuration
Building the Docker Image for a CentraSite Instance
Starting the CentraSite Docker Containers
Running the CentraSite Docker Containers
Managing CentraSite Docker Containers
Administration of CentraSite Docker Containers
Creating internal users for CentraSite Docker Images
Reuse persistent Docker Container
Shutting down the CentraSite Docker containers
CentraSite License for Docker Image
Using a new image containing the new license file
Using volume mapping
Managing Logs
Overview
Configuring Logs
Configuring Log Settings
Creating Log Setting Configuration File
Obtaining Log Configuration Settings
Monitoring Logs
Audit Logs for User Information
Starting the Audit Logs
Storing the Audit Log Data
Stopping the Audit Logs
Checking Current State of Audit Log
Switching the Audit Log Store
Recording the Audit Log
Purging Logs
Creating Log Purging Configuration File
Purging Logs
Deleting Deployment History
Exporting the Purged Log Records
Configuring Purger Properties for High Volume Data Handling
Removing Leftover Auditable Events
Administering CentraSite with Command Central
Overview
Viewing CentraSite Components
Changing the Authentication Mode
Changing the Administrator User Password for Managed Products
Verifying the Outbound Authentication Settings
Commands that CentraSite Application Server Tier Supports
Commands that CentraSite Registry Repository Supports
Lifecycle Actions for CentraSite Registry Repository
Run-time Monitoring Statuses for CentraSite Registry Repository
CentraSite Command Line Tools
Introduction to CentraSite Command Line Tools
INOADMIN Command Line Tools
CentraSiteCommand Line Tools
CentraSite Toolbox Command Line Tools
Configuring CentraSiteCommand to Use SSL
Using CentraSite
Introduction
CentraSite's Role in Today's SOA
Use of CentraSite by Other Products
Topology and Architecture
CentraSite Features
CentraSite Interfaces
Graphical User Interfaces to CentraSite
Application Program Interfaces to CentraSite
Starting the Graphical User Interface
Logging On to CentraSite
Using the CentraSite Business User Interface
Logging on to CentraSite Business UI as Registered User
Logging on to CentraSite Business UI as Guest User
Taking a Tour
Creating a New Account in CentraSite
Logging off from CentraSite Business UI
Navigation Controls in CentraSite Business UI
Enhanced Profile Layout For Registry Objects
Configuring the Enhanced Profile Layout
User Profile Management
Viewing Your User Profile
Modifying Your User Profile Details
Changing Your Profile Picture
User Preferences Management
Managing User Preferences through CentraSite Business UI
Setting Notification Options
Setting Language and Timestamp
Viewing API Keys and OAuth2 Tokens
Renewing API Keys
Revoking API Keys and OAuth2 Tokens
Viewing Saved Searches
Adding a Search to Saved Searches List
Modifying a Search in Saved Searches
Renaming a Search in Saved Searches List
Removing a Search from Saved Searches List
Viewing My Favorites
Adding Assets to My Favorites List
Removing Assets from the My Favorites List
Renaming a Favorites List
Deleting a Favorites List
Viewing Portlets
Renaming a Portlet
Removing a Portlet
Managing User Preferences through Command Line Interface
Modifying User Preference Settings
Displaying User Preference Settings
Resetting User Preference Settings
Inbox Management
Accessing Your Inbox
Creating a Notification Request
Viewing Notification Requests
Deleting a Notification Request
Removing Notification Requests from Inbox
Using Refiners in Your Inbox
Using the Help Center
Accessing CentraSite's Help Center
Organization Management
Introduction to Organizations
Managing Organizations through CentraSite Business UI
Adding Organization
Viewing the Organization List
Modifying Organization Details
Deleting Organizations
Adding Child Organization
Modifying Child Organization's Details
Deleting Child Organizations
Deleting Organizations through Command Line Interface
User Management
Introduction to Users
Managing Users through CentraSite Business UI
Adding User to an Organization
Viewing the User List
Viewing User Details
Modifying User Details
Adding User to a Group Through User Details Page
Deleting User from a Group Through User Details Page
Viewing Assets Owned by a User
Synchronizing LDAP Users
Deleting Users
Activating or Deactivating Users
Managing Users through Command Line Interface
Creating an Administration User
Changing Password of Predefined User
Changing Password of Login User in Password Store
Reassociating Users
Synchronizing LDAP Users
Deleting Users
Selecting Users or Groups from Repository
Group Management
Introduction to Groups
Managing Groups through CentraSite Business UI
Adding Group to an Organization
Viewing the Group List
Viewing Group Details
Modifying Group Details
Adding User to a Group Through Group Details Page
Deleting User from a Group Through Group Details Page
Deleting Groups
Managing Groups through Command Line Interface
Reassociating Groups
Synchronizing LDAP Groups
Selecting Users or Groups from Repository
Role Management
Introduction to Permissions and Roles
Managing Roles through CentraSite Business UI
Adding Role to an Organization
Viewing the Role List
Viewing Role Details
Modifying Role Details
Assigning Permissions to Role
Removing Permission from Role
Assigning Role to a User or Group
Deleting Role Assignments from a User or Group
Deleting Role from Set of Roles Assigned to User or Group
Removing User or Group from Set of Users and Groups Assigned to a Role
Deleting Roles
Type Management
Introduction to Types
Basic Components of Type
Classification of Types
Composite Asset Types
Definition of Composite Asset Types
Semantics of Relationships and Operations
Extended Rules
Usage Scenarios
Predefined Composite Asset Types
Managing Types through CentraSite Business UI
Adding an Asset Type
Adding Attribute to an Asset Type
Adding Profile to an Asset Type
Viewing the Asset Type List
Modifying Asset Type Details
Modifying Profile Attribute List of an Asset Type
Modifying Consuming Types of an Asset Type
Deleting Asset Types
Managing Types through Command Line Interface
Removing Attribute from Asset Type Definition
Checking Sequence Order for Asset Profiles
Cloning an Asset Type
Creating a Virtual Asset Type
Deleting a Virtual Asset Type
Changing an Asset's Type
Taxonomy Management
Introduction to Taxonomies
Managing Taxonomies through CentraSite Business UI
Adding Taxonomy
Viewing the Taxonomy List
Viewing List of Assets Classified by Taxonomies from the Search Results Page
Viewing Taxonomy Details
Modifying Taxonomy Details
Deleting Taxonomies
Lifecycle Management
Introduction to Lifecycle Management
Lifecycle Model for Lifecycle Models (LCM for LCMs)
Predefined Lifecycle Models
Customizing Lifecycle Models
Updating Assets that are Under Lifecycle Management
Reverting an Asset That is Under Lifecycle Management to a Previous State
Managing Lifecycle Models through CentraSite Business UI
Adding Lifecycle Model to Organization
Adding Lifecyle Stage
Adding State to Lifecycle Model
Viewing the Lifecycle Model List and Details
Viewing the Lifecycle Stage List
Modifying Lifecycle Model Details
Modifying Lifecycle Stage Details
Defining Stage Transitions for Lifecycle Model
Associating Asset Types with Lifecycle Model
Viewing Policies Associated with Lifecycle Model
Setting Permissions on Lifecycle State
Activating Lifecycle Model
Versioning Lifecycle Model
Deleting State and State Transitions from Lifecycle Model
Deleting Lifecycle Models
Deleting Lifecycle Stages
Purging Versions of a Lifecycle Model
Asset Management
Introduction to Asset Catalog
Customizing Your Asset Catalog
Executable Design/Change-Time Actions on Your Asset Catalog
Managing Assets through CentraSite Business UI
Searching and Browsing the Asset Catalog
Searching the Asset Catalog
Type-ahead Search
Advanced Search
Searching the Catalog by Keyword
Searching the Catalog by Taxonomy
Searching the Catalog by Lifecycle Model
Searching the Catalog by Asset Type
Searching the Catalog by Attribute Value
Combining Search Filters
Searching the Asset Catalog
Managing the Search Recipe
Adding Search Filter to Search Recipe
Rendering of Search Scopes in Search Recipe
Removing Search Filter from Search Recipe
Saving and Re-Executing Saved Searches
Saving a Search Definition
Re-executing a Saved Search
Creating a New Search from a Saved Search
Managing the Search Results page
Viewing the Search Results Page
Configuring the Search Results Page
Change the Number of Results that Appear on Search Results page
Change the Number of Characters in Attribute Display Name
Browsing the Asset Catalog
Web Service Management
Adding Web Service from Scratch
Adding Web Service using an Archive
Viewing Web Service List
Viewing Web Service Details
Modifying Web Service Details
Deleting Web Services
Revoking Access Tokens as API Consumer
Revoking Access Tokens as API Consumer
REST Service Management
About REST Service Assets
REST Service Compatibility
Adding REST Service using Importer
Importing REST Service using a RAML File
Importing REST Service using a Swagger 2.0 File
Importing REST Service using an OpenAPI File
Adding REST Service using an Archive File
Adding REST Service from Scratch
Adding Endpoints to REST Service
Adding Components to REST Service
Adding Resource to REST Service
Adding HTTP Method to REST Service
Adding Parameter to REST Service
Adding Components Objects to Resources and Methods
Adding HTTP Request to REST Service
Adding HTTP Response to REST Service
Adding Status Code to REST Service
Viewing REST Service List
Viewing REST Service Details
Modifying REST Service Details
Modifying Basic Details of REST Service
Modifying Components of REST Service
Modifying Extended Details of REST Service
Generating Swagger 2.0 and Open API-Compliant File for a REST Service
Deleting REST Services
OData Service Management
About OData Service Assets
Adding OData Service using Importer
Adding OData Service using an EDMX File
Adding OData Service using an Archive
Viewing OData Service List
Viewing OData Service Details
Modifying OData Service Details
Deleting OData Services
Application Management
Adding an Application Asset to the Catalog
Viewing Application Asset List
Viewing Application Asset Details
Modifying Application Assets
Defining Consumer Identifiers for Application Asset
Deleting Application Assets
General Procedures across Assets
Attaching Supporting Documents to Asset
Attaching Asset Definition Files
Attaching Documents Using URL
Attaching Documents from Computer's File System
Attaching Documents from Supporting Document Library
Removing Supporting Documents from Asset
Changing Lifecycle State of Asset
Setting Permissions on Asset
Restricting Access to Summary Profile
Setting Instance Level Permissions on Asset
Setting Instance Level Profile Permissions on Asset
Propagation of Permissions
Selecting Users or Groups Using Search Option
Selecting Users or Groups Using Browse Option
Publishing and Unpublishing Services to and from API Portal through API Gateway
Publishing Service Assets to API Portal
Unpublishing Service Assets from API Portal
Legacy Portal Publish
Versioning an Asset
Creating New Version of Asset
Locating Other Versions of Asset
Considerations for Asset Types of the Suite
Changing Ownership of Asset
Changing User Ownership of Asset
Changing Organization Ownership of Asset
Watching and Unwatching Asset
Watching Asset
Unwatching Asset
Viewing List of Watchers for Asset
Downloading Asset
Performing Zip Download
Downloading a Single Document from Supporting Document Library
Downloading WSDL or XSD Document from Service or XML Schema Asset
Downloading XSD document from REST or XML Service Asset
Exporting and Importing Assets
Exporting Asset
Importing Asset
Viewing Logs
Viewing Audit Log
Viewing Policy Log
Viewing Deployment History
Viewing Approval Logs
Managing Assets through Command Line Interface
Importing an Asset
Importing Web Service
Importing REST Service
Importing OData Service
Importing XML Schema
Importing BPEL Process
Importing XPDL File
Importing Archive
Bulk Importing Assets
Deleting an Asset
Deleting Assets
RAML to CentraSite REST API Mappings
Swagger to CentraSite REST API Mappings
Open API to CentraSite REST API Mappings
Asset Navigator
Asset Navigator in CentraSite Business UI
Introduction to Asset Navigator
Graphical Visualization
Navigating to Asset Navigator Through the Activity Bar
Navigating to Asset Navigator Through the Actions Bar
Types of Charts
TreeChart Chart
SunBurst Chart
Icicle Chart
Configuration Settings
Adding Custom Use Cases
Policy Management
Introduction to Design and Change-Time Policies
Execution of Design/Change-Time Policy
Design/Change-Time Policies Usage
Issues to Consider When Creating Design/Change-Time Policies
Managing Design Time Policies through CentraSite Business UI
Creating a Design Time Policy
Activating a Design Time Policy
Deactivating a Design Time Policy
Viewing Design Time Policy List
Viewing or Modifying a Design Time Policy
Scope of a Design Time Policy
System-wide and Organization-specific Policy Enforcement
Modifying Scope of a Design Time Policy
Refining the Object Scope
Configuration of Policies that Execute on Lifecycle State Changes
Assigning Actions to a Design Time Policy
Policy Scope and Action Scope
Modifying the Action List
Configuring Policy Action Parameters
Setting Permissions through Design Time Policy Details
Setting Permissions through Design Time Policy
Performing a Run Now Action
Deleting Design Time Policies
Versioning a Design Time Policy
System-Assigned and User-Assigned Version Identifiers
Managing Design-Time and Change-Time Policies through Command Line Interface
Viewing the Action Categories List
Adding Custom Action Category
Modifying Action Category Details
Deleting Action Category
Viewing the Action Templates List
Adding Custom Action Template
Modifying Action Template Details
Deleting Action Template
Downloading Action Template Implementation File
Fetching Action Template Configuration File
Modifying Policy Action Implementation
Purging Orphaned Policy Parameters
Setting Up an Eclipse Java Project for Action Implementation
Predefined Policies
The Collector and Handler Policies Provided with CentraSite
The Default Collector
The Default Delete Handler
The Default Move Handler
The Default Export Handler
Built-In Design/Change-Time Actions Reference
Summary of Actions in the ARIS Category
Summary of Actions in the Change-Time Category
Summary of Actions in the Collector Category
Summary of Actions in the Design-Time Category
Summary of Actions in the Global Category
Summary of Actions in the Handler Category
Summary of Actions in the WS-I Category
Attach Business UI Profiles for Asset Type
Call Web Service
Change Activation State
Change Deployment Status
Change Owner
Classify
Consumer WSDL Generator
Create Auditable Events
Default API Portal Permissions
Default Permission Handler
Delete RuntimeEvents and RuntimeMetrics
Enforce Unique Name
Generate API Specification
Insight Deployment
Insight Undeployment
Initiate Approval
Initiate Group-Dependent Approval
Mark Pending on Runtime Policy Change
Notify ARIS Service
Notify Consumers
On Consumer Registration Request Send Email to Owner
Processing Steps Status
Promote Asset
Publish to API Portal
Register Consumer
Restrict API Portal Creation
Restrict Shared Composite Asset
Send Email Notification
Send Email Notification to Watchers
Set Attribute Value
Set Business UI Profile Permissions
Set Consumer Permission
Set Instance and Profile Permissions
Set Permission for Asset's Objects
Set Permissions
Set Profile Permissions
Set State
Set View Permission for Service and Service Related Object to Everyone Group
UnClassify
Unpublish from API Portal
Validate Attribute Value
Validate Classification
Validate Description
Validate Lifecycle Model Activation
Validate Name
Validate Namespace
Validate Policy Activation
Validate Policy Deactivation
Validate Service Binding
Validate State
Validate WSDL Size
Verify Required Attributes
webMethods REST Publish
Configuring Email Notifications
Setting the Email-Related Parameters in an Email Notification Action
Using Custom Messages in an Email Notification Action
Using Email Templates with Policy Actions
Managing Email Templates through Command Line
Creating a Custom Email Template
Adding a Custom Email Template
Viewing the Email Templates List
Downloading Email Template
Deleting an Email Template
Managing Email Templates through Java Class
Script File for EmailTemplateManager Utility
Adding a Custom Email Template
Viewing the Email Templates List
Downloading an Email Template
Deleting an Email Template
Report Management
Introduction to Reports
Predefined Reports
Configuring JDBC Support for BIRT Reports
Reserved Identifiers
Managing Reports and Report Templates through CentraSite Business UI
Viewing the Report Template List
Setting Permissions on Report Templates
Generating Reports Through Activity Bar
Generate Report from the Asset Details Page
Downloading Reports
Scheduling Reports
Displaying a List of Scheduled Reports
Modifying Scheduled Report Details
Deleting Scheduled Reports
Changing the Default Scheduler for Generating Reports
Managing Reports and Report Templates through Command Line Interface
Viewing the Reports List
Adding Custom Report
Modifying Report Details
Deleting Report
Sharing Report with API Portal
Downloading Report Template
Viewing the Scheduled Reports List
Adding Custom Scheduled Report
Modifying Scheduled Report Details
Triggering Scheduled Report
Deleting Scheduled Report
Viewing the Asset Types Associated to Report
Associating Asset Type to Report
Revoking Association Between Asset Type and Report
Portlet Management
Introduction to Portlets
Types of Portlets
Tailor Your Portlets
Adding a Portlet to Your Welcome Page
Adding an Existing Portlet
Creating a Text Portlet
Creating an iFrame Portlet
Creating a Graphical Portlet
Viewing Your Portlets
Configuring a Portlet
Personalize Your Portlets
Refresh Intervals for Portlets
Collapsing or Expanding Portlets
Rearranging Portlets
Removing Portlets
Built-in Design/Change-Time Portlets
Built-in Run-Time Portlets
Runtime Governance
Introduction to Runtime Governance
The Components of Runtime Governance
Runtime Governance Deployment Architecture
Enabling CentraSite Run-Time Aspects
Disabling CentraSite Run-Time Aspects
Runtime Governance with Mediator
Mediator Deployment Model
Deployment using CentraSite Business UI
Deployment using CentraSite Control
Runtime Governance with API Gateway
API Gateway Deployment Model
Enabling API Editing in API Gateway
Virtual Service Asset Management
Managing Virtual Service Assets through CentraSite Business UI
Virtual Service Management
Adding Virtual Service to Your Asset Catalog
Adding Virtual Service using an Existing Native Service
Create Virtual Service
Assign Policy Actions for Virtual Service
Virtualize and Publish Virtual Service to Gateways
Adding Virtual Service using an Archive
Adding Virtual Service from Scratch
Viewing Virtual Service List
Viewing and Modifying Virtual Service Details
Deleting Virtual Services
Exposing a Virtual Service as Virtual REST Service
Virtual REST Service Management
Virtual REST Service Compatibility
Adding Virtual REST Service to Your Asset Catalog
Adding Virtual REST Service using an Existing Native REST Service
Create Virtual REST Service
Assign Policy Actions for Virtual REST Service
Virtualize and Publish Virtual REST Service to Gateways
Adding Virtual REST Service using an Archive
Adding Virtual REST Service from Scratch
Viewing Virtual REST Service List
Viewing and Modifying Virtual REST Service Details
Viewing and Modifying Basic Details of Virtual REST Service
Viewing and Modifying Extended Details of Virtual REST Service
Deleting Virtual REST Services
Resource Synchronization in Virtual REST Services
Virtual OData Service Management
Adding Virtual OData Service to Your Asset Catalog
Adding Virtual OData Service using an Existing Native OData Service
Create Virtual OData Service
Assign Policy Actions for Virtual OData Service
Virtualize and Publish Virtual OData Service to Gateways
Adding Virtual OData Service using an Archive
Viewing Virtual OData Service List
Viewing and Modifying Virtual OData Service Details
Deleting Virtual OData Services
General Procedures across Assets
Configuring API Consumption Settings for Client Authentication
Configuring Key-Based Authentication
Configuring OAuth-Based Authentication
Assigning Run-Time Actions to a Virtual Service
Modify Policy Action List
Configure Policy Action Parameters
Reconfiguring Virtual Services
Publishing and Unpublishing Services to and from Runtime Gateways
Publishing Services to Gateways
Unpublishing Services from Gateways
REST Service Deployment and Redeployment of REST services in CentraSite
Promoting Virtual Service
Managing Virtual Service Assets through the Command Line Interface
Deploying a Virtual Service to Gateway
Undeploying a Virtual Service from Gateway
Bulk Deploying Virtual Services to Gateway
Bulk Undeploying Virtual Services from Gateway
Bulk Redeploying Virtual Services to Gateway
Important Considerations when Configuring Virtual Services
Workaround Option 1
Workaround Option 2
Important Considerations when Configuring Virtual REST Services
webMethods IS Services in Virtual Services
Context Variables in Virtual Services
The Predefined Context Variables
The API for Context Variables
Run-Time Policy Management
Actions that Run-Time Policies Can Execute
Supported Run-Time Actions and Asset Type Combinations
Managing Run-Time Policies through CentraSite Business UI
Creating a Run-Time Policy
Activating a Run-Time Policy
Deactivating a Run-Time Policy
Viewing Run-Time Policy List
Modifying Run-Time Policy Details
Scope of a Run-Time Policy
System-wide and Organization-specific Policy Enforcement
Modifying Scope of a Run-Time Policy
Refining the Policy Scope
Assigning Actions to a Run-Time Policy
Modifying Policy Action List
Configuring Policy Action Parameters
Viewing the List of Virtual Services to Which a Run-Time Policy Applies
Deleting Run-Time Policies
Built-In Run-Time Actions Reference (CentraSite Business UI)
Summary of Actions in the Request Handling Category
Summary of Actions in the Policy Enforcement Category
Summary of Actions in the Validation Category
Summary of Actions in the Outbound Authentication Category
Summary of Actions in the Response Handling Category
Summary of Actions in the Error Handling Category
Effective Policies
Usage Cases for Identifying or Authenticating Consumers
Built-in Actions for Run-Time Policies (CentraSite Business UI)
Allow Anonymous Usage
Content Based Routing
Context Based Routing
Conditional Error Processing
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
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 SAML Audience URIs
Validate Schema
Asymmetric Binding Configuration
Obtaining Details of Asymmetric Binding
Modifying Details of Asymmetric Binding
Removing Asymmetric Binding
Gateway Management
Managing Gateways through CentraSite Business UI
Creating API Gateway Asset
Creating API Portal Gateway Asset
Creating Mediator or Insight Server Gateway Asset
Viewing the Gateway List and Gateway Details
Modifying Gateway Asset Details
Setting Instance-Level Permissions on Gateway Asset
Unregistering Gateways from CentraSite
Deleting Gateways
Managing Gateways through Command Line Interface
Viewing the Gateways List
Adding a Custom Gateway
Configuration File
Deleting Gateway
Publishing APIs to Gateways
Unpublishing APIs from Gateways
Consumer Management
Consumer Registration
The Design/Change-Time Policy Used for Consumer Registration
Creating Consumer Registration Policy
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
Modifying Consumer Details
Unregistering Existing Consumer
Synchronization of Gateway Application from API Gateway to CentraSite
Viewing Gateway Application Details
Searching Gateway Application
Deleting Gateway Application
Synchronizing Consumer Applications through CentraSite Business UI
Managing Consumers through Command Line Interface
Fetching Details of Migrated Pending Consumer Registrations
Purging Consumer Registration Requests
Synchronizing Consumer Applications
Assigning Consumer Association with a Virtual Service
Removing Consumer Association from a Virtual Service
Reassigning Consumer Association to a Virtual Service
Access Token Management
Managing Access Tokens through CentraSite Business UI
The API Consumption Model Using API Keys
The API Consumption Model Using OAuth 2.0 Tokens
Mediator Evaluating Consumers at Run-Time
Fetching and Using API Access Keys for Consumption
Fetching and Using OAuth 2.0 Client Tokens for Consumption
Viewing Access Token Details
Viewing Access Token Details Through Email Notifications
Viewing Access Token Details Through Service Details Page
Viewing Access Token Details Through User Preferences Page
Viewing Undelivered Access Tokens
Retry Mechanism for Guaranteed Access Token Delivery
Changing the Default Scheduler for Fetching Access Token Requests
Changing the Default Scheduler for Resending Undelivered Access Tokens
Renewing API Access Keys
Revoking Access Tokens as API Provider
Revoking Access Tokens as API Consumer
Deleting Access Tokens
Configuring Email Templates
Configuring Email Templates for Access Token Generation
Configuring Email Templates for Access Token Renewal
Configuring Email Templates for Access Token Revocation
Configuring Email Templates for Access Token Expiration
Managing Access Tokens through Command Line Interface
Fetching the Default Values for Retry Mechanism
Changing the Default Values for Retry Mechanism
Resending Undelivered Access Tokens
Purging Expired or Inactive Access Tokens
Restoring Expired Access Tokens
Run-Time Alias Management
Defining the Runtime Aliases
Referencing the Runtime Aliases in Virtual Services
Publishing a Virtual Service with Runtime Alias
Endpoint Management
Configuring the API Gateway Synchronization Settings
Runtime Events and Key Performance Indicator (KPI) Metrics
Runtime Event Types
The Key Performance Indicator (KPI) Metrics
The Event Notification Destinations
Destinations for Monitoring and Transaction Events
Managing Collection of Metrics
Managing Collection of Events
Using CentraSite with Other Policy Enforcement Points
The Metrics Tracking Interval
CentraSite Configuration to Receive Run-Time Events and Metrics
Configuring the Event Receiver
Event Type Modeling
The Target Type to Event Type Association Object
Event Modeling
Managing Runtime Events and Metrics through CentraSite Business UI
Displaying Event Information for Assets (APIs)
Displaying Performance Metrics for Assets (APIs)
Managing Runtime Event Store
Managing Runtime Event Store Through the Command Line Interface
Fetching State of Run-Time Event Store
Changing the Storage Mode of Run-Time Event
Purging the Run-Time Events
Managing Runtime Event Store Through Indexes and Aggregates
Viewing Runtime Logs
Viewing Runtime Events Log
Viewing Runtime Performance Log
Exporting and Importing Registry Objects
Introduction to Export and Import of Registry Objects
Exporting Registry Object
Importing Registry Object
Exporting and Importing Specific Object Types
Exporting and Importing Registry Objects through CentraSite Business UI
Exporting Objects through CentraSite Business UI
Importing Objects through CentraSite Business UI
Exporting and Importing Registry Objects through Command Line
Exporting Objects Through the Command Line
Importing Objects from an Archive Through the Command Line
Best Practices: Exporting and Importing Assets
Suite Usage Aspects
Introduction to Suite Usage Aspects
Versioning Assets
Modifying or Deleting Assets
Publishing Assets
CentraSite Communication with Designer UI
User Accounts
Using CentraSite with ARIS
CentraSite Profile for ARIS Properties
Configuring CentraSite for Use with ARIS
Lifecycle Models That ARIS Uses
Design/Change-Time Policies That ARIS Uses
Configuring and Activating Lifecycle Models and Design/Change-Time Policies That ARIS Uses
Configuring ARIS Change-Notification Policies
Configuring Enforce Unique Name Policy
Configuring Reset Lifecycle State to Initial State Policy
Activating Policies for ARIS through Command Line Interface
Provisioning CentraSite Services into ARIS Architect
Using CentraSite with webMethods API Portal
CentraSite Profiles for API Portal Properties
Configuring CentraSite for Use with API Portal
Configuring and Activating Design/Change-Time Policies That API Portal Uses
Configuring Publish to API Portal Policy
Configuring Unpublish from API Portal Policy
CentraSite and API Gateway Integration
CentraSite and API Gateway Integration
API Gateway Asset Mapping Details
Virtual Service Mapping Details
Alias Mapping Details
Runtime Policy Mapping Details
Consumer Application Mapping Details
Modifications to Error Codes and Responses for Runtime Policies
CentraSite for Developers
API for JAXR
Introduction to the CentraSite API for JAXR
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)
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
Unsupported Methods
Unsupported FindQualifiers
Using Wildcards
Using Namespaces
Method createSlot
Caching Considerations
Web Service Interfaces
Introduction to the Web Service Interfaces
Approval Service
Invoking Operations from the Approval Service
Retrieving the List of Approval Requests that a User Has Submitted
Approving or Rejecting Approval Requests
Scrolling Through the List of Returned Approval Requests
Reverting a Pending Approval Request
Approval Service Operations
Search Service Operations
Java Management Interface
Introduction to Java Management Interface
Attributes and Operations
Customizing CentraSite
Customization of CentraSite Business UI
CentraSite Business UI Configuration Files
Customizing CentraSite Login Page
CentraSite Login Page Configuration
Customizing CentraSite Welcome Page
CentraSite Welcome Page Configuration
Customizing CentraSite Content Page
Log on to CentraSite Business UI
Request an Account
Extending Activity Menu
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
Extending Action Menu
Implement Action as an Extension
Enable Action through Configuration
Sample Custom Actions
Adding Portlets
Implement Portlet as an Extension
Enable Portlet through Configuration
Computed Runtime Actions
Implement Runtime Action as an Extension
Enable Runtime Action through Configuration
Installing an Extension
Setting up GWT
Configuring an Extension
Uninstalling an Extension
Creating a Custom Extension
Installing CentraSite Business UI Extension
Deploying CentraSite Business UI Extension
Undeploying CentraSite Business UI Extension
Customizing Design Time Policies
Customization of CentraSite Control
Customizing the Welcome Page
Implementation of Welcome Page
Installing the Customized Welcome Page
Sample Customized Welcome Page
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
Implementation of Computed Attributes and Profiles
Implementing Computed Attributes
Implementing Computed Profiles for CentraSite Business UI
Implementing Computed Profiles for CentraSite Control
Customizing CentraSite i18n Messages
Fetching Message Key
Changing Message Value
Custom Policy Actions
Custom Policy Actions
Action Categories
Action Templates
Parameter Templates
Viewing Action Categories List
Creating Custom Actions Using the CentraSite UI
Adding an Action Template to a Custom Action Category
Adding Parameter Template to Action Template
Creating Action Rules in a Java Class
Uploading Action Rules to Action Templates
Viewing or Modifying an Action Category
Viewing or Modifying an Action Template
Downloading Rules from System Action Templates
Delete Custom Action Categories and Templates
Deleting a Parameter Template
Deleting a Custom Action Template
Deleting a Custom Action Category
Versioning a Custom Action Template
Sample Java Action: Enforce Unique Asset Names
Computed Run-Time Actions
Computed Run-Time Action Plug-in
Activating the Computed Run-Time Action
Sample Computed Run-Time Action
Custom Reporting Searches
Writing Your Own Reporting Search
Writing XQuery Module and Functions
Uploading XQuery Module through CentraSite Control
Uploading XQuery Module through Command Line
Writing Saved Search XML
Uploading Custom Reporting Search through Command Line
Activating Custom Reporting Search through CentraSite Business UI
Deleting Custom Reporting Search through Command Line
Displaying List of Reporting Searches
Obtaining Details of Reporting Search
Copying Reporting Search
Sample XQueries for Reporting Searches
XQueries for Retrieving Primary Objects
XQueries for Retrieving Embedded Objects
XQueries for Retrieving Classifications
XQueries for Retrieving Associations
Application Framework
Introduction to Application Framework
Configuring Application Framework
Mapping Beans to Registry Objects with Annotations
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
Association Types
Lifecycle Management
Revision Management
Multi-User Scenarios
Setting the Classpath
Examples
Importing Objects Using API
Introduction to Importing Objects Using API
Invoking Importer from Java Program
Importing Web Service
Setter Methods
setDescription
setOrganization
setOrganization
setPackageName
setPackageObject
setUsedObject
setUsesObject
setWebDAVFolder
setUserVersion
setServiceName
Importing Web Service from URL
Updating Registered Web Service
Attaching WSDL to Registered Web Service
setAttachServiceID
setCreateVersion
Removing Registered Web Service
removeService
removeServices
removeServiceByID
setDeleteTargetAssocs
setRemoveReferencedImports
Finding Registered Web Service
findWebServiceByNamespace
findWebServices
Importing Schema
Removing Schema
removeByName
remove
removeCascading
removeCascading
Importing BPEL Process File
setProjectName
setWarningIfPLTNotFound
Removing Registered BPEL Object
remove
RemoveProcess
Importing XPDL File
setOrganization
SetOriginalFilename
setProductConcept
setVersion
Invoking Importer through Command Line
Creating Script File to Invoke an Importer
Creating Script File for Windows (a .bat File)
Creating Script File for UNIX (Bourne-Shell Script)
Importer Class Names
Executing Script File to Invoke Importer
Importing Web Service
Importing REST Service
Importing XML Schema
Importing BPEL Process
Importing XPDL File
Invoking Importer Using SOAP API
Writing Your Own Importer
The Build Environment
The Plug-In Environment
Propagating the Plug-In
Generating Additional Files
Activating the Plug-In
Deactivating the Plug-In
Setting Up CentraSite Eclipse Plug-ins
Installing CentraSite Plug-ins in Your Own Eclipse Environment
Connecting Eclipse to CentraSite
Using CentraSite Online Documentation
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
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 using the User Management Component
Configuring the SMTP Mail Server Connection for API Portal using ACC
Configuring Ports
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 or Reverse Proxy Setup
Reconfiguring the Loadbalancer Settings
Adding a SSL Certificate to Load Balancer
Updating the SSL Certificate
API Portal License File
Importing the API Portal License File using the ACC
Importing the API Portal License File using the UMC
Configuring User Registration
Configuring Approval Workflow for User Registration
Assigning Users to the Approver Group
Configuring the Multi-Level Approval Workflow
User Registration Process
Pending Approvals
Displaying Pending Approvals for User Registration Requests
Approving a User Registration Request
Rejecting a User Registration Request
View and Manage Users
Email Notifications Templates and Tokens
Customizing Email Templates
Email Tokens
User Registration in API Portal with Social Login
Configuring Google Login
Configuring Facebook Login
OAuth Properties for Social Login
Removing Social Login
Configuration Settings
Customizing Tenant-wide Configuration
Resetting the Default Configuration Settings Tenant-wide
Advanced Configuration of API Portal
Accessing Elasticsearch
Accessing Elasticsearch Using Auto-generated Access Details
Configuring Elasticsearch Access Details
Disabling Secure Access of Elasticsearch
Configuring API Portal with External Databases
Configure API Portal with Microsoft® SQL Server
Configure API Portal with an Oracle Database
Taking a Back up of API Portal database
Starting Zookeeper Service
Registering External Oracle DBMS
Creating Database Schema for Tenants
Enhancing Runnables with JDBC Driver for External Database
Registering the External Service Database
Assigning Tenant to the Database Service
Restoring the backed up data
Configuring API Portal with a Postgres Database
Backing up API Portal Database
Starting Zookeeper Service
Creating Postgres Database and User
Registering the External Service Database
Starting all Runnables
Restoring the backed up data
High Availability setup in API Portal
Setting up API Portal HA setup
Adding of Nodes
Deconfiguring Runnables and Reconfiguring Zookeeper
Reconfiguring Elasticsearch
Reconfiguring Other Runnables
Starting the High Availability Setup
Setting up API Portal HA setup with External Database (Oracle)
Adding of Nodes
Deconfiguring Runnables and Reconfiguring Zookeeper
Reconfiguring Elasticsearch
Reconfiguring Other Runnables
Registering External Oracle DBMS
Creating Database Schema for Tenants
Enhancing Runnables with JDBC Driver for External Database
Registering the External Service Database
Assigning Tenant to the Database Service
Starting the High Availability Setup
Managing Tenants
Creating Tenants
Deleting Tenants
Securing Internal Network Resources
Enabling Internal Network Security
Configuring the API Endpoint Validation
Configuring Sub-domain Names for API Portal Tenants
Configuring Domain Address
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)
Changing Clous Password
API Portal Components
Verifying the Status of API Portal Components
Understanding API Portal Component Status in ACC
Starting and Stopping API Portal Components
Opening the API Portal User Interface in a Browser
Changing the Password
Editing your Profile
Configuring Display Settings
Scheduling Reports for Application Usage
Managing Teams
Creating Teams
Editing Teams
Deleting Teams
Notifications
Searching in API Portal
Managing Users
Overview of Managing Users
User Roles and Groups in API Portal
Importing LDAP Users and User Groups into User Management Console
Synchronizing LDAP Users or User Groups with User Management Console
Assigning Privileges to User Groups
Password Policy for API Portal Users
Configuring password policy for API Portal Users
Configuring LDAP Servers
Enabling Multi-factor Authentication
Configuring SAML 2.0 for a Consumer User
Managing API Providers
Manage API Providers
Creating an API Provider
Deleting an API Provider
Modifying Details of an API Provider
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 APIs
Manage APIs
Importing an API Directly through the API Portal User Interface
Importing an API by Uploading an API
Importing an API by Providing an API URL
Importing an API by Copying and Pasting API Content
Deleting an API
Updating an API
API Versions
Creating a New API Version
Editing APIs
Modifying the Basic Attributes of an API
Modifying the Advanced Attributes of an API
Markdown Support
Using and Testing APIs
API Gallery
Finding APIs in the API Gallery
Viewing API Details
API Details View
Editing APIs
Modifying the Basic Attributes of an API
Modifying the Advanced Attributes of an API
Markdown Support
Testing a REST API
Testing a SOAP API
Testing an OData API
OAuth 2.0 Support
Testing an OAuth Protected API
Testing a JWT protected API
Following an API
Sharing an API
Downloading Client SDK for an API
Managing Applications
Applications
Viewing List of Applications and Application Details
Application Details View
Renewing Access Tokens
Revoking Access Tokens
Application Sharing
Sharing an Application
Revoking Access from a Shared Application
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
Viewing API Packages and Associated Plans
API Package details
Managing Apps
App Gallery
App Details View
Manage Apps
Creating an App
Deleting an App
Modifying Details of an App
Managing Communities
Communities
Communities View
Creating a Community
Editing Community Details
Defining Community Administrator
Adding Members to a Community
Removing Members from a Community
Adding User Groups to a Community
Removing User Groups from a Community
Removing a User from the Community Administrator Group
Leaving a Community
Adding APIs to a Community
Removing APIs from a Community
Managing Collaboration
Collaboration
Collaboration View
Modifying a User Profile
Finding Users and Groups and Following their Feeds
Defining Filters
Commenting on, Sharing, and Flagging Posts
Creating a Group
Inviting other Users to Collaborate
Accepting or Denying Requests to join Private Groups
Granting or Revoking Group Coordinator Privileges
Checking Activities Reported as Inappropriate
Modifying Notification Settings
Commenting on Portal Content
Publishing Posts
Using Hashtags
Following API Portal content as a Group
Finding Help
Analytics
Dashboard
Global Dashboard
API Audit Log
User Audit Log
Runtime Dashboard
API Trends Dashboard
Consumer Dashboard
Viewing Dashboards
Managing Data in API Portal
Configuring Audit Logs
Purging Logs
Purging logs by invoking a REST service
Purging logs through the user interface
Backing up and Restoring Tenant-specific Data
Registering Nodes Using the ACC REST Service
Registering Nodes Using the Configuration File
Backing up Tenant-specific Data
Backing up Tenant-specific Data Through the User Interface
Restoring Tenant-specific Data
Restoring Tenant-specific Data Through the User Interface
Troubleshooting Backup and Restore Failures
Collecting API Portal Logs
Customizing API Portal Views
API Portal Views
Creating a View
Activating a View
Customizing Pages
Restoring a Default Item or Page
Backing up a View
Restoring a View
Renaming a View
Deleting a View
Remove User Data from API Portal
Removing User Data
Anonymizing user data in UMC
Anonymizing user data in ECP
API Portal REST APIs
API Portal REST APIs
Manage APIs
Manage Communities
Manage Providers
Manage Applications (Access Tokens)
Export API Usage Details
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
Integration Server Security
Integration Server Logging
Logging, Data Protection, and Privacy
Integration Server Caching
About Integration Server Fixes
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
Increasing File Descriptors on Mac OS X or Other UNIX System
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
Unapplied Changes to Integration Server Configuration Files
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 of Integration Server Instances
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
Updating an Integration Server Instance
Updating Packages on a Server Instance
Updating Database Properties of a Server Instance
Deleting Packages from a Server Instance
Updating Language Packs on a Server Instance
Deleting a Server Instance
Using Integration Server Administrator
What Is Integration Server Administrator?
Starting Integration Server Administrator
Starting Integration Server Administrator on Windows
Accessing Integration Server Administrator through My webMethods Server
Introduction to webMethods Integration Server Administrator
Accessing the Legacy Integration Server Administrator
Naming and Navigation Changes in the new Integration Server Administrator
The Server Configuration File
Logging Off Integration Server Administrator
Using the Dashboard
Overview
JVM Metrics
Usages
Services
Service Instances
Cache and Prefetch Information
Circuit Breaker Information
APIs
Configuring the Dashboard
Managing Notifications
Overview
Viewing Notifications
Dismissing Notifications
Ignoring Notification Types
Restoring Ignored Notification Types
Managing Users and Groups
Users and Groups
Purpose of Users and Groups
Defining a User Account
Predefined User Accounts
Adding User Accounts
Deleting User Accounts
Adding an Administrator User
Adding a Developer User
Changing Passwords
Configuring Password Requirements and Expiration Settings
Setting Password Requirements
Setting Password Expiration Requirements
Configuring Account Locking Settings
Unlocking User Accounts
Disabling and Enabling User Accounts
Disabling a User Account
Enabling a User Account
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
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
Connecting Integration Server to Database Components in an External RDBMS
Concepts
Pointing Functions at Connection Pools
Installing the MySQL Community Edition Database Driver
Installing the Tibero JDBC Driver
Creating a Driver Alias Definition
Creating a Connection Pool
Using Kerberos Authentication for Outbound Connections to a Database
Using the Kerberos Re-Authentication Feature
Using a Different Kerberos Ticket Cache File with each JDBC Connection Pool
Addressing JAAS Conflicts for Kerberos
Configuring Ports
About Ports
Available Port Types
Default Ports
About the Port Alias
Package Associations for Ports
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 for HTTP Ports
Editing Advanced Controls
Adding an HTTPS Port
About File Polling Ports
Adding a File Polling Port
Adding an FTPS Port
How Client Authentication Works for FTPS Ports
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
Disabling Protocols for JSSE per Port
Designating an HTTP/S Port as Stateless
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 and the Server Log
The Statistics Log
About the Statistics Log
Viewing the Statistics Log
Server Configuration Parameters that Affect the Statistics Log
The HTTP Log
About the HTTP Log
Common Log Format
Combined Log Format
Legacy Log Format
Setting the Format for the HTTP Log
Configuring Integration Server for webMethods Messaging
Overview of webMethods Messaging
Working with Messaging Connection Aliases
Predefined Messaging Connection Aliases
Creating a Broker Connection Alias
Creating a Universal Messaging Connection Alias
About Follow the Master for webMethods Messaging
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
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 for Using a Stateless Cluster with webMethods Messaging
Configuring Integration Server for JMS Messaging
Overview of JMS Messaging Configuration
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 Software AG 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
Considerations for JMS Providers
About Using Software AG Universal Messaging as the JMS Provider
Adding JMS Provider Client Libraries to Integration Server Classpath
Configuring Integration Server for MQTT Messaging
Overview of MQTT Support in Integration Server
Limitations of MQTT Support in Integration Server
Supported MQTT Servers
Creating an MQTT Connection Alias
Editing an MQTT Connection Alias
Enabling and Disabling an MQTT Connection Alias
Deleting an MQTT Connection Alias
Specifying a Retry Interval for Failed Connections to the MQTT Server
Using Enhanced Logging for Messaging
About Enhanced Logging for Messaging
What Is in Log Entries for Enhanced Logging?
Logging Levels for Enhanced Messaging Logging
Using the Messaging Log or the Server Log for Enhanced Logging
Configuring Enhanced Logging for Messaging
Viewing the Messaging Log
Setting Up Universal Messaging Client Logging
Universal Messaging Client Logging
Configuring Universal Messaging Client Logging
Event Lifecycle Logging
Configuring Event Lifecycle Logging
Configuring Endpoint Aliases for Web Services
About Web Service Endpoint Aliases
Creating an Endpoint Alias for a Provider Web Service Descriptor for Use with HTTP/S
Setting a Default Endpoint Alias for Provider Web Service Descriptors
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 JWT
Overview of JWT
Using JWT with Integration Server
Support for JWT in Integration Server
Configuring Integration Server to use JWT
Enhanced Support for JWT in Integration Server
Trusted Issuers
Adding Trusted Issuers
Deleting a Trusted Issuer
Issuer-Certificate Mapping
Creating an Issuer-Certificate Mapping
Deleting an Issuer Certificate Mapping
Skew Mapping
Creating an Issuer Skew Mapping
Editing Global Claim Settings
Configuring Integration Server to Use Kerberos
Overview of Kerberos Usage in Integration Server
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
Using HTTP Interceptors
Overview of HTTP Interceptors
Types of HTTP Interceptors
HTTP Interceptor Interfaces
Working of HTTP Interceptors
Considerations for Creating an HTTP Interceptor
Creating an HTTP Interceptor
Configuring Integration Server for HTTP Compression
Overview
HTTP Request Compression
HTTP Response Compression
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
Configuring Integration Server for Secure Communications
Overview of SSL in Integration Server
Supported SSL Authentication Types
Supported SSL/TLS Protocols
Changes to watt.net.jsse* Parameters for Default Disabled Protocols
Disabling TLS Renegotiation
Specifying Cipher Suites for Use with SSL
Preparing to Configure SSL in Integration Server
Creating Public/Private Keys and Certificates for Integration Server
Creating a Keystore and Truststore
Obtaining the Public Keys and Certificates of the Partner Application or Resource
Configuring Integration Server SSL Keys and Certificates
Specifying Integration Server SSL Certificates and Keys
Usage of CA Certificates: Technical Considerations
Handling Expired CA Certificates
Customizing Usage of Truststores
Configuring Integration Server as an SSL Server
Configuring an HTTPS or FTPS Port
Controlling Server SSL Security Level by Port
Configuring Integration Server as an SSL Client
Configuring SSL Information for the Integration Server JVM
Order of Precedence for the javax.net.ssl Properties
Using Multiple Client Certificates with SSL Servers
Setting Up a Remote Server Alias
Coding Your Flow Services
WS-Security and Integration Server
Setting Up SSL Session Logging
Overview of the SSL Session Log
Enabling the SSL Session Logging
Viewing the SSL Session Log
Changing the Default SSL Session Log Location
Managing the SSL Session Log Size
Avoiding Duplicate Entries in the Log
Using Keystores and Truststores with Integration Server
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
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
Adding Services to a Blacklist
Using a File for the Service Blacklist
Authenticating Clients
Overview
Basic Authentication
Digest Authentication
Kerberos Authentication
Client Certificate Authentication
Certificate Mapping
Importing a Client Certificate and Mapping It to a User
Changing a Certificate Mapping
Client Certificates and Port Configuration
Client Authentication and Access Control
Single Sign-On Authentication for My webMethods
Configuring the MWS Single Sign-On Resource Setting
SAML Authentication
Requirements for SAML Authentication
Identifying Trusted STSs to Integration Server
Accepting SAML2 Tokens at the Transport Level
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 an External Authorization Server
Integration Server as a Resource Server
OAuth Client Types
Authorization Grant Types Supported by Integration Server
Authorization Code Grant
Using PKCE with the Authorization Code Grant
Implicit Grant
Resource Owner Password Credentials Grant
Client Credentials Grant
The Integration Server OAuth Services
Important Considerations for Using OAuth Features
Configuring Integration Server for OAuth
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
Managing Tokens
Viewing Tokens
Deleting Tokens
Revoking Tokens
Removing Expired Access Tokens
Customizing the Approval Page
About Using Integration Server as the Resource Server
Using an External Authorization Server
Creating an External Authorization Server Alias
Deleting an External Authorization 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 Integration Server to Use 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
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
Considerations for Hot Deployment of Packages
Enabling and Configuring Hot Deployment of Custom Packages
Disabling Hot Deployment of Custom Packages
Automatic Package Deployment
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 Terracotta Ehcache on Integration Server
What is Terracotta 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
About the Maximum Entries in Cache Value
Making a Cache Searchable
Defining Attributes
Extracting Attributes by Class
Example Extractor
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 Terracotta Ehcache Activity
Logging Terracotta 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
Configuring WebSockets
Overview
How WebSocket Works
Setting Up Integration Server for WebSockets
Configuring a WebSocket Ports
Configuring a WebSocketSecure Ports
Viewing WebSocket Server Endpoints for a WebSocket Port
WebSocket Server Sessions Page
Limitations When Using WebSocket Protocol in Integration Server
Configuring gRPC in Integration Server
Overview of gRPC
gRPC Support in Integration Server
Authentication for gRPC
Requiring or Requesting Client Certificates
Using “Plaintext” Mode for Communication with the gRPC Server
Working with gRPC Channels
Editing a gRPC Channel
Enabling or Disabling a gRPC Channel
Managing gRPC Descriptors
Limiting Integration Server Resources for gRPC
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 10.3 or Later from Earlier Versions
Synchronizing the webMethods Messaging Trigger and Durable Subscription on Universal Messaging
Managing JMS Triggers
Introduction to JMS Trigger Management
Searching for JMS Triggers
About JMS Trigger Status and State
Enabling, Disabling and Suspending a JMS Trigger
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
What Happens When JMS Triggers Fail to Start?
How Does the JMS Trigger Restart Task Work?
About WS Endpoint Triggers
Editing WS Endpoint Triggers
Managing MQTT Triggers
Introduction to MQTT Trigger Management
MQTT Trigger State and Status
Changing the State of an MQTT Trigger
Configuring Integration Server Session Reuse for MQTT Triggers
Automatic Retry for Starting MQTT 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 in Integration Server
How Integration Server Uses Content Handlers
How Integration Server Chooses a Content Handler for an HTTP Request
How Integration 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
Class Loading in Integration Server
How Class Loading Works in Integration Server
Class Loaders
OSGi Bundle Class Loader
Integration Server Class Loaders
Classpaths
How the Integration Server Classpath Is Set
Additional Information about How the Microservices Runtime Classpath Is Set
Adding Classes to the Server Classpath
Adding Classes to a Package
Class Searching Order
How Classes Are Found
How Classes Are Found in Microservices Runtime
Searching Order within a Package
Where to Put Your Classes and Jar Files
Accelerating Class Loading
Whitelist Filtering in Integration Server
About Whitelist Filtering in Integration Server
Enabling or Disabling Whitelist Class Filtering
Integration Server Whitelist Classes File
Creating a Package Whitelist Classes File
Logging Classes that Are Not on the Whitelist
Integration Server Blacklist Classes File
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 Settings
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
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
Using Integration Server with Docker
Overview of Docker and Integration Server
Recommendations for Using Integration Server with Docker
About the is_container Script
is_container Script Commands
Prerequisites for Building a Docker Image
Excluding Web Services Support from a Docker Image for Microservices Runtime
Specifying Services to Expose to Consumers in webMethods Cloud
Building the Docker Image for an Integration Server Instance
Loading a Docker Image to an On-Premise Docker Registry
Pushing a Docker Image to an On-Premise Docker Registry
Running the Docker Image in an On-Premise Docker Container
Writing the Server Log to the Console
Writing Audit Logs to the Console
Accessing an Integration Server Running in a Docker Container
Externalizing Log and Configuration Files When Running Integration Server in a Docker Container
Pushing the Docker Image to Integration Cloud
Running the Docker Image in Integration Cloud
Stopping a Docker Container for Integration Server
Using a Configuration Variables Template with a Docker Image
Integration Server Administrator API
Introduction to the Administrator API
Authentication and Authorization
REST URL Structure
CRUD Operations
Administrative Actions
Credentials
Expanding Responses
Media Type for Responses
Media Type for Request Payloads
Getting Started
Controlling Access to the Administrator API
Creating a Read-Only Administrators Group
Logging Client Errors
Including a Stack Trace in the Response Body
Integration Server Administrator API Operations
Simulating Metering in Integration Server
About webMethods Metering
About the Metering Simulator
Enabling the Metering Simulator
Controlling JSON Output
Controlling Date Encoding in JSON Responses
Formatting JSON Output to Make it More Readable
Using Command Central to Manage Integration Server
An Overview of Command Central
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
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.adapters.
watt.adminapi.
watt.art.
watt.broker.
watt.brokerCoder.
watt.cachedirective.
watt.cds.
watt.client.
watt.config.
watt.core.
watt.debug.
watt.debug2.
watt.frag.
watt.infradc.
watt.net.
watt.security.
watt.server.
watt.serverlog.
watt.ssh.
watt.ssl.
watt.tx.
watt.um
watt.wm.tnextdc.
watt.wmcloud.
Statistics Data Collector Configuration Parameters
Environment Variables
Environment Variables Defined in Integration Server and Microservices Runtime
FIPS 140-2 Compliance
FIPS 140-2 Compliance
Using NTLM Authentication when Integration Server Acts as the Client
Overview
Using Java-Based NTLM Support
Using Native NTLM Support via Integrated Windows Authentication
Activating Integrated Windows Authentication
Deactivating Integrated Windows Authentication
Removing User Data from Integration Server
Removing User Data
Removing References to a User Account
Removing References to Email Addresses
Removing Personal Data from Log Files
Removing Personally Identifiable Information from the Server Log
Removing Personally Identifiable Information from the Session Log
Removing Personally Identifiable Information from the Service Log
Removing Personally Identifiable Information from the Security Log
Removing Personally Identifiable Information from the SSL Session Log
Removing Personally Identifiable Information from the Configuration Variables Log
Removing Personally Identifiable Information from the HTTP Log
Removing Personally Identifiable Information Logged by Axis2, Kerberos, SAML, and other Third Party Libraries
Masking Session IDs in Integration Server Session and Server Logs
Server Log Facilities
About Server Log Facilities
Integration Server
WmJSONAPI Package
WmParquet Package
WmXSLT Package
Flat File
Developer Portal Quick Start
Let's get you started
Developer Portal Overview
Quick Start Milestones
How Do I Install Developer Portal?
How Do I launch and log on to Developer Portal?
Next steps...
Using Developer Portal
Overview
Why do Organizations Expose APIs?
Why do APIs Need to be Managed?
What is webMethods Developer Portal?
Administration
Overview
How do I configure SMTP settings to send emails?
How do I configure password policy?
Security Settings
How do I configure user account lockout settings?
How do I configure multi-factor authentication settings?
How do I configure advanced security settings?
How do I configure user session settings?
How do I configure email notification templates?
How do I configure webhooks to notify events to an external system?
List of events
How do I configure webhooks to notify user sign up and application requests to an external approval system?
How do I specify the Developer Portal URL for reference from external systems?
How do I update the Developer Portal license?
How do I configure the default group and community for a new user?
User management
Overview
Native Registration
How do I add a user?
How do I add a user group?
How do I assign privileges to a user?
Onboarding Strategy
How do I configure onboarding strategy to process user sign up requests?
How do I configure an approval workflow to process an internal approval onboarding strategy?
LDAP Users and Groups Onboarding
How do I create an LDAP connection to import users from a LDAP server?
How do I create an LDAP connection to import users from a secured LDAP server?
How do I specify attributes for the LDAP connection established with an LDAP server?
How do I import users and user groups from an LDAP server?
Single Sign-On Users Onboarding
SAML SSO Onboarding
How do I onboard users using their SAML service provider credentials?
How do I configure SAML settings to specify user onboarding configurations?
User Onboarding using Social Media Account
How do I onboard users using their Social media credentials?
Customization
Overview
Managing Themes
How do I create a theme for customizing the Developer Portal UI?
Customize pages
How do I customize a block on a page?
Customization fields
How do I add a new block and component?
How do I move blocks in a page?
How do I remove a block from a page?
How do I add a page?
Customize UI Components
How do I add a new item to the top navigation bar?
How do I customize the top navigation bar?
How do I customize the Sign up page?
How do I customize the API grid displayed in API gallery?
How do I customize the package grid?
How do I customize the API details pane?
How do I customize the plans grid?
Customize Labels
How do I add new UI labels?
Customize Color Schemes
How do I customize the color scheme used in a screen?
How do I customize the text and icon displayed in browser header?
Customization using Web components
How do I register a web component?
Sample Web component files
Customization example
Providers
Overview
How do I create a provider?
How do I map an API or a callback URL to a provider?
Communities
Overview
How do I create a community?
How do I map the required user, group, or API to a community?
APIs
Overview
How do I create an API?
How do I edit the basic attributes of an API?
How do I edit the advanced attributes of an API?
How do I create a new version of an API?
Applications
Overview
How do I configure onboarding strategy to process application or subscription requests?
Creating an application
How do I create an application from Manage applications screen?
How do I create an application from API details screen?
How do I create an application from Try API screen?
Backup and restore
Overview
How do I take a backup?
How do I restore data from a backup file?
Developer Portal REST APIs
Overview
Viewing analytics
Managing APIs
Managing applications
Managing approvals
Managing backup and restore
Managing comments
Managing communities
Managing configurations
Viewing Developer Portal audit events
Viewing Developer Portal health
Managing notifications
Getting OAuth token
Managing packages
Managing plans
Managing providers
Performing search
Managing teams
Managing topics
Managing application and subscription requests
Managing users
Managing webhooks
Configuring High Availability
Overview
Configuring High Availability
Configuring API Data Store
Configuring Ignite
Configuring Developer Portal
Configuring Load Balancer
HTTPS Port Configuration
Configuring HTTPS Port
Configuring an HTTPS Port
Copyright
API Management
Copyright
gtw_configure_cluster
gtw_archive_purge
gtw_restore_data
gtw_archive_purge_config
gtw_gen_config
gtw_configure_load_balancer
gtw_configure_extended_settings
gtw_configure_fault_settings
gtw_configure_approvals
gtw_configure_approvals_create
gtw_configure_approvals_register
gtw_configure_approvals_update
gtw_configure_approvals_subscribe
gtw_update_subscription
gtw_delete_subscription
ta_pending_request
gtw_configure_outbound_proxy
gtw_configure_proxy_bypass
gtw_configure_url_aliases
gtw_custom_content_type
gtw_configure_cache
gtw_configure_loglevels
gtw_download_logfiles
gtw_configure_log_aggregation
gtw_license_info
gtw_configure_license
gtw_configure_callback_settings
gtw_jndi_provider_alias
gtw_jms_connection_alias
gtw_jms_triggers
gtw_configure_license_alerts
gtw_configure_gateway
gtw_configure_portal
gtw_configure_portal_events
gtw_configure_audit_logger
gtw_configure_cs
gtw_configure_cs_events
gtw_configure_database
gtw_configure_des
gtw_configure_es
gtw_configure_es_events
gtw_configure_email
ta_configure_email_template
gtw_configure_snmp
gtw_configure_snmp_events
gtw_configure_custom
gtw_configure_system_settings
gtw_configure_saml_sso
gtw_service_registries
gtw_configure_aws_alias
gtw_sec_config
gtw_configure_keystore
gtw_configure_truststore
gtw_configure_keystore_truststore
gtw_config_key_trust_outbound_connections
gtw_configure_ports
gtw_configure_ipaccessmode
gtw_configure_accessmode
gtw_configure_global_ip
gtw_configure_saml_issuer
gtw_policy_assertions
gtw_configure_policy_assertion
gtw_configure_kerberos
gtw_manage_master_password
gtw_configure_auth_server_int
gtw_configure_provider
gtw_configure_auth_server_ext
gtw_map_oauth_scope
gtw_manage_security_microgateway_communication
gtw_introduction
gtw_search
gtw_manage_users_groups_profiles
gtw_add_user
ta_modify_user
co_user_groups
gtw_add_group
ta_modify_group
gtw_manage_pwd_restrictions
gtw_manage_pwd_expiry_settings
gtw_manage_account_lock_settings
gtw_manage_locked_users
gtw_manage_provider_configuration
gtw_manage_ldap_directories
gtw_manage_user_accounts_settings
gtw_manage_apis
gtw_create_api_file
gtw_create_api_url
gtw_create_api_scratch
gtw_create_rest_api_scratch
gtw_create_websockets_api_scratch
gtw_add_api_mashup
gtw_view_api_details
updating_apis
updating_apis_file
updating_apis_url
api_mocking
ta_modifying_api_mocking
soap_rest_transformation
modifying_rest_definitions
content_type
endpoint
sample_rest_request
limitations
versioning_apis
create_new_versioning_apis
exporting_apis
exporting_specifications
gtw_manage_policies
gtw_manage_threat_protection_policies
gtw_transport_policies
gtw_iam_policies
gtw_payload_request
gtw_routing_policies
gtw_lmt_policies
gtw_payload_response
gtw_error_handling
gtw_manage_global_policies
gtw_create_global_policy
gtw_view_global_policy
gtw_modify_global_policy
exporting_global_policies
gtw_manage_policy_templates
gtw_create_policy_template
gtw_view_policy_template
gtw_modify_policy_template
gtw_apply_policy_template
gtw_manage_aliases
create_is_alias
create_transformation_alias
gtw_manage_applications
gtw_create_application
gtw_view_application_details
ta-modify_appln_ui
gtw_manage_packages
gtw_create_package
gtw_create_plan
ta-modify_package
ta-modify_plan
exporting_importing_files
gtw_analytics
gtw_manage_microgateways
gtw_view_microgateways_group_details
gtw_view_microgateway_details
gtw_configure_approval_change_owner
gtw_add_profile
gtw_configure_is
gtw_transformation_request
gtw_transformation_response
gtw_appmesh_manage
gtw_configure_service_mesh
gtw_manage_promotions
gtw_add_stage
ta_modify_stage
APIP_user_registration
APIP_Pending_Approvals
APIP_Config_Settings
APIP_Manage_Notifications
APIP_Manage_API_Provider
APIP_Manage_API
APIP_API_Gallery
APIP_API_Details
APIP_Manage_Access_Token
APIP_Application_Details
APIP_API_Package
APIP_App_Gallery
APIP_App_Details
APIP_Manage_App
APIP_Communities_View
APIP_Collaboration_View
APIP_Dashboard
APIP_Global_Dashboard
APIP_Runtime_Events_Dashboard
APIP_APItrends_Dashboard
APIP_Custom_Dashboard
APIP_Views