CentraSite Documentation
Getting Started with CentraSite
Introducing CentraSite
CentraSite's Role in Today's SOA
Today's SOA Challenges
Where CentraSite Fits in Today's SOA
Support for the SOA Design-Time Environment
Asset Management and Governance
Support for the SOA Run-Time Environment
Use of CentraSite by Other Products
Features
The Registry
The Catalog
The Repository
Design/Change-Time Policies
Run-Time Policies
Virtual Services
Lifecycle Management
Reporting
Impact Analysis
Security and Auditing
Role-Based Access
Federation with Other Registries
GUI Access to CentraSite
API Access to CentraSite
Topology and Architecture
Basic Topology
Architecture
The Information Model
Overview
Objects in the Information Model
Relationships Between Objects in the Registry
CentraSite Editions
Implementation Concepts
Implementation Decisions and Configuration Tasks
Issues to Consider Before Implementation
Configuration Checklist
Choosing a Deployment Strategy
Deploying to Support Your SDLC
Deployment Options
Deployment Considerations
Defining Your Organizational Structure
What is an Organization?
The Default Organization
Child Organizations
Consumer Organizations
Modeling Your Organizations
Choosing an Organizational Strategy
Users, Groups, Roles, and Permissions
Users
User Authentication
Predefined Users
Activating or Deactivating Users
Groups
Permissions and Roles
Instance-Level Permissions
Roles and Role-Based Permissions
System-Level Role-Based Permissions and Predefined Roles
Organization-Specific Role-Based Permissions and Predefined Roles
Considerations when Working with Instance-Level and Role-Based Permissions
Configuring the Default Roles that CentraSite Assigns to Users in an Organization
Customizing Your Asset Catalog
Creating Custom Types
Object Types vs. Asset Types
Customizing the Predefined Asset Types
Creating Custom Asset Types
Assigning Attributes to a Type
Assigning Attributes to Profiles
Creating Custom Asset Types that can be Imported from an Input File
Defining and Using Taxonomies
Classifying Assets Using Taxonomies
How Taxonomies Help Users Locate Assets
Using Taxonomies to Target the Execution of Design/Change-Time Policies
The Scope of a Taxonomy
The Predefined Taxonomies
Defining Custom Taxonomies
Creating Custom Association Types
How Association Types Are Used to Relate Assets to Other Objects
How Association Types and Relationship Attributes Support Impact Analysis
Creating Custom Association Types
Working with Asset Types, Taxonomies and Association Types in a Multi-Stage Environment
Issues to Consider when Customizing Your Registry
Defining Lifecycle Models
How Lifecycle Models Help You Organize Your Assets
How Lifecycle Models Help You Govern Your Assets
Lifecycle Model States and Transitions
Assigning Permissions to Lifecycle Model States
Triggering Policies during Lifecycle Model Transitions
Associating a Lifecycle Model with an Asset Type
When to Use Lifecycle Models
Lifecycle Stages
Creating a Lifecycle Model for a Single-Stage Environment
The Proposed State
The Design State
The Test State
The Available State
The Canceled State
The Deprecated State
The Retired State
Issues to Consider When Using Lifecycle Models in a Single-Stage Environment
Creating a Lifecycle Model for a Two-Stage Environment
The Lifecycle Model on the Creation Registry
The Promoted State
The Lifecycle Model on the Consumption Registry
Issues to Consider When Using Lifecycle Models in a Two-Stage Environment
Updating Assets That Are Under Lifecycle Management
Creating a Different Lifecycle Path for a New Version of an Asset
Reverting an Asset to a Previous State
Managing Lifecycle Models
Activating a Lifecycle Model
Versioning or Replacing Lifecycle Models
Modifying the Predefined Lifecycle Model for Lifecycle Models
Defining Design/Change-Time Policies
What is a Design/Change-Time Policy?
Policy Actions
Policy Scope
Refining a Policy's Scope with Additional Selection Criteria
Scope of a Policy Action
System-Wide vs. Organization-Specific Policies
Policy Priority
Pre-Operation and Post-Operation Event Types
What Happens When a Design/Change-Time Policy Executes?
OnTrigger Policies
Typical Uses for Design/Change-Time Policies
Using Policies to Initiate Reviews and Approvals
Using Policies to Validate Assets
Using Policies to Modify Assets
Using Policies to Issue Notifications or Update External Systems
Using Policies to Execute a Consumer Registration
Using Policies to Manage the Deployment of Virtual Services
Issues to Consider When Developing Design/Change-Time Policies
Managing Design/Change-Time Policies
Activating a Design/Change-Time Policy
Modifying a Design/Change-Time Policy
Copying a Design/Change-Time Policy
Modifying the Predefined Lifecycle Model for Policies
Working with Versions and Revisions
What is Versioning?
Which Objects Can You Version?
What is a Revision?
System-Assigned Version Identifiers vs. User-Assigned Version Identifiers
Using Versions to Avoid Enforcement Gaps in Policies and Lifecycle Models
When Should You Version an Asset?
How Do Lifecycles and Versioning Relate?
Managing the Transition to a New Version
Versioning in CentraSite vs. Versioning in Source Code Control Systems (SCCS)
Cleaning Up Old Versions
Planning Your Run-Time Environment
Basic Components in the Run-Time Environment (when using webMethods Mediator as the PEP)
Deploying for Run-Time Governance
An Overview of the Creation Run-Time Environment
An Overview of the Consumption Run-Time Environment
General Concept of Operations between the Environments
Implementing the Mediation Environment
Managing the Collection of Metrics
Managing the Collection of Events
Using CentraSite with Other Policy Enforcement Points
Defining Run-Time Policies
Run-Time Policy Scope
Refining the Run-Time Policy's Scope with Additional Selection Criteria
Run-Time Policy Actions
Run-Time Policy Deployment
Creating and Testing Policies
Distributing the Development of Policies
Activating a Run-Time Policy
Modifying a Run-Time Policy
Lifecycle Model for Policies in a Multi-Stage Deployment of CentraSite
Managing Virtualized Services
Which Services Should You Virtualize?
Virtualizing Business Services at the Point of Consumption
Virtualizing Shared Services
Virtualizing Services that are in Different Domains of Control (for example, Cloud Computing)
The Basic Elements of a Virtual Service
Virtual Service Processing Steps
Entry Protocol Step
Request Processing Step
Routing Step
Using the Routing Step to Direct Requests across Multiple Endpoints
Response Processing Step
Configuring for Virtual Services
Defining Gateways
Defining a Lifecycle Model for Services and Virtual Services
Understanding the Lifecycle for Services and Virtual Services
Creating the Lifecycle Model for Services and Virtual Services
Defining a Lifecycle Path that Enables Deployment of a Virtual Service
Creating a Policy that Enables the Deployment Profile
Creating a Policy that Disables the Deployment Profile
Creating Virtual Services
When Should You Create a Virtual Service?
Who Should Create a Virtual Service?
Virtual Service Ownership
Deploying a Virtual Service
The Deployment Process
Undeploying a Virtual Service
Redeploying a Virtual Service
Revising a Virtual Service
Minor Versions vs. Major Versions
The Layer of Indirection Pattern
The Adapter Pattern
Combination of the Layer of Indirection Pattern and the Adapter Patterns
Identifying the Consumers of Virtual Services
The Concept of Consumers
How Are Consumer Applications Represented and Used in CentraSite?
How Does Mediator Identify Consumer Applications at Run Time?
Defining Application Assets in CentraSite
Synchronizing the Application Assets in CentraSite with the Mediator
Deciding How to Identify a Consumer Application
Registering an Application Asset with a Virtual Service
The Consumer Registration Process
The Consumer-Registration Policy
Issues to Consider when Defining Applications
Managing Endpoints
Multiple Endpoints
Who Uses Endpoint Information?
How Service Endpoints are Represented in CentraSite
Managing the Endpoints of a Native Service over its Lifecycle
Example of the Bindings for a Service in a Single-Stage Registry
Example of the Endpoints for a Service in a Two-Stage Registry
Adopting a Naming Convention for Binding Names
Managing Endpoints of a Virtual Service over its Lifecycle
Publishing the Test Endpoint for a Virtual Service on the Consumption Registry
Deploying Multiple Virtual Services for a Single Native Service
Using the Asset Navigator Tool to Find the Virtual Services for a Native Service
CentraSite Administrator’s Guide
Basic Operations
Overview of Basic Operations
Starting and Stopping the Application Server Tier and Registry Repository
Administering the License Key
Relationship Between the License Key and Editions
Identifying the Edition of CentraSite You Are Using
Changing the License Key
Working with Time-Limited Licenses
Configuring CentraSite
Configuring Application Server Tier
Changing the Default Java Location for CentraSite
The Java Service Wrapper
The Java Service Wrapper Configuration Files
JVM Configuration
JVM Configuration Properties
The Wrapper Log
Logging Properties
Fault Monitoring
JVM Timeout Properties
Deadlock-Detection Properties
Console Filtering Properties
Generating a Thread Dump
Configuring a Proxy
Configure an HTTP Proxy
Configure an HTTPS (SSL) Proxy
Print on UNIX and Linux Systems
Configuring UDDI
Configuring CentraSite to Use Terracotta BigMemory
Setting Up CentraSite Eclipse Plug-Ins
Installing CentraSite Plug-ins in Your Own Eclipse Environment
Connecting Eclipse to the CentraSite Data Source
Using CentraSite Online Documentation
Installing Adobe Flash Player
Maintaining the CentraSite Internal Database
Repository Monitoring
Database Activity
Space Usage
Backing Up the Database
Restoring the Database from a Backup
Deleting a Backup
Moving a Database to Another Location
Locations
Listing the Currently Defined Locations
Changing the Currently Defined Path of a Location
Database Configuration Parameters
Reclaiming Disk Space in the CentraSite Database
How to Reclaim Disk Space in the CentraSite Database
Setting Up Replication Instances of the Registry Repository
Configuring the Authentication Settings
Listing Names of All of the Configurations
Listing Details of a Particular Configuration
Setting the Default Configuration
Adding a Configuration
Modifying a Configuration
Removing a Configuration
Configuring Port Numbers
Changing the Port Numbers of the Registry/Repository
Changing a Port Number on the Registry/Repository Host
Changing the Software AG Runtime Port Numbers
Configuring Secure Communication Between Components
Secure Communication Between the CRR and the CAST
Setting the Security Configuration for the Registry Repository
Creating a RR Configuration File to Define Security Values
Executing the RR Configuration File that Invokes Security Values
Setting the Security Configuration for the CAST Components
Creating a AST Configuration File to Define Security Values
Executing the AST Configuration File That Invokes Security Values
Obtaining the Security Configuration of Registry Repository
Obtaining the Security Configuration of CAST Components
CAST Stores
Identifying the Communication Method Between CAST and CRR
Allowing HTTP Communication Between CAST and CRR
Secure Communication Between Software AG Runtime and External Clients
Overview
Software AG Runtime Properties File for SSL Communication
SSL Keystore
SSL Truststore
Note on SSL Port Number
SSL Keystore
SSL Truststore
Note on SSL Port Number
SSL Truststore
Note on SSL Port Number
Configuring the Registry Cache Settings
Prerequisites
Displaying the Cache Configuration
Modifying the Cache Configuration
Option: maxElementsOnHeap
Option: maxElementsOffHeap
Option: memoryStoreEvictionPolicy
Option: statistics
Configuring the Email Server
Configuring the Email Server Settings
Getting the Email Server Settings
Overview of the Administration Tools
Overview of the inoadmin Command
Return Codes from Command Execution
Overview of the CentraSite Command
Overview of the Toolbox Script
Usage of the CentraSite Command Tools
Overview
Setting Your User Preferences from the Command Line
Updating Your User Preference Settings
Viewing Your User Preference Settings
Reconstructing Your User Preference Settings
Managing Gateways from the Command Line
Listing Existing Gateways
Creating a New Gateway
Configuration File
Deleting an Existing Gateway
Managing Reports and Scheduled Reports from the Command Line
Listing Existing Reports
Adding a New Report
Report Configuration File
Updating an Existing Report
Deleting an Existing Report
Sharing a Report with API-Portal
Downloading an Existing Report Template
Listing Existing Scheduled Reports
Adding a New Scheduled Report
Scheduled Report Configuration File
Updating an Existing Scheduled Report
Deleting an Existing Scheduled Report
Triggering an Existing Scheduled Report
Managing Run-Time Event Store from the Command Line
Fetching the State of Run-Time Event Store
Changing the Storage Mode of Run-Time Event
Purging the Run-Time Events
Fetching Details of the Migrated Pending Consumer Registrations from the Command Line
Usage of the CentraSite Toolbox Scripts
Overview
Invoking an Existing Toolbox Script
Logging On and Using the UIs and APIs
Your User Account
User Accounts
Ways to Interact with CentraSite
CentraSite User Interfaces
CentraSite Control
CentraSite Plug-ins for Eclipse
CentraSite Business User Interface
Application Program Interfaces (APIs) to CentraSite
Using the User Interface
Starting CentraSite
Navigation Controls in the User Interface
Context Menus
Actions Menu
Setting Display Options in CentraSite Control
Restricting the Locale
Viewing/Editing Information About Your User Account
Working with My Favorites
Viewing My Favorites
Adding Shortcuts to Individual Objects
Adding Shortcuts to Multiple Assets in a Single Operation
Adding a List of Objects to My Favorites
Adding Multiple Objects to a List in a Single Operation
Removing an Object from a List
Adding a Saved Search to My Favorites
Viewing or Editing a Saved Search
Adding an XQuery to My Favorites
Adding a Category List to My Favorites
Adding a Type List to My Favorites
Removing Entries from My Favorites
Renaming an Entry in My Favorites
Working with Notifications
Creating a Notification Request
Creating Notification Requests for Multiple Assets in a Single Operation
Viewing Notifications You Have Received
Deleting a Notification Request
Authentication Topics and LDAP
Overview of Authentication Topics and LDAP
Overview of User Repositories
Selecting a User Repository for Authentication
Domain Names of User Repositories
Default User Repository
Creating Authentication Configurations
Commands for Creating and Maintaining Authentication Configurations
Specifying the Domain Name
Mapping User and Group Fields
Configuring the Internal Authentication Type
General
Administration of Users and Passwords for Internal Authentication
Configuring Active Directory Server
Configuring the LDAP Authentication Type
Principles of Configuring Against LDAP
Performing the LDAP Configuration
Technical Principal for LDAP
Background
Example of Configuring LDAP Authentication
Performing Maintenance on Authentication Configurations
Testing an Existing Authentication Configuration
Editing an Existing Authentication Configuration
Deleting an Existing Authentication Configuration
Setting a New Default Authentication Configuration
Creating an Administration User from the Command Line
Logging of Login Authentication Messages
Purpose of Log Files
Activating the Authentication Logging
Transforming and Migrating Internal and LDAP Configuration Data
Creating a Technical User for Reconfiguring Migrated Configuration
Securing Login Information of a Technical User
Listing Details of SSX-Based Authentication Configuration
Notes on Authentication in CentraSite
Case Sensitivity
Working in an Offline Environment
Users, Groups, Roles, and Permissions
Adding and Managing Users
Required Permissions
Add Users
Add a User and Associate with an External Authentication System Account
Select Users or Groups from the Operating System User Repository
Select Users or Groups from an Active Directory or LDAP Repository
Bulk Load Users from the External Authentication System
Add Users from an External Authentication System from an Organization's Users Tab
Add a User to a Locally Managed Group
Assign Roles to a User
Activate or Deactivate a User
Activate or Deactivate a User from the Users Page
Activate or Deactivate a User from the Edit User Page
Activate or Deactivate Users from the Edit Organization Page
Modify User Information
Reassociate Users
View a User’s Assets
Delete Users Using CentraSite Control
Delete Users from the Command Line
Move Users to a Different Organization
Adding and Managing Groups
Required Permissions
Add a Locally Managed Group
Add an Externally Managed Group
Bulk Load Groups from the External Authentication System
Assign Roles to a Group
Modify a Group
Delete Groups
Managing Roles and Permissions
Set Instance-Level Permissions
Required Permissions to Create and Manage Roles
Create a Custom Role
Modify a Custom or Predefined Role
Delete Custom Roles
Changing Passwords of Predefined Users and Login Users
Change the Password for a Predefined User
Change the Password for a Login User in the Password Store
Changing the SNMP Authentication Settings
AES192 and AES256 Protocol
Importing/Exporting Registry Objects
Introduction
Which Objects Can You Export and Import?
Overview of the Export/Import Process
Exporting an Object
How the Export Process Handles Object Ownership
How the Export Process Handles Instance Level Permissions
Objects That CentraSite Includes When It Exports an Object
Objects That CentraSite Does Not Include When It Exports an Object
Exporting Objects That Use Custom Associations
How the Export Process Handles Supporting Documents
How the Export Process Handles Other Versions of an Object
Exporting Objects Between Different Versions of CentraSite
Importing an Object
Understanding Object Identity
What Happens When an Imported Object Already Exists in the Target Registry?
How the Import Process Assigns the Ownership of an Imported Object
How Referenced Objects Are Handled During Import
How Lifecycle State Is Handled During Import
What Policies Are Triggered During an Import
Promotion
Exporting and Importing Specific Object Types
Organizations
Users
Asset Types and Virtual Types
Taxonomies
Lifecycle Models
Design/Change-Time Policies
Asset Instances
Report Templates
BPM Process Project
Integration Server Assets
Exporting and Importing Objects Using CentraSite Control
Exporting Objects Using CentraSite Control
Importing Objects from an Archive Using CentraSite Control
Hints for Importing
Handling of Missing Required Attributes of Assets When Importing
Exporting and Importing Objects from the Command Line
Exporting Objects from the Command Line
Importing Objects from an Archive Using the Command Line
Importing Objects Using the API
Overview of Importing Objects Using the API
Invoking an Importer from a Java Program
Importing a Web Service
setDescription
setOrganization
setOrganization
setPackageName
setPackageObject
setUsedObject
setUsesObject
setWebDAVFolder
Updating a Registered Web Service
Attaching a WSDL to a Registered Web Service
setAttachServiceID
Removing a Registered Web Service
removeService
removeServices
removeServiceByID
setDeleteTargetAssocs
setRemoveReferencedImports
setRemoveWsdl
Finding a Registered Web Service
findWebServiceByNamespace
findWebServices
Importing a Schema
Removing a Schema
remove
remove
removeCascading
removeCascading
Importing a BPEL Process File
setProjectName
setWarningIfPLTNotFound
Removing a Registered BPEL Object
remove
removeProcess
Importing an XPDL File
setOrganization
SetOriginalFilename
setProductConcept
setVersion
Invoking an Importer from a Java Class
Creating a Script File to Invoke an Importer
Creating a Script File for Windows (a .bat File)
Creating a Script File for UNIX (C-Shell Script)
Importer Class Names
Executing the Script File That Invokes an Importer
Importing a Web Service
Invoking the Web Service Administrator from the Command Line
Importing an XML Schema
Invoking the XML Schema Administrator from the Command Line
Importing an XML Service
Importing a REST Service
Importing a BPEL Process
Invoking the BPEL Administrator from the Command Line
Importing an XPDL File
Invoking an Importer From the Command Line
Importing a Web Service
Importing a REST Service
Importing an XML Schema
Importing a BPEL Process
Importing an XPDL File
Importing an Archive
Invoking an Importer Using the SOAP API
Viewing the WSDL for the Importers
Writing Your Own Importer
The Build Environment
The Plug-In Environment
Propagating the Plug-In
Generating all additionally needed files
Activating the Plug-In
Deactivating the Plug-In
Object Type Management
What Is a Type?
What is a Virtual Type?
The Properties of a Virtual Type
Basic Components of a Type
Attributes
Basic Attributes
Computed Attributes
Attribute Data Types
Attribute Names
Profiles
Generic Profiles
Computed Profiles
Assigning Permissions on Profiles
Who Can Create and Manage Types?
Creating a New Type
Before You Begin
Creating a New Type
Define Attributes for a Type
General Procedure
Using the Dialog
Defining Data Types
Defining a Computed Attribute
Implementation Guidelines for Java-Based Computed Attributes
Structure of Archive File
Sample Code
Loading a Computed Attribute into an Asset Type Definition
Define Profiles for an Asset Type
General Procedure
Defining a Computed Profile for CentraSite Control
Definition of Java-Based Computed Profile
Implementation Guidelines for Java-Based Computed Profiles
Structure of Archive File
Sample Computed Profiles
Load a Computed Profile into an Asset Type Definition
Defining a Computed Profile for CentraSite Business UI
Definition of Java-based Computed Profile
The Build Environment
Implementation Guidelines for Computed Profile
Structure of Archive File
Sample Computed Profile
Loading a Computed Profile into an Asset Type Definition
Viewing or Editing a Type
Before You Begin
How to View or Edit an Asset Type
How to View Multiple Asset Types
Removing an Attribute Using the Command Line Tool
Configuring Inheritance for Base Type Profiles, LCMs, and Policies
Inheriting Base Type Profiles to Sub Types
Cloning Base Type Profiles in Sub Types
Excluding Sub Types From CentraSite Business UI Search
Predefined Asset Types in CentraSite
Predefined Asset Types Installed with CentraSite
Modifications You Can Make to CentraSite's Core Asset Types
Customizing the User and Organization Types
Deleting a Type
Deleting an Asset Type
Deleting Multiple Asset Types in a Single Operation
Managing Asset Types from the Command Line
Creating a New Virtual Asset Type
Creating a New Asset Type
Deleting an Existing Virtual Asset Type
Working with Composite Types
Shared vs Nonshared Components
Required Objects
Collectors
Defining Composite Asset Types
Semantics of Relationships and Operations
Association Relationship
Aggregation Relationship
Composition Relationship
Operation: Deleting an Asset
Operation: Creating a New Version of an Asset
Operation: Exporting an Asset
Operation: Setting Instance Permissions on an Asset
Operation: Moving an Asset to Another Organization
Operation: Changing the Owner of an Asset
Extended Rules
Changing Relationships
Updating Assets
Usage Scenarios
Overview
Delete Usage Scenarios
Association Relationship
Aggregation Relationship with Containing Constraint on Type A
Aggregation Relationship with Containing Constraint on Type B
Composition Relationship with Containing Constraint on Type A
Composition Relationship with Containing Constraint on Type B
Composition Relationship with Permission Scenario
Versioning Usage Scenarios
Versioning of IoB
Versioning of IoA
Permission Usage Scenarios
Association Relationship Permission Propagation
Composition/Aggregation with Weak Propagation
Composition/Aggregation Relationship Updating Sub-component
Composition/Aggregation Relationship with Full Propagation
Export Usage Scenarios
Export with Association Relationship
Export with Composition/Aggregation Relationship
Move Organization Usage Scenarios
Move Organization with Association/Aggregation Relationship
Move Organization with Composition Relationship
Change Ownership Usage Scenarios
Change Ownership with Association/Aggregation Relationship
Propagation of Profile Permissions
Predefined Composite Asset Types
Service
Virtual Service
XML/REST Service
Virtual XML/REST Service
XML Schema
BPEL Process
WS-Policy
BPM Process Project
BPM Process Step
IS Service Interface
Process
Process Pool
Process Swimlane
Web Application
Portlet
CAF Task Type
TN Group
Business Rules Project
Data Model
Working with Association Types
Who Can Create and Manage Association Types?
Adding an Association Type
Editing the Properties of an Association Type
Deleting an Association Type
Deleting a Single Association Type
Deleting Multiple Association Types in a Single Step
Customizing Lifecycle Management
Overview of Customizing Lifecycle Management
Overview of Lifecycle Management
Lifecycle Models
Stages for Lifecycle Registries
Defining a Lifecycle Model in CentraSite
States for Registry Objects
Applying Lifecycle Models to Asset Types
Applying Lifecycle Models to Virtual Types
Who Can Create and Manage Lifecycle Models?
Viewing or Editing a Lifecycle Model
Viewing and/or Editing a Lifecycle Model
Viewing Multiple Asset Types
Creating a Lifecycle Model
Defining the Basic Attributes of the Model
Defining the States and State Transitions of the Model
Associating an Asset Type with the Model
Defining the User and Group Permissions Associated with the States
Defining Policies Associated with the Model
Creating Lifecycle Stages
Defining Stage Transitions
Validating and Saving the Model
Activating a Lifecycle Model
Updating a Lifecycle Model
Deleting a State from a Model
Deleting a Lifecycle Model
Deleting the Most Recent Version of a Lifecycle Model
Deleting a Version and All Older Versions of a Lifecycle Model (Purging)
Deleting Multiple Lifecycle Models in a Single Operation
Lifecycle Model for Lifecycle Models (LCM for LCMs)
The Predefined Lifecycle Models Installed with CentraSite
Taxonomies
Introduction
Who Can Create and Manage Taxonomies?
Visibility of Taxonomies in CentraSite
Creating a Taxonomy
Associating Taxonomy to an Object Type
Setting Permissions on a Taxonomy
Viewing the Taxonomy List
Viewing or Editing the Properties of a Taxonomy
Predefined Taxonomies Installed with CentraSite
Predefined Taxonomies in CentraSite Specific for API Management
Deleting a Taxonomy
Deleting a Single Taxonomy
Deleting Multiple Taxonomies in a Single Operation
Adding a Category
Viewing or Editing the Properties of a Category
Deleting a Category
Logging
Overview of Logging
System-Defined CentraSite Logs
Configuring Logs
Configuring Log Settings from the Command Line
Creating a Configuration File to Define Log Setting
Define a Log Unit
Define Log Settings
Executing the Log Setting Command Tool
Monitoring Logs
Policy Log
Approval History Log
Audit Logs
Run-Time Event Logs
Run-Time Performance Logs
Audit Logs for User Information
Starting the Audit Logs
Storing the Audit Log Data
Overview of Purging
Purging Logs
Purging Log Records Using the Command Line Tool
Creating a Log Purging Configuration File
Define a Log Purge Setting
Define a Log Purge Type
Executing the Log Purging Command Tool
Exporting the Purged Log Records
Exporting the Purged Log Records from the Command Line
Configuring the Purger Properties for High Volume Data Handling
Removing Leftover Auditable Events
Registry Federations in CentraSite
Overview of Registry Federations in CentraSite
Overview of the Federation Process
Creating a Federation Configuration File
Adding a UDDI Federation to the Federation List
Triggering the UDDI Federation
Removing a UDDI Federation from the Federation List
Displaying the List of Target Registries Defined for Federation
Mapping UDDI Object IDs and tModels
Key Generator Processor
Adding a Key Generator Processor for Federation
Removing a Key Generator Processor
Taxonomy Processor
Adding a Taxonomy Processor
Removing a Taxonomy Processor
Users and Access Rights
Suite Usage Aspects
Overview of Suite Usage Aspects
Versioning Assets
Modifying or Deleting Assets
Publishing an Asset
Communication with Designer UI
Remote Connection from Designer
User Accounts
UDDI Clients
Using CentraSite with ARIS
Profile for ARIS Properties
Configuring CentraSite for Use with ARIS
Lifecycle Models That ARIS Uses
BPM Process Lifecycle Model
Service Lifecycle Model
Customizing the Predefined Lifecycle Model for Process Objects
Design/Change-Time Policies That ARIS Uses
Activating the Lifecycle Models and Design/Change-Time Policies That ARIS Uses
Activating the ARIS-Related LCMs and Policies
Configuring the ARIS Change-Notification Policies
Configuring the Enforce Unique Name Policy
Configuring the Reset Lifecycle State to Initial State Policy
Activating the ARIS-Related LCMs and Policies in CentraSite
Activate Policies for ARIS from a Java Class
Activate Policies for ARIS from a Command Line
Creating a Script File for Activating the ARIS LCM and Policies
Provisioning CentraSite Services into ARIS Architect
Object Type Representation for Integration Server Service
Object Type Representation for Web Service
Runtime Governance with CentraSite
Overview of Run-Time Governance
Components of the Run-Time Governance Environment
Run-Time Gateways
Virtualized Services in CentraSite Control
Virtualizing APIs Using the CentraSite Business UI
Run-Time Governance Reference Information
Consumer Applications
Introduction to Consumer Applications
Roles and Permissions Needed to Create and Manage Consumer Applications
Creating and Managing Consumer Applications
Overview
Adding and Managing Consumer Applications Using CentraSite Control UI
Adding a Consumer Application
Modifying Consumer Application Details
Configuring Consumer Application Profiles
The Identification Profile
The Permissions Profile
The Versions Profile
The Subscriptions Profile
The Audit Log Profile
The Object-Specific Properties Profile
Deleting Consumer Applications
Adding and Managing Consumer Applications Using CentraSite Business UI
Creating a Consumer Application
Modifying Consumer Application Details
Configuring Consumer Application Profiles
The Identification Profile
Deleting Consumer Applications
Registering Application Assets as Consumers of an Asset
Deploying or Publishing Consumer Applications to Gateways
Overview
Deploying Consumer Applications Using CentraSite Control UI
Publishing Consumer Applications Using CentraSite Business UI
Publishing Consumer Applications from the Search Results Page
Publishing a Consumer Application from the Actions Bar
Deploying Consumer Applications from the Command Line
Write a Script File to Invoke Deployment Operation (for Windows)
Write a Script File to Invoke Deployment Operation (for UNIX)
Synchronizing Consumer Applications in Mediator from the Command Line
Viewing the Deployment History Log Using CentraSite Control UI
Consumer Registrations
Introduction to Consumer Registration
Scope of Consumer Registration at Design-Time
Scope of Consumer Registration at Run-Time
The Concept of Registering a Consumer for an Asset
Permissions Needed to Register Consumers
The Design/Change-Time Policy Used for Consumer Registration
Implementing Consumer Registration
Overview
Design-Time Consumer Registration Scenario
Run-Time Consumer Registration Scenarios
Scenario A: Virtual Service without API Consumption Settings and Evaluate Policy Actions
Scenario B: Virtual Service without API Consumption Settings and with Evaluate Policy Actions
Scenario C: Virtual Service with API Consumption Settings and without Evaluate Policy Action
Scenario D: Virtual Service with API Consumption Settings and Evaluate Policy Action
Viewing Consumer Registration Requests
Monitoring Consumer Count of an Asset
Viewing or Modifying Details of a Consumer
Unregistering an Existing Consumer
Unregistering an Existing Consumer from the Consumed Asset Details Page
Unregistering an Existing Consumer from the Consumer Asset Details Page
Run-Time Gateways
Introduction to Gateways
Who Can Create and Manage Gateways?
Creating and Managing Gateways
Overview
Creating a Gateway Asset
Configuring Gateway Details
Deleting a Gateway Instance
Virtualized Services in CentraSite
Introduction to Virtualized Services
The Predefined Asset Types Installed with CentraSite for Virtualization
Who Can Create and Manage Virtual Services?
Creating Virtual Services
Creating a Virtual Service from Scratch
Virtualizing an Existing Service
Configuring SOAP-based Virtual Services
The Entry Protocol Step (SOAP)
The Request Processing Step (SOAP)
The Response Processing Step (SOAP)
The Routing Protocols Step (SOAP)
“Straight Through” Routing (SOAP)
“Content-based” Routing (SOAP)
Creating a Routing Rule for “Content-based” Routing (SOAP)
“Context-based” Routing (SOAP)
Creating a Routing Rule for “Context-based” Routing (SOAP)
“Load Balancing” Routing (SOAP)
The Routing Protocol for Services Exposed over JMS (SOAP)
Viewing REST/XML-based Virtual Services
The Entry Protocol Step (REST/XML)
The Request Processing Step (REST/XML)
The Response Processing Step (REST/XML)
The Routing Protocols Step (REST/XML)
The “Straight Through” Routing Protocol Step (REST/XML)
The “Content-based” Routing Protocol Step (REST or XML)
The “Context-based” Routing Protocol Step (REST or XML)
The “Load Balancing” Routing Protocol Step (REST or XML)
Viewing or Editing Virtualized Services
The Summary Profile
The Technical Details Profile
The Specification Profile
The Consumers Profile
The Permissions Profile
The Policies Profile
The Deployment Profile
The Performance Profile
The Events Profile
Revising Virtualized Services
Creating Run-Time Policies
Actions that Run-Time Policies can Execute
Who Can Create and Manage Run-Time Policies?
Creating a Run-Time Policy
Setting Permissions on a Run-Time Policy
Who Can Set Permissions on a Run-Time Policy?
Assigning Permissions to a Run-Time Policy
Activating a Run-Time Policy
Deactivating a Run-Time Policy
Viewing the Run-Time Policy List
Modifying a Run-Time Policy
Viewing or Changing a Run-Time Policy
Modifying Actions for a Run-Time Policy
Modifying the Actions List
Modifying Action Parameters
Modifying the Scope of a Run-Time Action
Viewing the List of Services To Which a Run-Time Policy Applies
Deleting a Run-Time Policy
System-Assigned vs. User-Assigned Version Identifiers
Asymmetric Binding Configuration
Asymmetric Binding
The Asymmetric Binding Components
Initiator Token Inclusion
Recipient Token Inclusion
Algorithm Suite
Layout
The Asymmetric Binding Configuration Command Tool
get Asymmetric Binding
set Asymmetric Binding
remove Asymmetric Binding
Deploying and Undeploying Virtualized Services to Targets
The Synchronous Deployment Model
Who Can Deploy Virtualized Services to Targets?
Conditions that Must be Satisfied for Effective Deployment of Virtualized Services
What Happens When You Deploy a Virtualized Service?
Deploying, Undeploying, and Redeploying Virtualized Services
Deploying Virtualized Services from a Service's Detail Page
Deploying Virtualized Services from the Operations > Deployment Page
Selecting a Target and Services to be Deployed on the Selected Target
Using a Keyword Search to Select a Target or Service to Deploy
Using a Advanced Search to Select a Target or Service to Deploy
Deploying Virtualized Services Using Command Line Tool
Deploy a Virtualized Service to Mediator
Undeploy a Virtualized Service from Mediator
Deploy, Undeploy or Redeploy Multiple Virtualized Services in Mediator
Configuring API Key Header Using Command Line Tool
Deploying Virtualized Services Using a Batch Process
Viewing the Deployment History Log
Deleting a Deployment Activity Log
Performing a Delete Operation Using the Deployed Assets Tab
Performing a Delete Operation Using the Deployment History Tab
Securing Communications with for Synchronous Deployment
Anatomy of a SSL Connection
SSL Connection Type
As an SSL Client
As an SSL Server
Roadmap for Configuring SSL
Creating Keys and Certificates
Creating a Keystore and Truststore
Obtaining the Certificates and Keys of the webMethods Mediator
Keystores and Truststores
Keystore File
Truststore File
How Uses a Keystore and Truststore
Protecting Keystore and Truststore Files
Configuring CentraSite to Use SSL
Configure CentraSite Client to Use One-way SSL
Configure CentraSite Client to Use Two-way SSL
Using the CTP Server.xml File for SSL
Configuring webMethods Integration Server to Use SSL
Configure Integration Server to Use One-way SSL
Configure Integration Server to Use Two-way SSL
Configuring webMethods Mediator to Use SSL
Virtualized APIs in CentraSite Business UI
Introduction to Virtualized APIs
Roles and Permissions Needed to Create and Manage Virtualized APIs
Preparing to Virtualize and Publish the Virtualized APIs
Run-Time Components of Virtualized API
Creating Virtualized APIs
Before You Begin
Ways in Which You Can Create Virtualized APIs
Creating a Virtualized API from an Existing Native API
Creating a Virtual SOAP API
Add a Virtual SOAP API
Assign Run-Time Actions for the Virtual SOAP API
Implement Virtualization and Publish the Virtual SOAP API to Gateways
Creating a Virtual REST API
Add a Virtual REST API
Assign Run-Time Actions for the Virtual REST API
Implement Virtualization and Publish the Virtual REST API to Gateways
Creating a Virtualized API from Scratch
Creating a Virtual SOAP API
Add a Virtual SOAP API
Upload an Input File
Assign Run-Time Actions to the Virtual SOAP API
Publish the Virtual SOAP API to Gateways
Creating a Virtual REST API
Add a Virtual REST API
Add Resources and Methods
Assign Run-Time Actions to the Virtual REST API
Publish the Virtual REST API to Gateways
Reconfiguring a Virtualized API
Ways in Which You Can Reconfigure Virtualized APIs
Reconfiguring a Virtualized API from the Native API Details Page
Reconfiguring a Virtualized API from the Virtualized API Details Page
Resource Synchronization in Virtual REST APIs
Resource Synchronization Usage Scenarios
Edit Resource Usage Scenario
Add Resource Usage Scenario
Delete Resource Usage Scenario
Combination of Usage Scenarios
Versioning Virtual API or Service
Creating a Version for Virtual API or Service
Publishing a Versioned Virtual API or Service
Runtime Versioning Support in Mediator
Viewing or Changing a Virtualized API
Viewing the Virtualized API Specific Profiles
Identification Profile
API Key Identification Profile
API Key Scope Profile
OAuth2 Identification Details Profile
Assigning Run-Time Actions to a Virtualized API
Before You Begin
Ways in Which You Assign Run-Time Actions to Virtualized APIs
Modifying the Action List
Configuring Policy Action Parameters
Publishing and Unpublishing APIs to and from Gateways
The Process of Publishing an API to Mediator
The Process of Publishing an API to API-Portal
Roles and Permissions Needed to Publish and Unpublish APIs
Important Considerations When Publishing an API
Use Cases for Publishing an API
Use Case A: Publish an API From the Native API Details Page
Use Case B: Publish an API From the Virtualized API Details Page
Use Case C: Publish an API from the Search Results Page
Publishing API(s) to Gateway(s)
Publishing an Individual API from the Native API Details Page
Publishing an Individual API from the Virtualized API Details Page
Publishing Multiple APIs from the Search Results Page
Unpublishing API(s) from Gateway(s)
Unpublishing an Individual API from the Native API Details Page
Unpublishing an Individual API from the Virtualized API Details Page
Unpublishing Multiple APIs from the Search Results Page
Exposing a Virtual SOAP API as Virtual REST API
Displaying Runtime Information for a Virtualized API
The Runtime Metrics
Displaying the Runtime Metrics
The Runtime Events
Displaying the Runtime Events
Obtaining Your API Keys and Access Tokens for Consumption
Fetching and Using Your API Keys for Consumption
The API Consumption Model
How Does Mediator Evaluate Consumers at Run Time?
How Does a Consumer Use the Generated API Key?
Request Header
Query String
What Happens When You Request for API Consumption?
What Happens When Consumption Fails?
Fetching and Using Your OAuth2 Access Tokens for Consumption
Ways for Clients to Provide the Inputs
Using HTTPS for Granting Access Tokens
Responses Returned to Clients
Managing Your API Keys
Fetching Details of Your API Keys
Viewing Details of an API Key Using the Email Notification
Viewing Details of an API Key Using the API Details Page
Viewing Details of an API Key Using the User Preferences
Renewing Your API Key
Revoking Your API Key
Deleting Your API Key
Deleting an Individual API key
Deleting Multiple API Keys in a Single Operation
Privileged User of a Virtualized API
Invoking webMethods IS Services in Virtual Services
Introduction
Using the Security API in webMethods IS Services
pub.mediator.security.ws:AddUsernameToken
pub.mediator.security.ws:AddX509Token
pub.mediator.security.ws:AddSamlSenderVouchesToken
pub.mediator.security.ws:AddTimestamp
pub.mediator.addressing:AddWSAddressingHeaders
Using Context Variables in Virtual Services
Introduction to Context Variables in Virtual Services
The Predefined Context Variables
The API for Context Variables
pub.mediator.ctxvar:getContextVariable
pub.mediator.ctxvar:setContextVariable
pub.mediator.ctxvar:declareContextVariable
pub.mediator.ctxvar:removeContextVariable
Sample Flow Service: Getting a Context Variable Value
Sample Flow Service: Setting a Context Variable Value
Important Considerations when Configuring SOAP-based Virtual Services
Handling Services with Multiple Ports and Bindings
Workaround Option 1
Workaround Option 2
Important Considerations when Configuring REST or XML Virtual Services
Introduction
Endpoint Manipulation of REST or XML Virtual Services
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
The Request Message’s HTTP Methods and Content-Types for REST and XML Services
Changing the HTTP Method of a REST or XML Request
The Implications of Changing HTTP Methods
Changing HTTP Methods in Requests Dynamically using a Context Variable
Sample XSLT Transformation for GET-to-POST or GET-to-PUT
Working with the JSON Content-Type
How Mediator Determines Which Builder and Formatter Classes to Use (and How You Can Override Them)
Scenarios for Requesting JSON Type Services
JSON Example 1: GET Request, JSON Response
JSON Example 2: POST/JSON Request, JSON Response (where POST is not supported)
JSON Example 3: GET Request, XML Response
Characteristics of the Mapped and Badgerfish JSON Conventions
Mapped JSON Convention
Badgerfish Convention
Multiple Root Nodes in JSON REST Services
Handling Virtual REST APIs with Multiple Resources
Scenario A
Scenario B
Straight-Through Routing Action
Workaround Option 1:
Workaround Option 2:
Content-Based Routing Action
Context-Based Routing Action
Run-Time Governance Reference
Run-Time Events and Key Performance Indicator (KPI) Metrics
The Run-Time Event Types
The Key Performance Indicator (KPI) Metrics
The Event Notification Destinations
Destinations for the Monitoring and Transaction Events
SMTP Email Servers
The Integration Server's Local Log
The Integration Server's Audit Log
The Metrics Tracking Interval
Configuring CentraSite to Receive Run-Time Events and Metrics
Components of the Event Receiver
Configuring the Event Receiver
Setting the Database Configuration Properties
Setting the SNMPv3 Transport Configuration Properties
Setting the SNMPv3 USM Configuration Properties
Setting the Events Queue Implementation Property
Setting the Properties for FileSystem or InMemory
Event Type Modeling
The “Target Type to Event Type Association” Object
Event Modeling
Viewing Run-Time Events and Metrics
Viewing Run-Time Events and Metrics for Targets
Viewing Run-Time Events and Metrics for Virtual Services
Viewing Run-Time Events and Metrics for APIs
Creating Custom Run-Time Events
Modifying Run-Time Events
Built-In Run-Time Actions Reference for Virtual Services
Summary of the Run-Time Actions for Virtual Services
WS-SecurityPolicy 1.2 Actions
Authentication Actions (WS-SecurityPolicy 1.2)
XML Security Actions (WS-SecurityPolicy 1.2)
Monitoring Actions
Additional Actions
Configuring Destinations for Alerts and Logs
The watt.server.auth.skipForMediator Property
Action Evaluation Order and Dependencies
Effective Policies
Usage Cases for Identifying/Authenticating Consumers
Run-Time Actions Reference for Virtual Services
Authorize Against Registered Consumers
Authorize User
Identify Consumer
Log Invocation
Monitor Service Performance
Monitor Service Level Agreement
Require Encryption
Require HTTP Basic Authentication
Require Signing
Require SSL
Require Timestamps
Require WSS SAML Token
Require WSS Username Token
Require WSS X.509 Token
Throttling Traffic Optimization
Validate Schema
Built-In Run-Time Actions Reference for APIs
Summary of the Run-Time Actions
Request Handling Actions
Policy Enforcement Actions
Authentication Actions
JMS Routing Actions
Logging and Monitoring Actions
Routing Actions
Security Actions
Traffic Management Action
Validation Action
Response Handling Actions
Error Handling Action
The watt.server.auth.skipForMediator Property
Effective Policies
Usage Cases for Identifying/Authenticating Clients
Run-Time Actions Reference
Content Based Routing
Context Based Routing
Conditional Error Processing
Failure Messages
Enable REST Support
Evaluate Client Certificate for SSL Connectivity
Evaluate Hostname
Evaluate HTTP Basic Authentication
Evaluate IP Address
Evaluate Kerberos Token
Evaluate OAuth2 Token
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
Set Custom Headers
Set JMS Headers
Set Media Type
Set Message Properties
Straight Through Routing
Throttling Traffic Optimization
Service Result Cache
Validate Schema
Computed Runtime Actions
Writing Your Own Computed Runtime Action
The Build Environment
Implementation Guidelines for Computed Runtime Action
Implementation for Computed Action UI
Implementation for Computed Action Parser
Setting up the Computed Action Plug-in
Activating the Computed Action
Sample Computed Runtime Action
CentraSite User’s Guide
Using the Asset Catalog
Introduction
What an Asset Catalog Contains
Browsing
Searching Using a Keyword
Searching Using an Advanced Search
Who Can View the Asset Catalog?
What a Catalog Entry Contains
Attributes
Extended Attributes
Attribute Data Types
Browsing the Asset Catalog
Browsing by Name
Using Keywords
Using Wildcards
Browse by Asset Name
Browsing by Asset Type
Browsing by Taxonomy
Searching the Asset Catalog
Keyword Search
Using Search Metacharacters in the Keyword Search
Using Keywords
Using Wildcards
Performing a Keyword Search
Advanced Search
Searching by Asset Type
Searching by Attribute Values
Searchable Attributes
Generic Attributes
Type-Specific Attributes
Combining Search Criteria
Performing an XQuery Search
Using the Search Result List
Saving and Re-Executing Searches
Saving a Search Definition
Re-executing a Saved Search
Creating New Search
Viewing Details for an Asset
Before You Begin
Viewing Details of a Single Asset
Viewing Details of Multiple Assets
Displaying Run-Time Information for Assets
Displaying Performance Metrics
Displaying Event Information
Displaying Policy Information
Impact Analysis
Overview of Impact Analysis
Graphical Visualization
Configuration Settings
Built-In Filter Configurations
Custom Filter Configurations
Deleting a Filter Configuration
Zooming the Display
Printing the Graphical Impact Analysis
Full-Screen Display
Tabular Visualization
Publishing a New Asset into the Catalog
Ways in Which You Can Publish an Asset
Who Can Publish Assets to the Catalog?
Who Can Access the Assets that You Publish?
Adding an Asset to the Catalog Using an Importer
Overview
Importing Web Services (including Abstract Services)
General
Registry and Repository Entries for a Web Service
Importing Abstract Services
Permissions Required for Performing the Import
How to Import a Web Service
Restrictions for Abstract Services
Importing XML Schemas
Importing BPEL Files
Importing XPDL Files
What Happens When You Import an XPDL File?
The Lifecycle Model for a Process Object
How to Import an XPDL File
Importing Archived Assets
Adding an Asset to the Catalog From Scratch
Creating an Application Asset
Editing an Asset in the Catalog
Before You Begin
Editing the Attributes of an Asset
Attaching a Schema File to an XML Schema Asset
General
Restrictions
Changing an Entire Schema Graph
Attaching a Supporting Document to an Asset
Attaching Documents from a URL or the Supporting Document Library
Attaching a Document Using a URL
Attaching a Document from the Supporting Document Library
Removing a Supporting Document From an Asset
Changing the Lifecycle State of an Asset
Changing the Lifecycle State of an Single Asset
Changing the Lifecycle State of Multiple Assets in a Single Operation
Setting Permissions on an Asset
Who Can Set Permissions on an Asset?
Restricting Access to Specific Profiles
Ways in Which You Can Set Permissions
Assigning Permissions Using the User Interface
Setting Instance Level Permissions on an Asset
Setting Instance Level Profile Permissions on an Asset
Propagation of Permissions
Versioning an Asset
Generating New Asset Versions
Creating a New Version of an Asset
Creating a New Version for a Set of Assets
Locating Other Versions of an Asset in the Catalog
Purging Older Versions
Considerations for Asset Types of the Suite
Working with Asset Revisions
Introduction
Visualization of Revisions
Purging Old Revisions
Reverting to an Older Revision
Switching Revision Processing On
Switching Revision Processing Off
Checking the Current State of Revision Processing
Changing the Ownership of an Asset
User Ownership
Organizational Ownership
Who Can Change Ownership of an Asset?
Conditions that Must be Satisfied in Order to Change Ownership of an Asset
What Happens During a Change of Ownership?
Effect of an Ownership Change on Permission Assignments
Policies that are Triggered During an Ownership Change
Effect of an Ownership Change on Objects Associated with the Asset
Effect of an Ownership Change on Other Versions of the Asset
Effect of an Ownership Change on the Asset's Lifecycle State
How to Change Ownership of an Asset
How to Change User Ownership of an Individual Asset?
How to Change User Ownership of Multiple Assets (Bulk Transfer)
How to Change the Organization of an Individual Asset
How to Change the Organization of Multiple Assets (Bulk Transfer)
Deleting an Asset
Before You Begin
Deleting a Single Asset
Deleting Multiple Assets in a Single Operation
Working with Supporting Documents
Who Can Manage the Supporting Document Library?
Document Folders
Creating a Folder in the Supporting Document Library
Deleting a Folder in the Supporting Document Library
Adding Documents to the Supporting Document Library
Viewing Details of a Supporting Document
Replacing Documents in the Supporting Document Library
Moving a Document to Another Folder
Renaming a Document in the Supporting Document Library
How to Determine Which Assets Refer to a Document
Deleting Documents from the Supporting Document Library
Downloading an Asset
Before You Begin
Performing the Zip Download
Structure of the Zip File
Performing the Single Document Download
Downloading Documents Directly From the Supporting Document Library
Downloading an Attached Document from the Supporting Document Library
Downloading a WSDL Document from a Service or an XSD Document from a Schema
Working with Design/Change-Time Policies
Overview
Functional Scope
Introduction
Objects on Which Design/Change-Time Policies Can Operate
Applying Policies to Assets
Applying Policies to Virtual Types
Events during Which Design/Change-Time Policies Can Be Enforced
Supported Object and Event Combinations
Actions that Design/Change-Time Policies Can Execute
Built-In Actions
Custom Actions
What Happens at Enforcement Time?
What Happens if an Event Triggers Multiple Policies?
What Happens When an Action Fails?
Predefined Policies Used by CentraSite
Who Can Create and Manage Policies?
Adding a Design/Change-Time Policy to CentraSite
Creating a New Design/Change-Time Policy
Activating a Design/Change-Time Policy
Deactivating a Design/Change-Time Policy
Viewing the Policy List
Viewing or Changing a Policy
Viewing or Editing the Properties of a Policy
Viewing the Details Page of Multiple Policies
Specifying the Scope of a Design/Change-Time Policy
System-Wide versus Organization-Specific Policy Enforcement
Organization-Specific Policies
System-Wide Policies
Modifying the Scope of a Design/Change-Time Policy
Refining the Object Scope
Configuring 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 on a Design/Change-Time Policy
Using a Design/Change-Time Policy to Set Permissions
Setting Permissions Using the Permission Tab in CentraSite Control
Running Policies on Demand
Who Can Run a Policy on Demand?
To Which Objects Is the Policy Applied?
What Happens When the Policy is Executed?
Running a Policy on Demand
Deleting a Policy
Deleting a Single Policy
Deleting Multiple Policies in a Single Operation
Copying a Policy
Versioning a Policy
System-Assigned vs User-Assigned Version Identifiers
Viewing the Policy Log
Viewing Failed Policies From Your Inbox
Exporting and Importing Design/Change-Time Policies
Exporting Design/Change-Time Policies
Importing Design/Change-Time Policies
Customizing the Predefined Lifecycle Model for Policies
Using Approval Policies
About Approval Policies
The Approval Actions
What Happens When an Approval Action Is Enforced?
Auto-Approval
Approval Modes
What Types of Events and Objects Can Be Approved?
Using the Initiate Approval Action
Using the Initiate Group-Dependent Approval Action
Switching the State of an Object when an Approval Request is Rejected
Adding an Approval Policy
Including Multiple Actions in an Approval Policy
Using Approvals with PreStateChange Events
Using Approvals with OnConsumerRegistration Events
Using Approvals with OnTrigger Events
Approver Groups
Changing the Membership of an Approver Group
Reviewing Requests that You Have 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
Working with Email Notifications
Setting the Email-Related Parameters in an Email Notification Action
Using a Custom Message in an Email Notification Action
Example of a Plain Text Message
Example of an HTML Message
Using Email Templates with Policy Actions
Creating a Custom Email Template
Example of an Email Template
Adding an Email Template to CentraSite
From a Java Class
From a Command Line
Viewing the List of Email Templates on CentraSite
From a Java Class
From a Command Line
Updating an Existing Email Template on CentraSite
Downloading an Email Template from CentraSite
From a Java Class
From a Command Line
Deleting an Email Template from CentraSite
From a Java Class
From a Command Line
Creating a Script File for the EmailTemplateManager Utility
Creating a Script File for Windows (a .bat file)
Creating a Script File for Unix (C-shell script)
Executing the EmailTemplateManager Script File
Using the -dburl Input Parameter
Predefined Email Templates Installed with CentraSite
Working with Predefined Policies
Collector and Handler Policies
What Are the Roles of the Collector and Handler Policies?
How Collectors and Handlers are Associated with a Type
The Collector and Handler Policies Provided with CentraSite
The Default Collector and Handler Policies
Specialized Collector and Handler Policies for Assets
Specialized Collector and Handler Policies for Other Registry Objects
The Default Collector
How the Collector Locates the Components that are Associated with a Composite Object
How the Default Collector Determines whether a Component is Shared or Nonshared
How the Default Collector Locates the Required Objects that are Associated with a Composite Object
Working with the Default Collector
The Default Delete Handler
The Default Move Handler
The Default Export Handler
Working with Reports and Report Templates
Introduction
About Report Templates
Global Report Templates
Custom Report Templates
API Usage Specific Report Templates
Who Can Create and Manage Report Templates?
Adding a Custom Report Template
Creating a New RPTDESIGN Template File
Creating a New Report Template
Associating a Report Template with an Object Type
Setting Permissions on a Report Template
Viewing the Report Templates List
Viewing the Report Templates List from Control UI
Viewing the Report Templates List from Business UI
Viewing or Editing the Properties of a Report Template
Deleting a Report Template
Objects for Which You Can Generate Reports
Who Can Generate and Schedule Reports?
About Report Parameters
Generating a Report
Generate Report from the Activity Bar
Generate Report from the Asset Details Page
Downloading Reports
Sharing Reports with API-Portal
Scheduling Reports
Scheduling a Report from the CentraSite Business UI
Managing Your Scheduled Reports
Displaying a List of Your Scheduled Reports
Modifying an Existing Scheduled Report
Deleting an Existing Scheduled Report
Changing the Default Report Scheduler
Working with the CentraSite Business UI
API Management Solutions
Overview
CentraSite and API Management
Why Do APIs Need to Be Managed?
The webMethods API Management Product Suite
Getting Started with API Management
Creating an API
Viewing the API List
Viewing Details for an API
Summary of Profiles in the API
Summary of Actions in the API
Editing the Properties of an API
Setting Permissions on an API
Who Can Set Permissions on an API?
Setting Instance Level Permissions on an API
Setting Instance Level Profile Permissions on an API
Configuring the API Consumption Settings
Roles and Permissions Needed to Configure API Consumption Settings
Configuring the API Consumption Settings for API Key Authentication
Configuring the API Consumption Settings for OAuth2 Authentication
Managing API Keys and OAuth 2.0 Tokens
Roles and Permissions Needed to Manage Access Keys and Tokens
Satisfying Key and OAuth Token Generation Requirements
Configuring the Email Templates for API Key or OAuth Token Generation
Renewing an API Key
Changing the Default Key Expiration Interval
Configuring the Email Templates for Key Expiration
Configuring the Email Templates for Key Renewal
Revoking an API Key
Revoking an API Key by an API Provider
Revoking an API Key by an API Consumer
Using Custom Email Templates for API Key Revocation
Deleting an API Key
Deleting a Single API Key
Deleting a Set of API Keys
Revoking an OAuth2 Client
Revoking an OAuth2 Client by an API Provider
Revoking an OAuth2 Client by an API Consumer
Using Custom Email Templates for OAuth2 Client Revocation
Approving a Request
Approving Requests for Consumer Onboarding Registration
Approving Requests for Access Key Management
Deleting an API
Deleting a Single API
Deleting a Set of APIs
Exporting and Importing an API
Before You Begin
Exporting an API
Exporting Multiple APIs in a Single Operation
Importing APIs
Email Notification Templates and Tokens
Predefined Email Templates Installed with CentraSite
Customizing Email Templates
Writing a Custom Email Template
Using Substitution Tokens
Predefined Policies for API Management
The User Registration Policies
Global New User Account Policy
New User Account Policy
The Consumer Onboarding Policies
Global Consumer Onboarding Policy
Consumer Onboarding Policy
The API Key Management Policies
API Key Generation Policy
API Key Renewal Policy
API Key Revocation Policy
The OAuth2 Client Management Policies
OAuth2 Client Generation Policy
OAuth2 Client Revocation Policy
The API-Portal Integration Policies
Publish to API-Portal Policy
Unpublish from API-Portal Policy
Administering the Business UI
Overview
Conceptual Overview of the CentraSite Business UI
Working with the CentraSite Business UI
About CentraSite Business UI
Starting the Graphical User Interface
Using URL to Start the Graphical User Interface
Alternative Procedures on Windows
Logging In and Out
Your First Logon after Installation
Logging in into Business UI
How to Log in to CentraSite Business UI as Registered User
How to Log in to CentraSite Business UI as Guest User
How to Log in to CentraSite Business UI as Registered User
Resetting your Password
Creating your New Account in CentraSite
Take a Tour through
Logging out from Business UI
Starting CentraSite Business UI
The Navigation Controls in the User Interface
Configuring the Enhanced Profile Layout for Rendering Details of Registry Objects
What is the Enhanced Profile Layout?
What is the Legacy Profile Layout?
Where is the Enhanced Profile Layout Used?
Configuring the Enhanced Profile Layout
Managing Your Profile
About Profiles
Viewing Your Profile
Editing Your Profile
Uploading and Updating Your Personal Profile Picture
Managing Your User Preferences
Setting Notification Options
Setting Display Options
Managing Your API Keys / OAuth2 Tokens
Viewing Your List of API Keys / OAuth2 Tokens
Renewing an API Key / OAuth2 Token
Deleting an API Key / OAuth2 Token
Setting Saved Searches Preferences
Viewing Your List of Saved Searches
Adding a Search to Saved Searches
Modifying a Search in Saved Searches
Renaming a Search in Saved Searches
Removing a Search from Saved Searches
Managing Your List of My Favorites
Viewing Your List of My Favorites
Adding an Asset to the My Favorites List
Adding Multiple Assets to the My Favorites List
Removing an Asset from the My Favorites List
Removing an Asset from the My Favorites List via Asset Details Page
Removing Multiple Assets from the My Favorites List
Renaming an Entry in the My Favorites List
Deleting an Entry from the My Favorites List
Managing Your Portlets
Viewing Your List of Portlets
Renaming a Portlet
Deleting a Portlet
Managing Your Inbox
Overview
Using the Inbox
How to Access Your Inbox
Creating a Notification Request
How to Create Notification Request for an Asset
How to Create Notification Request for Multiple Assets
Viewing Notifications You Have Received
Deleting a Notification Request
How to Delete Notification Request for an Asset
How to Delete Notification Request for Multiple Assets
Removing Notifications from Your Inbox
Using Refiners in Your Inbox
Using the Help Center
Access Business UI Help Center
What You Will Find in the Help Center
Introduction
All about Assets
Using Keyword Searching
Browsing the Catalog
Managing the Catalog
Collaborating on Assets
Working with Notifications
Customizing your Welcome Page
Updating Your User Profile
Further Resources
Customizing CentraSite i18n Messages
Understanding Message Bundles
Customizing i18n Messages
Fetching a Message Key
Changing a Message Value
Working with Organizations, Users, Groups and Roles
Working with Organizations
Introduction
Displaying a List of Your Organizations
Adding an Organization
Viewing or Modifying Details of an Organization
Deleting an Organization
Working with Child Organizations
Add a Child Organization
View or Modify a Child Organization
Delete a Child Organization
Operations on Users, Groups and Roles at the Organization level
Working with Users
Adding a User to an Organization
Viewing or Modifying Details of a User
Adding a User to a Group from the User Details View
Deleting a User from a Group from the User Details View
Deleting a User
Viewing or Deleting Assets of a User
View Assets of a User
Delete Asset Belonging to a User
Working with Groups
Adding a Group to an Organization
Viewing or Modifying Details of a Group
Adding a User to a Group from the Group Details View
Deleting a User from a Group from the Group Details View
Modifying or Deleting Groups
Working with Roles
Adding a Role to an Organization
Viewing or Modifying Details of a Role
Assigning a Role to a User or Group
Deleting Role Assignments from a User or Group
Delete a Role from the Set of Roles Assigned to a User or Group
Remove a User or Group from the Set of Users and Groups Assigned to a Role
Modifying a Role's Permissions
Assign Permission to a Role
Remove Permission from a Role
Deleting a Role from an Organization
Exporting and Importing Registry Objects Using Business UI
Introduction
Which Objects Can You Export and Import?
An Overview of the Export/Import Process
Exporting an Object
Importing an Object
Exporting and Importing Specific Object Types
Organizations
Asset Instances
Exporting Objects Using CentraSite Business UI
Importing Objects from an Archive Using CentraSite Business UI
Managing Assets
Introduction
Displaying Details of an Asset
Before You Begin
Viewing the Details of an Asset
Creating a New Asset in the Catalog
Who Can Create Asset to the Catalog?
Who Can Access the Assets that You Create?
Adding an Asset to the Catalog
Editing the Properties of an Asset
General
How to Edit the Attributes of an Asset
Viewing a List of Your Assets
Watching and Unwatching an Asset
Introduction
Watching an Asset
How to Watch an Asset
How to Unwatch an Asset
Watching or Unwatching a Set of Assets
How to Watch a Set of Assets
How to Unwatch a Set of Assets
Viewing the List of Watchers for Your Asset
Attaching a Document to an Asset
Overview
Attaching an Input File to an Asset
Attaching a WSDL File to a Service Asset
General
Restrictions
Attaching a Supporting Document to an Asset
Attaching Documents from a URL
Attaching Documents from the Computer's File System
Attaching Documents from the Supporting Document Library
Removing a Supporting Document from an Asset
Changing the Lifecycle State of an Asset
Introduction
Lifecycle Management
Who Can Change Lifecycle State of an Asset?
How to Change Lifecycle State of an Asset
Setting Permissions on an Asset
Who Can Set Permissions on an Asset?
Restricting Access to Specific Profiles
Ways in Which You Can Set Permissions
Setting Instance Level Permissions on an Asset
Selecting Users or Groups Using Search Option
Selecting Users or Groups Using Browse Option
Setting Instance Level Profile Permissions on an Asset’s Profile
Propagation of Permissions
Propagation of Instance Level Permissions
Propagation of Profile Level Permissions
Versioning an Asset
Generating New Asset Versions
Creating a New Version of an Asset
Creating a New Version of a Set of Assets
Locating Other Versions of an Asset
Changing the Ownership of an Asset
Introduction
User Ownership
Organizational Ownership
Who Can Change Ownership of an Asset?
Conditions that Must be Satisfied in Order to Change Ownership of an Asset
How to Change Ownership of an Asset
How to Change User Ownership of an Asset
How to Change the Organization of an Asset
Displaying Runtime Information for an Asset
The Runtime Metrics
Displaying the Runtime Metrics
The Runtime Events
Displaying the Runtime Events
Deleting an Asset
General
Deleting Assets
Deleting Assets
Deleting a Set of Assets
Downloading an Asset
Before You Begin
Performing the Zip Download
Downloading an Asset
Downloading a Set of Assets
Structure of the Zip File
Performing the Single Document Download
How to download a attached document from Supporting Document Library
How to download a WSDL / XSD document from Service/Schema
How to download a XSD document from REST / XML services
Exporting and Importing Assets
Before You Begin
Exporting Assets
Exporting a Single Asset
Exporting Multiple Assets in a Single Operation
Importing Assets
Managing the Catalog
About the Catalog
What does the Catalog Contain?
Who Can View the Catalog?
Browsing the Catalog
Performing a Quick Find by Browse
Searching the Catalog
Simple Search
Using Search Metacharacters in the Simple Search
Using Keywords
Using Wildcards
Performing a Simple Search
Advanced Search
Search by Keyword
Using Keywords
Search by Keyword
Search by Taxonomy
Search by Lifecycle Model
Search by Asset Type
Search by Attribute Values
Searchable Attributes
Generic Attributes
Type-Specific Attributes
Attribute Data Types
Configuring CentraSite's Expandable Property
Using the Search Result List
Managing the Search Results Page
Configuring the Search Results Page
Managing the Search Recipe
Search Filters
Defining a Search Recipe
Adding a Search Filter to the Recipe
Removing a Search Filter from the Recipe
Combining Search Filters
Rendering of Search Scopes
Saving and Re-Executing Saved Searches
Saving a Search Definition
Re-executing a Saved Search
Creating a New Search from a Saved Search
Adding a Custom Reporting Search from the Command Line
Writing Your Own Reporting Search
Writing an XQuery Module
Writing a Saved Search XML
Uploading Required Search Files from the Command Line
Activating the Reporting Search
Working with Approval Workflows
Predefined Approval Policies for CentraSite Business UI
What Happens When an Approval Action is Enforced?
Adding an Approval Policy to CentraSite
Reviewing Requests that You Have Submitted for Approval
Approving a Request
Approving a Pending Approval Request by a CentraSite Administrator
Reverting the State of an Asset That is Pending Approval
Message Handling and Diagnostics
Presenting Error Messages in CentraSite Business UI
Setting the Diagnostic Email Notification Configurations
Substitution Tokens
Using a Custom Message in Diagnostic Email Notification
Using Diagnostic Email Templates
Creating a Custom Email Template
Adding an Email Template to CentraSite
Working with Portlets
Portlet Types
Text Portlet
IFrame Portlet
Graphical Portlet
Tailor Your Portlets
Portlet Quick Facts and Links
Viewing Your Portlets
Adding a Portlet
Adding an Existing Portlet
Adding a New Portlet
Creating a Text Portlet
Creating an IFrame Portlet
Creating a Graphical Portlet
Adding the New Portlet to Your Welcome Page
Configuring a Portlet
Personalization Settings for Portlet Functions
Refresh Intervals for Portlets
Expanding or Collapsing a Portlet
Removing a Portlet
Rearranging Portlets
CentraSite Business UI Pluggable Architecture
Introduction
Customizing the Login Page
Introduction
Installing the Customized Login Page
The CentraSite Business UI Configuration Files
Login Configuration
Customizing the Welcome Page
Introduction
Installing the Customized Welcome Page
Welcome Page Configuration
Header Links
Activity Menu
Portlets
About Customizing Content Pages
Extension Points for Customizing Content Pages
Log in to CentraSite Business UI
Request an Account
Extend Activity Menu by Additional Functions
Implement Activity as an Extension
Enable Activity through Configuration
Replace Standard Search Widget
Advanced Search Criteria
Browse Link
Browse Search Criteria
Extend Search View
Replace Standard Asset Detail Page
Add Action Menu
Implement Action as an Extension
Enable Action through Configuration
Add Portlet
Implement Portlet as an Extension
Enable Portlet through Configuration
Computed Runtime Actions
Implement Runtime Action as an Extension
Enable Runtime Action through Configuration
GWT Sample Code Location
Step-by-Step Guide for Customizing Content Pages
Installing an Extension
Eclipse Prerequisites
Setting up the GWT project
Setting the Classpath
Importing the GWT Project
Configuring an Extension
Uninstalling an Extension
Uninstalling a Single Extension
Uninstalling a Set of Extensions
Creating a Custom Extension
Built-in Portlets Reference
Summary of Portlets in the Design/Change-Time Category
Summary of Portlets in the Run-Time Category
Built-in Portlets for Design/Change-Time Category
Asset Instance Count Per Category for Taxonomy
Get Undelivered Access Tokens
Inbox Notifications
Instance Count Per State for Lifecycle Model
Instances Per Type
Last Created Assets
Last Updated Assets
Linked Instance Count Per Category For Taxonomy
My All List
My All Saved Searches
My API Keys
My Favorites
My List
My Pending Approval Requests
My Pending Consumer Registration Requests
My Saved Searches
Recent Lifecycle Changes
Top X Assets by Consumers
Top X Assets by Incoming Association
Top X Assets by Watchers
Top X Assets Consumed Per Organization
Top X Assets Provided Per Organization
Top X Assets with Watcher and Consumer Count
Top X Most Versioned Services
Built-in Portlets for Run-Time Category
Service Performance Metrics
Service Performance Metrics Over Time
Top X Consumers Based on Runtime Invocations
Top X Monitoring Events Per Service
Top X Services Based on Invocations
Top X Services Based on Payload Size
Top X Services Based on Runtime Errors
Top X Services Based on Runtime Policy Violations
Managing Organizations
Introduction
Basic Organization Structure
The Default Organization
Planning Your Organization Structure
Who Can Create and Manage Organizations?
Organization Administrators and Primary Contacts
Adding a Top-Level Organization
Viewing or Editing the Properties of an Organization
Adding a Child Organization to an Organization
Deleting an Organization
Asset Navigator
Introduction
Graphical Visualization
Navigating to Asset Navigator from the Activity Bar
Navigating to Asset Navigator from the Actions Bar
Types of Charts
TreeChart Chart
SunBurst Chart
Icicle Chart
Graph Chart
Configuration Settings
Adding Custom Usecases
Managing Governance Rules
Working with Run-Time Policies
Actions that Run-Time Policies Can Execute
Supported Asset Type and Action Combinations
Who Can Create and Manage Run-Time Policies?
Adding a Run-Time Policy to CentraSite
Creating a New Run-Time Policy
Activating a Run-Time Policy
Deactivating a Run-Time Policy
Publishing a Run-Time Policy
Publishing a Single Run-Time Policy
Publishing Multiple Run-Time Policies in a Single Operation
Viewing the Run-Time Policy List
Viewing or Changing a Run-Time Policy
Specifying the Scope of a Run-Time Policy
System-Wide versus Organization-Specific Policy Enforcement
System-Wide Policies
Organization-Specific Policies
Modifying the Scope of a Run-Time Policy
Refining the Policy Scope
Assigning Actions to a Run-Time Policy
Modifying the Action List
Configuring Policy Action Parameters
Viewing the List of Virtual APIs to Which a Run-Time Policy Applies
Deleting a Run-Time Policy
Mediator Runtime Aliases
Defining the Runtime Aliases
Referencing the Runtime Aliases in Virtual Services
Publishing the Virtual Service
Using CentraSite with webMethods API-Portal
Before You Configure CentraSite for API-Portal
Roles and Permissions Needed to Create and Manage API-Portal Gateways
Configuring CentraSite, Mediator, and API-Portal
Displaying a List of Available API-Portal Gateways
Registering an API-Portal Gateway with CentraSite
Viewing or Modifying Details of an API-Portal Gateway
Setting Permissions on an API-Portal Gateway
Who Can Set Permissions on an API-Portal Gateway?
Setting Instance-Level Permissions on an API-Portal Gateway
Setting Instance-Level Profile Permissions on an API-Portal Gateway
API-Portal Specific Profiles in CentraSite
API-Portal Information Profile
CentraSite Communication Profile
API-Portal Communication Profile
Published APIs Profile
The Design/Change-Time Policies that are Used for API-Portal Communication
Configuring the Design/Change-Time Policies that are of use for API-Portal Gateway
Configuring the Publish to API-Portal Policy
Configuring the UnPublish from API-Portal Policy
Understanding Communication Between CentraSite and API-Portal
Retry Mechanism
Changing the Default Values for Retry Mechanism
Viewing Undelivered Access Tokens
Resending Undelivered Access Tokens
Rescheduling the Scheduler
Resending Access Tokens from the Command line
Sharing a Report Template with API-Portal
Unregistering an API-Portal Gateway from CentraSite
What Happens When You Unregister an API-Portal Gateway?
What Happens When Unregistration Fails?
What If You Need to Modify Unregistered API-Portal Gateways?
Unregistering a Single API-Portal
Unregistering a Set of API-Portals
Deleting an API-Portal Gateway
Deleting a Single API-Portal Gateway
Deleting a Set of API-Portal Gateways
Working with REST-based APIs
About this Guide
Document Conventions
Online Information
About CentraSite RESTful API Model
Overview
REST APIs
Base URL
API Parameters
REST Resources
Resource URLs
Resource Parameters
Resource Methods
Supported HTTP Methods
Method Parameters
REST Parameters
Parameter Levels
API-Level Parameters
Resource-Level Parameters
Method-Level Parameters
Parameter Types
Query-String Parameters
Path Parameters
Header Parameters
Form Parameters
Parameter Data Types
Supported Content Types
Supported HTTP Status Codes
Sample Requests and Responses
Sample 1 - Retrieve a list of phones
Sample 2 - Find a phone that doesn't exist
Sample 3 - Create a phone
Importing a RESTful API to CentraSite
Overview
Importing RAML Files
Importing a REST API Using RAML File
RAML to CentraSite REST API Mappings
Importing Swagger Files
Importing a REST API Using Swagger File
Swagger to CentraSite REST API Mappings
Creating a RESTful API from Scratch
Overview
Adding a REST API to CentraSite
Adding Base URL to REST API
Adding Resource to REST API
Adding HTTP Method to REST API
Adding Parameter to REST API
Adding HTTP Request to REST API
Adding HTTP Response to REST API
Adding Request and Response Messages to REST API
Managing RESTful APIs
Viewing a REST API
Using the Method-Centric View
Using the Resource-Centric View
Viewing the List of REST APIs
Viewing the Details of a REST API
Changing a REST API
Editing the Basic Details of a REST API
Editing the Extended Details of a REST API
Deleting a REST API
Deleting an API from the API Details Page
Deleting APIs from the Search Results Page
Generating Swagger 2.0-Compliant Specification for a RESTful API
CentraSite Developer's Guide
Developing Custom Actions
Planning to Create Custom Actions
About Action Categories
Predefined Action Categories Installed with CentraSite
Custom Action Categories
About Action Templates
Types of Actions
Supported Object Events
About Parameter Templates
Who Can Create and Manage Action Categories or Templates?
Viewing the Action Categories List
Adding Custom Actions Using the CentraSite UI
Creating a Custom Action Category
Adding an Action Template to a Custom Action Category
Adding a Parameter Template to the Action Template
Adding Custom Actions Using APIs
Creating Action Rules
Creating a Rule in a Java Class
Creating a Rule Using a Groovy Script
Uploading Action Rules to Action Templates
Viewing or Editing Action Categories or Templates
Viewing or Editing an Action Category
Viewing or Editing an Action Template
Downloading Rules from System Action Templates
Structure of the Zip File
Deleting 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 Custom Actions
Sample Java Action: Enforce Unique Asset Names
Sample Groovy Script Action: Service Attribute Checker
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
Built-In Actions for Design/Change-Time Policies
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
Delete RuntimeEvents and RuntimeMetrics
Enforce Unique Name
Initiate Approval
Initiate Group-Dependent Approval
Mark Pending on Runtime Policy Change
Notify ARIS Service
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
Access via UDDI
Overview of the UDDI Standard
Summary of UDDI Support in CentraSite
CentraSite UDDI Architecture
Overview
Client Access via UDDI
Localization
Modeling of the Node Business Entity
Key Generator tModel
Node Business Entity
Inquiry Service
Publish Service
Security Service
Custody and Ownership Transfer Service
WSDL
UDDI Representation of the Object Model
Attributes
Key/Value Pair Attributes
Rich Text Attributes
Document Attributes
Relationship Attributes
Metrics Definition
Metrics Reference Taxonomy
Metrics Types Taxonomy
Total Request Count Taxonomy
Success Request Count Taxonomy
Fault Request Count Taxonomy
Average Response Time Taxonomy
Minimum Response Time Taxonomy
Maximum Response Time Taxonomy
Availability Taxonomy
Service Liveliness Taxonomy
Representing Targets and Target Types
Representing Status
Representing Version
Mapping WS-PolicyAttachments
Configuring the UDDI Environment
Configuration Properties
UDDI in a Multi-CAST Environment
CAST Registration/Deregistration
Deployment Descriptors
Changing the User ID/Password of the Web Application Login Account
Setting Global and Local UDDI Properties
Setting Global UDDI Properties
Setting Local UDDI Properties
Getting Global and Local UDDI Properties
Schema Validation of UDDI Requests
Checked Value Set Validation
Predefined Value Sets
Predefined tModels
UDDI V3 APIs
Overview
Classes and Interfaces
RegistryService
RegistryConfiguration
RegistryFramework
RegistryAgent
UDDI_Security_SoapService
UDDI_Inquiry_SoapService
UDDI_Publication_SoapService
UDDI_Taxonomy_SoapService
CentraSiteBusinessService
Examples
Getting the Value of an Attribute
Getting the Proxy Services for a Specified Target
Inquiring about a Business Service
Publishing a Business Service
Fetching Taxonomies
Using Third-Party IDE Tools with CentraSite
Overview
Supported IDE Tools
Specifying the Inquiry, Publish and Security URLs
WTP Eclipse 1.5.2 Plug-In
IBM Rational Application Developer 6.0
Connecting to CentraSite
Publishing Entities
UDDI Extensions
Using WSDL in a UDDI Registry
Using WS-PolicyAttachment
Version 1.2 Support
Supported Policy Subjects
Referencing Remote Policy Expressions
Registering Reusable Policy Expressions
Registering Policies in UDDI Version 3
tModels to Support UDDI-Based WS-PolicyAttachments
Version 1.5 Support
Extending UDDI Publisher API Set to Enable Physical Deletion of tModels
Arguments
Behavior
Returns
Caveats
Pluggable Architecture
Introduction to CentraSite Control Pluggable Architecture
Customizing the Welcome Page
Introduction
Technical Implementation of the Welcome Page
Overview of Java Methods Used
Screen Component: Welcome Page
Screen Component: Widget
Screen Component: Item
Methods Not Related to Screen Components
Java Interface Hierarchy
Installing the Customized Welcome Page
Stop Software AG Runtime
Updating the plugin.xml Configuration File
Deploying the New Java Classes to the PluggableUI Environment
Start Software AG Runtime
Example of a Customized Welcome Page
Location of Demo Files
Differences Between the Standard Welcome Page and the Demo Welcome Page
Implementation of Welcome Page Layout
Header Area
Separator Between Header Part and Widget Part
Widget CentraSite
Widget Useful Links
Widget User Preferences
Default Settings for Widgets
Implementing the Demo as an Eclipse Java Project
Building the Deployment Files for Software AG Runtime
The build.properties File
Building the Deployment Files
Building the Deployment Files Using Eclipse (Method 1)
Building the Deployment Files from the Command Line (Method 2)
Deploying the Demo to Software AG Runtime
Displaying the Demo Welcome Page
Special Programming Techniques
Customizing Content Pages
Extension Points
I18N for Layouts
Parameters for Plug-ins
ConnectionHandler - Logon and Logoff / Exit
Perspectives
Topic
Command for Item
Bulk Command for Items
Add Property
Tab in Detail View
Add Source of Notification
Impact Analysis: NodeDecorator
Append Root Node to Topic
Replace Standard Detail View by Another Editor
Extend Search Dialog by Additional Conditions
Download Documents
Making the Download Menu Entry Visible/Invisible for Guest Users
Changing the Text String Displayed in the Context Menu
Changing the Format of the Zipped Archive
Attach Documents
Activating the IDE
Step-by-Step Guide
Setting the Preferred Plug-In and Order of Plug-Ins
Installing and Uninstalling Plug-Ins
Directory Structure
Installing a Plug-In
Uninstalling a Plug-In
Plug-In Management Perspective
Special and Advanced Topics
Icons
Class Loading
Multithreading and Synchronization
Nested Layouts
Javadoc Documentation of the APIs
Step-by-Step Guide
Eclipse Prerequisites
Setting up the Plug-in Project
Plugging into CentraSite Control
Bring Your Own Layouts to the Screen
Application Framework
Introduction
RegistryBean
BeanPool
StandaloneRegistryProvider
Configuration
Bean Types Managed by CSAF
Bean Modes
Persistence Modes
Cache Configuration
Re-Reading Outdated Objects
Mapping Beans to Registry Objects with Annotations
Introduction to Bean Mapping
Standard Mappings
Standard Mappings Usage Sample
Generating Beans from the Command Line
Querying the Registry
Application Framework Simple Search
Creating a Search Object
Restricting the Search Results by Adding Search Predicates
Defining the Order of the Search Results
Invoking the Search
Extending the Application Framework
Application Framework JAXR-Based Search
Event Mechanism
Asset Types
Usage Sample for Type Management
Association Types
Usage Sample for Association Type Management
Lifecycle Management
Usage Sample for LCM
Revision Management
Usage Sample for Revision Management
Multi-User Scenarios
Setting the Classpath
Examples
CRUD Example
API for JAXR
Introduction to the CentraSite API for JAXR
Creating and Closing a JAXR-based Connection
Creating a JAXR-based Connection
Closing a JAXR-based Connection
Defining a Service
Service that Uses Another Service
Service with Additional Information
Pre-Defined Classification Schemes (Taxonomies)
Impact Analysis
CentraSite API for JAXR Reference Information
Creating User-Defined Objects
Direct XQuery Access to the Stored Data
Unique Keys
Simultaneous Database Access and Locking
Caller
Semantics of Remove Operations
Delete Operation
RegistryObject
Association
AuditableEvent
Classification
ClassificationScheme
Concept
ExternalIdentifier
ExternalLink
Organization
RegistryEntry
RegistryPackage
Service
ServiceBinding
SpecificationLink
User
Unsupported Methods
Unsupported FindQualifiers
Using Wildcards
Using Namespaces
Method createSlot
Caching Considerations
JAXR-based Caching Strategy
Caching in User Interfaces
Dynamically Loaded JAR Files
Cache Location
API for XQJ
Introduction to the API for XQJ
What is XQJ?
Features of the XQJ Interface
Working with the XQJ Interface
Executing an XQuery with a Standard XQExpression
Executing an XQuery with an XQPreparedExpression
Working with a Materialized XQSequence
Examples
CentraSite-Specific Extensions to XQJ
Updating a Database Using XQJ
Inserting a Document in the Registry/Repository
XQDataSource Properties
Java Management Interface
Introduction the Java Management Interface
Description
Attributes and Operations
Attributes
Registry/Repository Start/Stop Operations
Web Service Interfaces
Introduction to the Web Service Interfaces
Approval Service
About the Approval Service
Invoking Operations from the Approval Service
Specifying the Authenticated User
Specifying the Location of the Approval Log
Retrieving the List of Approval Requests that a User Has Submitted
ApprovalRequestList Message
Getting Details about the Actions of the Approvers Associated with a Request
Approving or Rejecting Approval Requests
Scrolling Through the List of Returned Approval Requests
Reverting a Pending Approval Request
Operations
getPendingApprovals
getApprovalRequests
getApprovalActions
approve
reject
getApprovalHistory
revertPendingStateChange
ApprovalRequestList
ApprovalActionResult
Copyright
CentraSite Documentation
Copyright
to-centrasites_role_in_todays_soa
to-features
to-topology_and_architecture
to-the_information_model
to-editions
to-implementation_decisions_and_configuration_tasks
to-choosing_a_deployment_strategy
to-defining_your_organizational_structure
to-setting_up_users_and_groups
to-customizing_your_asset_catalog
to-defining_lifecycle_models
to-defining_design-change-time_policies
to-working_with_versions_and_revisions
to-planning_your_run-time_environment
to-implementing_the_mediation_environment
to-managing_run-time_policies
to-managing_virtualized_services
to-identifying_the_consumers_of_virtual_services
to-managing_endpoints
to-overview_of_basic_operations
co-start_and_stop_centrasite
to-administering_the_license_key
to-before_you_start_using_centrasite
to-maintaining_the_centrasite_internal_database
to-configuring_the_authentication_settings
to-configuring_port_numbers
to-configuring_secure_communication_between_components
to-configuring_the_registry_cache_settings
to-configuring_the_email_server
to-overview_of_the_administration_tools
to-usage_of_the_centrasite_command_tools
to-usage_of_the_centrasite_toolbox_scripts
to-your_user_account
to-ways_to_interact_with_centrasite
to-using_the_user_interface
to-overview_of_authentication_topics_and_ldap
to-overview_of_user_repositories
to-creating_authentication_configurations
to-configuring_the_internal_authentication_type
co-configuring_active_directory_server
to-configuring_ldap
to-performing_maintenance_on_authentication_configurations
co-creating_an_administration_user_from_the_command_line
to-logging_of_login_authentication_messages
co-transform_and_migrate_LDAP_data
to-notes_on_authentication_in_centrasite
to-about_users
to-about_groups
to-about_roles_and_permissions
to-changing_passwords_of_predefined_users_and_login_users
to-introduction_to_importing-exporting_registry_objects
to-exporting_and_importing_specific_object_types
to-exporting_and_importing_objects_using_centrasite_control
to-exporting_and_importing_objects_from_the_command_line
to-overview_of_importing_objects_using_the_api
to-invoking_an_importer_from_a_java_program
to-invoking_an_importer_from_a_java_class
to-invoking_an_importer_from_the_command_line
to-invoking_an_importer_using_the_soap_api
to-writing_your_own_importer
co-what_is_a_type
co-classifications_of_a_type
co-components_of_a_type
co-who_can_create_and_manage_types
to-creating_a_new_type
co-viewing_or_editing_a_type
to-using_inherit_profiles
ta-cloning_profiles
ta-excluding_subtypes
to-the_predefined_asset_types_in_centrasite
ta-customizing_the_user_and_organization_types
co-deleting_a_type
co-manage_types_from_command_line
to-working_with_composite_types
to-working_with_association_types
to-overview_of_customizing_lifecycle_management
to-introduction_to_customizing_lifecycle_management
co-who_can_create_and_manage_lifecycle_models
co-viewing_or_editing_a_lifecycle_model
to-creating_a_lifecycle_model
ta-activating_a_lifecycle_model
ta-updating_a_lifecycle_model
ta-deleting_a_state_from_a_model
co-deleting_a_lifecycle_model
co-lifecycle_model_for_lifecycle_models_(lcm_for_lcms)
co-the_predefined_lifecycle_models_installed_with_centrasite
to-introduction_to_taxonomies
co-who_can_create_and_manage_taxonomies
co-visibility_of_taxonomies_in_centrasite
ta-creating_a_taxonomy
ta-associating_taxonomy_to_an_object_type
ta-setting_permissions_on_a_taxonomy
ta-viewing_the_taxonomy_list
ta-viewing_or_editing_the_properties_of_a_taxonomy
to-the_predefined_taxonomies_in_centrasite
co-deleting_a_taxonomy
ta-adding_a_category
ta-viewing_or_editing_the_properties_of_a_category
ta-deleting_a_category
to-overview_of_logging
to-configuring_logs
to-monitoring_logs
to-audit_log_for_user
co-overview_of_purging
to-purging_logs
to-exporting_the_purged_log_records
ta-configuring_the_purger_properties_for_high_volume_data_handling
to-overview_of_registry_federations_in_centrasite
co-overview_of_the_federation_process
co-creating_a_federation_configuration_file
co-adding_a_uddi_federation_to_the_federation_list
co-triggering_the_uddi_federation
co-removing_a_uddi_federation_from_the_federation_list
co-displaying_the_list_of_target_registries_defined_for_federation
to-mapping_uddi_object_ids_and_tmodels
co-users_and_access_rights
to-overview_of_suite_usage_aspects
co-versioning_assets
co-modifying_or_deleting_assets
co-publishing_an_asset
to-communication_with_designer_ui
co-user_accounts
co-uddi_clients
to-using_centrasite_with_aris
to-components_of_the_run-time_governance_environment
co-introduction_to_consumer_applications
co-who_can_create_and_manage_consumer_applications
to-creating_and_managing_consumer_applications
co-register_consumer_applications
to-deploy_consumer_applications
co-introduction_consumer_registration
co-concept_registering_consumer
co-required_permissions_for_registration
co-dt_policy_for_consumer_registration
to-implementing_consumer_registration
co-viewing_consumer_registration_requests
co-monitoring_consumer_count
ta-viewing_consumer_details
ta-unregistering_an_existing_consumer
co-introduction_to_run-time_gateways
co-who_can_create_and_manage_gateways_and_gateway_types
to-creating_and_managing_gateway_types
co-introduction_to_virtualized_services
co-who_can_create_and_manage_virtualized_services
to-creating_virtualized_services
to-configuring_soap-based_virtual_services
to-configuring_rest_or_xml_virtual_services
ta-viewing_or_editing_the_profiles_of_virtualized_services
to-creating_run-time_policies
to-deploying_virtualized_services_and_consumer_applications
co-intro_virtual_api
co-who_can_manage_virtual_apis
to_preparing_virtualize_publish
to-runtime_components_virtualapi
to-creating_a_virtual_api
to-reconfiguring_a_virtual_api
co-synchronize_resources_virtual_apis
to-versioning_virtual_service_or_api
ta-editing_the_properties_of_an_api_proxy
to-configure_runtime_actions
to-publish_and_unpublish_api
co-exposing_soap_as_rest
to-displaying_runtime_information_for_an_api_proxy
to-obtaining_your_api_keys_and_access_tokens_for_consumption
to-managing_your_api_keys
co-privileged_user_of_an_api_proxy
to-invoking_webmethods_is_services_in_virtualized_services
to-using_context_variables_in_virtualized_services
to-important_considerations_when_configuring_soap-based_virtual_services
to-important_considerations_when_configuring_rest_or_xml_virtual_services
to-run-time_events_and_key_performance_indicator_(kpi)_metrics
to-built-in_run-time_actions_reference_for_virtual_services
to-built-in_run-time_actions_reference_for_apis
to-computed_runtime_actions
to-introduction_to_using_the_asset_catalog
to-what_a_catalog_entry_contains
to-browsing_the_asset_catalog
to-searching_the_asset_catalog
co-viewing_details_for_an_asset
to-displaying_run-time_information_for_assets
to-impact_analysis
to-publishing_a_new_asset_into_the_catalog
co-creating_an_application_asset
to-editing_an_asset_in_the_catalog
to-attaching_a_supporting_document_to_an_asset
co-changing_the_lifecycle_state_of_an_asset
to-setting_permissions_on_an_asset
to-versioning_an_asset
to-working_with_asset_revisions
to-changing_the_ownership_of_an_asset
to-deleting_an_asset
to-working_with_supporting_documents
to-downloading_an_asset
to-overview_of_working_with_design-change-time_policies
to-functional_scope
to-using_approval_policies
co-introduction_to_working_with_reports_and_report_templates
to-about_report_templates
co-who_can_create_and_manage_report_templates
to-adding_a_custom_report_template
ta-associating_a_report_template_with_an_object_type
ta-setting_permissions_on_a_report_template
co-viewing_the_report_templates_list
ta-viewing_or_editing_the_properties_of_a_report_template
ta-deleting_a_report_template
co-objects_for_which_you_can_generate_reports
co-who_can_generate_and_schedule_reports
co_report_parameters
ta-generating_a_report
ta-downloading_a_report
co_sharing_reports
ta-scheduling_a_report
ta-managing_scheduled_reports
ta-report_scheduler_settings
to-overview_of_api_management_solutions
co-centrasite_and_api_management
co-getting_started_with_api_management
ta-creating_an_api
co-view_api_list
ta-viewing_details_for_an_api
ta-editing_the_properties_of_an_api
to-setting_permissions_on_an_api
to-configuring_the_api_consumption_settings
to-managing_api_keys_and_oauth_2.0_tokens
to-approving_a_request
to-deleting_an_api
to-export_import_api
to-working_with_email_notifications
to-working_with_predefined_policies
to-overview_of_administering_the_business_ui
co-conceptual_overview_of_the_business_user_interface
to-working_with_the_business_user_interface
to-working_with_organizations_users_groups_and_roles
to-exporting_and_importing_registry_objects
to-managing_assets
to-managing_the_catalog
to-working_with_approval_workflows
to-message_handling_and_diagnostics
to-working_with_portlets
to-business_user_interface_pluggable_architecture
to-built-in_portlets_reference
co-introduction_to_managing_users_and_organizations
to-basic_organization_structure
co-planning_your_organization_structure
co-who_can_create_and_manage_organizations
co-organization_administrators_and_primary_contacts
ta-adding_a_top-level_organization
ta-viewing_or_editing_the_properties_of_an_organization
ta-adding_a_child_organization_to_an_organization
ta-deleting_an_organization
co-overview_asset_navigator
co-graphical_visualization
co-navigate_activity_bar
co-navigate_actions_bar
co-types-of-charts
re-treechart
re-sunburst
re-icicle
re-graph
co-configuration_settings
co-add_custom_usecases
to-working_runtime_policies
to-working_runtime_aliases
to-using_centrasite_with_api-portal
to-about_this_guide
re-webm_document_conventions
re-webm_online_information
to-chapter_heading_about_rest
co-overview_rest_model
co-overview_applications
co-overview_resources
co-overview_resources_methods
co-overview_parameters
co-overview_content_types
co-overview_status_codes
co-overview_requests_and_responses
to-chapter_heading_create_importer
co-documenting_importer_overview
co-import_raml_concept
ta-import_raml_file
re-import_raml_mappings
co-import_swagger_concept
ta-import_swagger_file
re-import_swagger_mappings
to-chapter_heading_create_scratch
co-documenting_pragmatic_api
ta-scratch_add_simple_api
ta-scratch_configure_baseuri
ta-scratch_add_resource
ta-scratch_add_method
ta-scratch_add_parameter
ta-scratch_add_request
ta-scratch_add_response
ta-scratch_add_message
to-chapter_heading_managing
co-manage-view-concept
ta-manage_view_bulk
ta-manage_view_single
co-manage-edit-concept
ta-manage_edit_basic
ta-manage_edit_extended
co-manage-delete-concept
ta-manage_delete_details_page
ta-manage_delete_results_page
ta-generate_swagger_spec
co-planning_to_create_custom_actions
to-about_action_categories
to-about_action_templates
to-about_parameter_templates
co-who_can_create_and_manage_action_categories_or_templates
ta-viewing_the_action_categories_list
to-adding_custom_actions_using_the_centrasite_ui
to-adding_custom_actions_using_apis
to-viewing_or_editing_action_categories_or_templates
ta-downloading_rules_from_system_action_templates
to-deleting_custom_action_categories_and_templates
ta-versioning_a_custom_action_template
to-sample_custom_actions
co-summary_of_actions_in_the_aris_category
co-summary_of_actions_in_the_change-time_category
co-summary_of_actions_in_the_collector_category
co-summary_of_actions_in_the_design-time_category
co-summary_of_actions_in_the_global_category
co-summary_of_actions_in_the_handler_category
co-summary_of_actions_in_the_ws-i_category
to-built-in_actions_for_design-change-time_policies
co-overview_of_the_uddi_standard
co-summary_of_uddi_support_in_centrasite
to-centrasite_uddi_architecture
to-uddi_representation_of_the_object_model
to-configuring_the_uddi_environment
co-predefined_value_sets
co-predefined_tmodels
to-uddi_v3_apis
to-using_third-party_ide_tools_with_centrasite
to-uddi_extensions
co-introduction_to_pluggable_architecture
to-customizing_the_welcome_page
to-customizing_content_pages
co-setting_the_preferred_plug-in_and_order_of_plug-ins
to-installing_and_uninstalling_plug-ins
to-special_and_advanced_topics
co-javadoc_documentation_of_the_apis
co-appendix_a-_step-by-step_guide
co-appendix_a1-_eclipse_prerequisites
co-appendix_a2-_setting_up_the_plug-in_project
co-appendix_a3-_plugging_into
co-appendix_a4-_bring_your_own_layouts_to_the_screen
to-introduction_to_application_framework
to-configuration
to-mapping_beans_to_registry_objects_with_annotations
to-querying_the_registry
co-event_mechanism
to-asset_types
to-association_types
to-lifecycle_management
to-revision_management
co-multi-user_scenarios
co-setting_the_classpath
to-examples
co-overview_of_the_centrasite_api_for_jaxr
to-creating_and_closing_a_jaxr-based_connection
co-defining_a_service
co-a_service_that_uses_another_service
co-a_service_with_additional_information
co-pre-defined_classification_schemes_(taxonomies)
co-impact_analysis
to-part_heading_jaxr_reference
ta-user-defined_objects
co-direct_xquery_access_to_the_stored_data
co-unique_keys
co-simultaneous_database_access_and_locking
co-the_caller
co-semantics_of_remove_operations
to-delete_operation
co-unsupported_methods
co-unsupported_findqualifiers
co-using_wildcards
co-using_namespaces
co-the_method_createslot
to-caching_considerations
to-overview_of_the_api_for_xqj
to-what_is_xqj
to-working_with_the_xqj_interface
to-centrasite-specific_extensions_to_xqj
co-xqdatasource_properties
co-introduction_to_java_management_interface
co-description
to-attributes_and_operations
to-chapter_heading
to-overview_of_web_service_interfaces
to-approval_service
to-online-copyright-page