CentraSite Documentation
About this Help
Document Conventions
Online Information and Support
Data Protection
CentraSite Administrator’s Guide
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
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
CentraSite User’s Guide
Introduction
CentraSite's Role in Today's SOA
Use of CentraSite by Other Products
Topology and Architecture
CentraSite Editions
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
Using the CentraSite Control User Interface
Logging on to CentraSite Control as Registered User
Logging on to CentraSite Control as Guest User
Logging off from CentraSite Control
Navigation Controls in CentraSite Control
Setting Display Options in CentraSite Control
Restricting the Locale
Viewing or Editing Information About Your User Account
My Favorites
Viewing My Favorites
Adding Shortcuts to Individual Objects
Adding Shortcuts to Multiple Assets in a Single Operation
Adding an Object to My Favorites
Adding Multiple Objects to a List in a Single Operation
Removing an Object from a List
Adding a Saved Search to My Favorites
Viewing or Editing a Saved Search
Adding an XQuery to My Favorites
Adding a Category List to My Favorites
Adding a Type List to My Favorites
Removing Entries from My Favorites
Renaming an Entry in My Favorites
Notifications
Creating a Notification Request
Creating Notification Requests for Multiple Assets in a Single Operation
Viewing Notifications You Have Received
Deleting a Notification Request
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
Managing Organizations through CentraSite Control
Adding Organization
Modifying Organization Details
Deleting Organizations
Adding Child Organization
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
Managing Users through CentraSite Control
Adding User to an Organization
Adding a User and Associating with External Authentication System Account
Bulk Loading Users from External Authentication System
Adding Users from External Authentication System
Viewing the User List
Viewing User Details
Modifying User Details
Adding User to a Locally Managed Group
Assigning Roles to a User
Activating or Deactivating Users
Activating or Deactivating Users from the Users Page
Activating or Deactivating a User from the Edit User Page
Activating or Deactivating a Users from the Edit Organization Page
Viewing Assets Owned By a User
Moving Users to a Different Organization
Deleting Users
Deleting Users from the Users Page
Deleting Users from the Edit Organization Page
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 CentraSite Control
Adding Group to an Organization
Adding a Locally Managed Group
Bulk Loading Groups from External Authentication System
Adding an Externally Managed Group
Viewing the Group List
Viewing Group Details
Modifying Group Details
Assigning Roles to Group
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
Managing Roles through CentraSite Control
Adding Role to an Organization
Viewing the Role List
Viewing Role Details
Modifying Role Details
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 CentraSite Control
Adding an Asset Type
Adding an Attribute to Asset Type
Adding Profile to an Asset Type
Inheriting Base Type Profiles, Lifecycle Models, and Policies
Cloning Base Type Profiles
Excluding Sub Types from CentraSite Business UI Search
Viewing Asset Type List
Modifying Asset Type Details
Deleting Asset Types
Adding an Association Type
Modifying Association Type Details
Deleting Association 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
Managing Taxonomies through CentraSite Control
Adding Taxonomy
Viewing the Taxonomy List
Viewing Taxonomy Details
Modifying Taxonomy Details
Associating Taxonomy to Object Types
Setting Permissions on Taxonomy
Deleting Taxonomies
Adding Taxonomy Category
Modifying Taxonomy Category Details
Deleting Taxonomy Categories
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
Managing Lifecycle Models through CentraSite Control
Adding Lifecycle Model to Organization
Adding Lifecyle Stage to Organization
Adding State to Lifecycle Model
Viewing the Lifecycle Model List
Viewing Lifecycle Model Details
Modifying Lifecycle Model Details
Defining Stage Transitions for Lifecycle Model
Associating an Asset Type with Lifecycle Model
Viewing Policies Associated with Lifecycle Model
Setting Permissions on Lifecycle State
Activating Lifecycle Model
Versioning a Lifecycle Model
Deleting State from Lifecycle Model
Deleting Lifecycle Models
Deleting Most Recent Version of Lifecycle Model
Deleting a Version and All Older Versions of Lifecycle Model (Purging)
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
Managing Assets through CentraSite Control
Searching and Browsing the Asset Catalog
Searching the Asset Catalog
Keyword Search
Advanced Search
Searching the Catalog by Type
Searching the Catalog by Attribute Value
XQuery Search
Combining Search Criteria
Saving and Re-Executing Searches
Saving a Search Definition
Re-executing a Saved Search
Redefining an Existing Saved Search
Browsing the Asset Catalog
Browsing the Catalog by Asset Name
Browsing the Catalog by Asset Type
Browsing the Catalog by Taxonomy
Web Service Management
Adding Web Service Asset to Catalog
Importing Web Service (including Abstract Service) Asset
Adding Web Service Asset from Scratch
Viewing Web Service List
Modifying Web Service Details
Deleting Web Services
REST Service Management
Adding REST Service Asset to Catalog
Viewing REST Service List
Modifying REST Service Details
Deleting REST Services
OData Service Management
Adding an OData Service Asset to the Catalog
Viewing OData Service List
Modifying OData Service Details
Deleting OData Services
Application Management
Adding an Application to Your Asset Catalog
Viewing Application Asset List
Modifying Application Asset Details
Deleting Application Assets
General Procedures across Assets
Attaching Supporting Documents to Asset
Attaching Documents Using URL
Attaching Documents from Supporting Document Library
Removing Supporting Documents from Asset
Changing Lifecycle State of Asset
Setting Permissions on Asset
Restricting Access to Asset Profiles
Setting Instance Level Permissions on Asset
Setting Instance Level Profile Permissions on Asset
Propagation of Permissions
Versioning an Asset
Creating New Version of Asset
Locating Other Versions of Asset
Purging Older Versions
Considerations for Asset Types of the Suite
Managing Asset Revisions
Purging Old Revisions
Reverting to an Older Revision
Switching Revision Processing On
Switching Revision Processing Off
Checking Current State of Revision Processing
Changing Ownership of Asset
Changing User Ownership of Asset
Changing Organization Ownership of Asset
Downloading Asset
Performing Zip Download
Downloading Documents from Supporting Document Library
Downloading a Single Document from Supporting Document Library
Downloading WSDL or XSD Document from Service or XML Schema Asset
Managing Supporting Documents
Adding Folder to Supporting Document Library
Deleting Folder in Supporting Document Library
Adding Documents to Supporting Document Library
Viewing Details of the Supporting Document Library
Replacing Documents in Supporting Document Library
Moving Document to Another Folder
Finding Assets Referring to Document in Supporting Document Library
Deleting Documents from Supporting Document Library
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
Asset Navigator in CentraSite Control
Introduction to Impact Analysis
Graphical Visualization of Impact Analysis
Tabular Visualization of Impact Analysis
Configuration Settings
Built-In Filter Configurations
Adding a Custom Filter Configuration
Deleting a Custom Filter Configuration
Zooming the Graphical Visualization
Printing the Graphical Visualization
Full-Screen Display of Graphical Visualization
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 and Change-Time Policies through CentraSite Control
Creating a Design/Change-Time Policy
Activating a Design/Change-Time Policy
Deactivating a Design/Change-Time Policy
Viewing Design/Change-Time Policy List
Viewing or Modifying a Design/Change-Time Policy
Scope of a Design/Change-Time Policy
System-wide and Organization-specific Policy Enforcement
Modifying Scope of a Design/Change-Time Policy
Refining the Object Scope
Configuration of Policies that Execute on Lifecycle State Changes
Assigning Actions to a Design/Change-Time Policy
Policy Scope and Action Scope
Modifying the Action List
Configuring Policy Action Parameters
Setting Permissions through Design/Change-Time Policy Details
Setting Permissions through Design/Change-Time Policy
Policies on Demand
Running a Policy on Demand
Deleting Design/Change-Time Policies
Copying a Design/Change-Time Policy
Versioning a Design/Change-Time Policy
System-Assigned and User-Assigned Version Identifiers
Modifying the Predefined Lifecycle Model for Policies
Viewing the Policy Log
Viewing Failed Policies From Your Inbox
Exporting Design/Change-Time Policies
Importing Design/Change-Time Policies
Approval Policies
Enforcing Approval Action
Approval Modes
Events and Objects for Approval
Adding an Approval Policy
Multiple Actions in Approval Policy
Using Approvals with Pre-State Change Events
Using Approvals with OnConsumerRegistration Events
Approver Groups
Reviewing Requests Submitted for Approval
Approving a Request
Viewing Your Approval History
Viewing the Approval History Log
Reverting the State of an Object that is Pending Approval
Using the Approval Service API
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 CentraSite Control
Adding Report Template
Associating Report Template with Object Types
Setting Permissions on Report Templates
Viewing the Report Templates List
Modifying Report Template Details
Deleting Report Templates
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 CentraSite Control
Virtual SOAP Service Management
Adding Virtual Service from an Existing Service
Adding Virtual Service from Scratch
Viewing Virtual Service List
Modifying Virtual Service Details
Configuring Virtual Services
Configuring the Entry Protocol Step
Configuring the Request Processing Step
Configuring the Response Processing Step
Configuring Straight Through Routing
Configuring Content-based Routing
Creating Content-based Routing Rule
Configuring Context-based Routing
Creating Context-based Routing Rule
Configuring Load Balancing Routing
Configuring Routing Protocol for Web Services Exposed over JMS
Deploying Virtual Services to Targets
Deploying Virtual Services from the Details Page
Deploying Virtual Services from the Deployment Page
Performing Keyword Search for Deployment
Performing Advanced Search for Deployment
Deploying Virtual Services Using Batch Process
Deleting Activity Logs Through Deployed Assets Tab
Deleting Activity Logs Through Deployment History Tab
Deleting Virtual Services
General Procedures across Assets
Displaying Event Information
Displaying Performance Metrics
Displaying Policy Information
Viewing Deployment History Log
Deleting Activity Logs Through Deployed Assets Tab
Deleting Activity Logs Through Deployment History Tab
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
Managing Run-Time Policies through CentraSite Control
Creating a Run-Time Policy
Activating a Run-Time Policy
Deactivating a Run-Time Policy
Viewing Run-Time Policy List
Viewing or Modifying a Run-Time Policy
Setting Permissions on a Run-Time Policy
Viewing the List of Services to Which a Run-Time Policy Applies
Deleting Run-Time Policies
System-Assigned and User-Assigned Version Identifiers
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
Built-In Run-Time Actions Reference (CentraSite Control)
Summary of Actions in the WS-SecurityPolicy Category
Summary of Actions in the Monitoring Category
Summary of Actions in the Additional Category
Configuring Destinations for Alerts and Logs
The watt.server.auth.skipForMediator Property
Usage Cases for Identifying or Authenticating Consumers
Built-in Actions for Run-Time Policies (CentraSite Control)
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
Synchronizing Consumer Applications through CentraSite Control
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 Events and Metrics through CentraSite Control
Displaying Event Information for Targets
Displaying Event Information for Assets
Displaying Performance Metrics for Assets
Creating Custom Run-Time Events
Modifying Run-Time Events
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
Monitoring Logs
Viewing Policy Log
Viewing Approval History Log
Viewing Audit Log
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 CentraSite Control
Exporting Objects through CentraSite Control
Importing Objects through CentraSite Control
Handling Missing Attributes of Assets When Importing
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 ARIS-Related LCMs and Policies through CentraSite Control
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 Developer's Guide
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
Legal
Copyright
CentraSite Documentation
Copyright