•  Preface
  • Purpose
  • Audience
  • Organization
  •  References to ABL compiler and run-time features
    • Using this manual
    • References to ABL data types
  • Typographical conventions
  •  Examples of syntax descriptions
    • Long syntax descriptions split across lines
    • Complex syntax descriptions with both required and optional elements
  • Example procedures
  •  OpenEdge messages
    • Obtaining more information about OpenEdge messages
•  Introduction
  •  Overview of Server and Services Administration
    • AppServer for OpenEdge
    • AppServer Internet Adapter
    • OpenEdge Web Services Adapter
    • WebSpeed Transaction Server and Messenger
    • OpenEdge Adapter for SonicMQ
    •  OpenEdge Adapter for Sonic ESB
      • Configuring the OpenEdge runtime container for Sonic
      • Automatic upgrade of OpenEdge containers
    • REST Management Agent for REST Web application administration
•  AppServer and Internet Adapter Administration
  •  Configuring and Managing the AppServer
    •  Run-time components and operation
      • Distribution of components
      • Fault-tolerant NameServers
      • Fault-tolerant AppServers and load balancing
      • Operating modes
      • IPv6 networks
      • SSL-enabled AppServer operation
      •  AppServer operating modes and SSL
        • AppServer startup and shutdown
        • SSL-enabled AppServer startup requirements
        • OpenEdge startup parameters
        • AppServer registration
    •  AppServer administration framework
      • AppServer clients
      •  OpenEdge Management, OpenEdge Explorer, and the management utilities
        • OpenEdge Management or OpenEdge Explorer
        • Command-line management utilities
      • NameServers
      • AppServer broker
      • AppServer agents
      • AppServer and NameServer properties file (ubroker.properties)
      • Text editor and configuration utilities
      • Preparing for AppServer administration
    •  Configuring AppServer components
      • General steps for using OpenEdge Management or OpenEdge Explorer to configure an AppServer instance
      • Configuring an AppServer with OpenEdge Management or OpenEdge Explorer
      •  Editing the properties file
        • Guidelines for editing the properties file
        • AppServer entries in the properties file
        • Editing and validating the properties file
    •  Setting up the environment for AppServer execution
      • Environment variable settings
      • Working directory settings
      • AppServer and NameServer log files
      • OpenEdge remote SmartDataObject support
      • Customizing the AppServer agent executable
    •  Starting and managing an AppServer instance
      • Requirements for starting an AppServer
      • Starting and managing an AppServer with OpenEdge Management or OpenEdge Explorer
      •  Starting and managing an AppServer with the management utilities
        • Using the ASBMAN utility
        • Checking AppServer status
    •  Specifying the server pool parameters
      • Tuning for operating modes
      • Managing AppServer agents
    •  Managing code pages
      • Code-page settings
      • Run-time conversions
    •  Checking for failed client connections
      • Failure detection and response
      • Messages
      • Time out value tuning
      • AppServer operating modes
      • Configuring the AppServer
      •  Configuring clients
        • ABL client connections
        • Java and .NET Open Client connections
        • Web Services adapter connections
        • Sonic Adapter connections
        • SonicMQ Broker Adapter connections
        • SonicESB Invocation Adapter connections
        • SonicESB Web Services Adapter connections
        • AppServer Internet Adapter connections
      • HTTP, AIA, and SSL configurations
    •  Checking for failed server connections
      • Failure detection and response
      • Messages
      • Time-out value tuning
      • AppServer operating modes
      • Configuring the AppServer
      •  Configuring clients
        • Java and .NET Open Client connections
        • Web Services adapter and REST Web Services connections
    • Summary of management tasks
  •  Configuring and Managing the AppServer Internet Adapter
    •  Installing the AppServer Internet Adapter
      • General AIA administration
      •  Security considerations for AIA administration
        • AIA behavior in an SSL environment
        • Obtaining more information on SSL operations
    •  Installing and configuring Web servers and Java container
      • Enabling the Web server or Java container for SSL operation
    •  Configuring AIA components
      • General steps for using OpenEdge Management or OpenEdge Explorer to configure an AIA instance
      • Configuring an AIA with OpenEdge Management or OpenEdge Explorer
      •  Configuring an AIA by editing the properties file
        • AIA entities in the properties file
        • Validating changes to the ubroker.properties file
    •  Viewing AppServer Internet Adapter connection and configuration information
      • Connection status
      • Configuration information
•  Web Services Adapter Administration
  •  Configuring a Web Services Adapter Installation
    • Moving the WSA sample Web application
    • Configuring the Java container to recognize the WSA
    • Tuning the Java container to handle large Web service messages
    • Modifying the WSA's default Web service security settings
    • Enabling the WSA for HTTPS client connections
    • Installing WSA on a DMZ server
  •  Managing the Web Services Adapter
    •  WSA administration architecture
      • WSA administration prerequisites
      • Web server and Java container configurations
      • Constructing URLs
      • WSA as a Java container Web application
    • Defining a Web application for the WSA
    •  Creating one or more WSA instances
      • Creating a WSA instance
      • Creating multiple WSA instances
    •  Starting and testing a WSA instance
      • Starting the WSA and its instances
      • Testing a WSA instance
    •  Configuring and managing a WSA instance
      • Properties of a WSA instance
      • Modifying properties of a WSA instance
      • Statistics of a WSA instance
      • Configuring the WSA for Web services
  •  Deploying and Managing OpenEdge Web Services
    •  Initializing a WSA instance's default Web service properties
      •  Security considerations for Web service administration
        • SSL-related service properties
    •  Deploying a Web service
      • Versioning Web Services
      • After deploying Web services
    • Changing the Web service deployment directory
    • Enabling a Web service
    • Administering a deployed Web service
    •  Web service file management for deployed Web services
      • Options for providing the WSDL file to a client
      • Exporting and importing Web services
    • Monitoring and tuning Web services
    •  Typical Web service administration scenarios
      •  Deploying a new version of your Web service
        • Deploying in a production environment
        • Deploying in a development environment
      • Changing Web service properties
  •  Web Services Adapter Security Configurations
    •  Overview
      • Role of the Java container
      • Role of the WSA
      • Java container and WSA security files
      • Security features available
    • Initial settings
    •  Alphabetical list of configuration instructions
      •  Controlling access to Web services, WSDL, and WSA administration
        • Using one Java container security-constraint
        • Using user-authorization role-names
      • Customizing the default administrator's permissions and action settings
      • Customizing the PSCOper role's permissions and action settings
      • Customizing WSA administration roles
      • Disabling access to all Web services, to all WSDL, or to all WSA administration
      • Disabling authentication for WSA administration
      • Disabling the deploying and undeploying of Web services
      • Disabling WSDL listings
      • Enabling authentication for Web services
      • Enabling authentication for WSDL
      • Enabling multiple user roles to access Web services, WSDL, or WSA administration
      • Enabling Web services per user and per application
  •  Using the WSA Management Utility (WSAMAN)
    •  Overview of the WSAMAN utility
      • Syntax
      • Functions for managing a WSA instance
      • Functions for managing a Web service
•  WebSpeed Administration
  •  Configuring WebSpeed in Windows
    •  WebSpeed configuration overview
      • Configuring the WebSpeed components on Windows
    •  WebSpeed administration
      • The AdminService
      • OpenEdge Management or OpenEdge Explorer
      •  Defining or configuring WebSpeed with OpenEdge Management or OpenEdge Explorer
        • Modifying an existing WebSpeed configuration
      •  WebSpeed command-line utilities
        • WTBMAN utility
        • WSCONFIG utility
      •  NameServer command-line utilities
        • NSMAN utility
        • NSCONFIG utility
    •  Setting up WebSpeed on the Web server machine
      •  Installing the Messenger executable
        • Compatibility with the Web server type and operating system
      •  Configuring Netscape Web servers for NSAPI Messengers
        • Applying the configuration changes
      •  Restarting the Netscape Web server
        • Where to place the Messenger executable file
    • Placing static files on the Web server
    • Overview of the ubroker.properties file
    • Starting the AdminService
    •  Setting up the WebSpeed environment
      •  Setting environment variables
        • PROPATH and other standard OpenEdge environment variables
        • Working directory settings
        • Configuring WebSpeed and NameServer log files
    •  Configuring WebSpeed components
      •  Eliminating the NameServer
        • Eliminating NameServer using OpenEdge Management or OpenEdge Explorer
        • Eliminating NameServer using the ubroker properties file
      •  Understanding the NameServer's load-balancing option
        • Percentage weight factors
        • Arbitrary weight factors
        • Fail-over weight factor
    • Starting the WebSpeed Transaction Server and NameServer
    • Maintaining the WebSpeed Transaction Server and NameServer log files
    • Configuring a WebSpeed Messenger-only installation
    • Starting WebSpeed to test the configuration
    •  Testing your configuration
      • Using OpenEdge Management or OpenEdge Explorer to check status
      • Using the query option to check status
      • Viewing the Messenger Administration page
      • Running the status.p procedure
    •  Managing the WebSpeed Transaction Server
      • Dynamically starting additional agents
      • Trimming running agents
      • Stopping the WebSpeed broker
      • Accessing help on WTBMAN
    • Managing the WebSpeed Messenger
  •  Configuring WebSpeed on UNIX
    •  WebSpeed configuration overview
      • Configuring the WebSpeed components on UNIX
    •  WebSpeed administration
      • The AdminServer
      • OpenEdge Management or OpenEdge Explorer
      •  WebSpeed command-line utilities
        • WTBMAN utility
        • WSCONFIG utility
      •  NameServer command-line utilities
        • NSMAN utility
        • NSCONFIG utility
    •  Setting up WebSpeed on the Web server machine
      • Installing the Messenger executable
      •  Compatibility with the Web server type and operating system
        • Configuring the Netscape Web server for the NSAPI Messenger
        • Editing the Netscape Web server configuration file
        • Editing the Netscape Web server start file
        • Applying the configuration changes
      •  Restarting the Netscape Web server
        • Configuring a CGI Messenger
        • Where to place the Messenger script file
    • Placing static files on the Web server
    •  Overview of the ubroker.properties file
      • The ubroker.properties file structure
      • Editing the ubroker.properties file
    • Starting the AdminServer
    •  Setting up the WebSpeed environment
      •  Setting environment variables
        • PROPATH and other standard OpenEdge environment variables
        • Working directory settings
        • Configuring WebSpeed and NameServer log files
    •  Configuring WebSpeed components
      • Load balancing with the NameServer
    • Starting the WebSpeed Transaction Server and NameServer
    • Maintaining the WebSpeed Transaction Server and NameServer log files
    • Configuring a WebSpeed Messenger-only installation
    • Starting WebSpeed to test the configuration
    •  Testing your configuration
      • Using OpenEdge Management or OpenEdge Explorer to check status
      • Using the query option to check status
      • Viewing the Messenger Administration page
      • Running the status.p procedure
    •  Managing the WebSpeed Transaction Server
      • Dynamically starting additional agents
      • Trimming agents
      • Stopping the Transaction Server
      • Accessing help on WTBMAN
    • Managing the WebSpeed Messenger
  •  WebSpeed Dynamic Code-page Support
    • Introduction
    • Basic browser-agent interaction
    • How dynamic code-page support works
    • Summary of code-page conversions
    • Configuring the agent
    •  Tasks for the WebSpeed developer
      • Determining the MIME code-page name
    •  Storing the MIME code-page name
      • Accessing WEB-CONTEXT's HTML-CHARSET attribute
      • Converting code-page names between MIME and OpenEdge formats
      • Additional notes
  •  Connecting WebSpeed to a Data Source
    •  Connecting to an OpenEdge RDBMS
      • Connecting programmatically
      • Connecting to a local database
      • Connecting to a remote database
    •  Connecting to a non-OpenEdge data source through a DataServer
      • DataServer and WebSpeed architecture
      • Setting up and running the DataServer
    •  Creating an international Web site
      • Setting up Transaction Servers
      •  Configuring agents
        • Code pages
        • Session options
      • Directing Web requests
  •  WebSpeed Security
    •  Changing WebSpeed applications from development mode to production mode
      •  Set the agent application mode to production
        • Changing the application mode with OpenEdge Management or OpenEdge Explorer
        • Changing the application mode using the ubroker.properties file
      • Disable the WebSpeed Messenger Administration utility
      •  Disabling WSMAdmin
        • Disabling the WSMAdmin utility using the ubroker.properties file
      •  Establish the WebSpeed Messenger Administration Internet Protocol List (Optional)
        • Adding IP addresses using OpenEdge Management or OpenEdge Explorer
        • Defining specific IP addresses using the ubroker.properties file
      •  Check the status of the Debug mode
        • Checking the status using OpenEdge Management or OpenEdge Explorer
        • Checking the status using ubroker.properties file
    •  Changing additional settings to minimize security risks
      • Port numbers and WebSpeed server names
      • Minimize the PROPATH entries
      • Techniques to minimize unauthorized access to WebSpeed Messengers
      • Restrict your file upload directory
      • WebSpeed configuration considerations
    •  Authenticating a password using SpeedScript
      • Validating a password using SpeedScript
    •  Securing data transmissions between WebSpeed client and server components
      • Secure HTTP Protocol (HTTPS)
      •  Secure Sockets Layer (SSL)
        • SSL-enabled WebSpeed Transaction Server operation
        • SSL configuration for WebSpeed components
    •  Maximizing WebSpeed compatibility with your firewall
      • WebSpeed TCP port details
      • Important firewall considerations
      •  Network Address Translation (NAT) and the WebSpeed distributed configuration
        • Making a client connection using OpenEdge Management or OpenEdge Explorer
        • Making a client connection using ubroker.properties file
      • Using the NameServer client port range value settings with a firewall
  •  Using Active Server Pages with WebSpeed
    • Setting up the WebSpeed ASP (WSASP) Messenger
    • Accessing the WebSpeed ASP Web page
    • Enabling the WebSpeed ASP example
•  Messaging and ESB Administration
  •  OpenEdge Adapter for SonicMQ Administration
    •  Introducing the OpenEdge Adapter for SonicMQ
      •  Client connections to the OpenEdge Adapter for SonicMQ
        • OpenEdge Adapter for SonicMQ BrokerConnect (BrokerConnect)
        • OpenEdge Adapter for SonicMQ ClientConnect (ClientConnect)
        • OpenEdge Adapter for SonicMQ ServerConnect (ServerConnect)
      • Installing the OpenEdge Adapter for SonicMQ
      • SSL-enabled BrokerConnect operation
      • HTTPS security for BrokerConnect
    •  Configuring and administering the OpenEdge Adapter for SonicMQ
      • Configuring ClientConnect
      • Configuring ServerConnect
      • Configuring BrokerConnect
      • Editing BrokerConnect attributes in ubroker.properties
      •  Guidelines for editing the properties file
        • AppServer entries in the properties file
        • Server startup parameters
      •  Configuring BrokerConnect from the command line
        • Adaptconfig
        • Adaptman
    •  Maximizing performance
      • Performance comparison
      • Optimizing message size
      • StreamMessage, MapMessage, and TextMessage
      • Remote and local calls
      • Message reuse
      • Load balancing
      • Discardable messages
    • Setting the CLASSPATH
    • Internationalization considerations
  •  Configuring and Managing the OpenEdge Adapter for Sonic ESB
    • Introduction to the OpenEdge Adapter for Sonic ESB
    •  Installation of the OpenEdge Adapter for Sonic ESB
      • Configuration
      • Confirming the Sonic Management Console is configured properly (Optional)
    •  Using the OpenEdge Adapter for Sonic ESB
      •  Editing OpenEdge service properties
        • Adding the WSM or WSD resource to the Sonic ESB Directory Service
        • Editing the default service properties
      •  Creating an OpenEdge service instance
        • Generating a WSDL file from the OpenEdge Resource Editor
        • Associating the WSDL file with the service
      • Editing an instance of an OpenEdge service
    • Exposing a service as a standard Web service
    • Deploying a service instance in Sonic ESB
    • Starting the ESB container
    •  Security considerations for OpenEdge Adapter for Sonic ESB
      • SSL-related service properties
•  REST Administration
  •  REST Management Agent Administration
    •  Installing and Configuring REST Management Agent
      • Installing a REST Management Agent into a Java container
      •  Customizing Apache Tomcat Environment using the protc utility
        • Environment variables for the proset shell script file
        • Examples of proset script files
        • Executing the protc commands
      • Tuning the Java container to handle large Web service messages
      • Installing a REST Management Agent on a DMZ server
    •  Managing REST Management Agent
      •  REST Management Agent administration architecture
        • REST Management Agent administration prerequisites
        • REST administration architecture
        • Web server and Java container configurations
        • REST Management Agent directory structure
      •  Starting and testing a REST Management Agent
        • Starting the REST Management Agent
        • Testing a REST Management Agent
      •  Managing a REST Management Agent
        • Working with properties of a REST Management Agent
        • Working with statistics of a REST Management Agent
        • Configuring the REST Management Agent for its REST Web application
    • Security Configurations for a REST Management Agent
  •  REST Web Application Administration
    •  Managing REST Web applications
      • Initializing a REST Web application's runtime properties
      • Deploying a REST Web application
      • Enabling a REST Web application
      • Generating a REST Web application's WAR and PAAR files
      • Republishing a REST Web application
      • Unpublishing a REST Web service of a REST Web application
      • Monitoring and tuning REST Web application
      • Administering a deployed and enabled REST Web application
      • Understanding REST Web application URI construction
      •  Constructing and debugging REST requests to access a REST Web service
        • Interpreting the AppServerStatus section
        • Interpreting the RESTServices section
      •  SSL support for REST Web applications
        • Enabling the REST Web application for HTTPS client connections
        • SSL-related REST Web application properties
      •  SSO support for REST Web applications
        • Enabling the REST Web application for SSO
        • OEClientPrincipal properties
        • Pre-authentication filter in REST Web applications
        • Enabling the pre-authentication filter
      •  Debugging HTTP messages of a REST Web application
        • Enabling HTTP message dumping
        • Disabling HTTP message dumping
    • Security configurations for a REST Web application
    •  Managing REST Web applications in the absence of the REST Management Agent
      • Deploying the REST Web application
      • Editing a REST Web application runtime properties
      • Editing a REST Web application security configurations
      • Enabling a REST Web application using Tomcat's manager
      • Monitoring and maintaining REST Web application log files
    • Managing Web server deployed REST Web applications using the REST Management Agent
  •  Using the RESTMAN Utility
    • Syntax
    • Functions for managing a REST Management Agent
    • Functions for managing a REST Web application
  •  REST Management Agent and REST Web Application Security Configurations
    • Overview
    • Security configuration models
    •  Working with security configurations
      • Choosing and applying a security configuration
      • Adding and modifying a user
      • Setting hashed and salted password using EncodePassword
      • Setting hashed and salted passwords using Jacksum
      • Encrypting a password shared by REST Management Agent and REST Web application
      • Modifying user roles and privileges
      •  Extending CORS support
        • Customizing CORS support
        • OECORSFilter properties
    •  Using LDAP in security configurations
      • Choose and apply an LDAP security configuration
      • Configure the LDAP security configuration model
    •  Using Single Point of Authentication security configurations
      • Create, configure, and deploy an OpenEdge Realm on an AppServer
      • Choose and apply an SPA security configuration
      •  Configure the SPA security configuration model
        • OERealmAuthProvider properties
        • OERealmUserDetails properties
    •  Using SAML in security configurations
      • Choosing a SAML security configuration model
      • Creating and configuring the Service Provider metadata
      • Registering the Service Provider with the Identity Provider
      • Configuring the SAML security configuration model
•  Reference to OpenEdge Web Service Properties
  •  Overview
    • Summary of properties
    • Setting Service properties
  •  Alphabetical reference
    • appServerKeepAlive
    • appServiceConnectionMode
    • appServiceHost
    • appServiceName
    • appServicePort
    • appServiceProtocol
    • clientASKActivityTimeout
    • clientASKResponseTimeout
    • connectionLifetime
    • connectionTimeout
    • idleSessionTimeout
    • initialSessions
    • maxSessions
    • minIdleConnections
    • minSessions
    • noHostVerify
    • noSessionReuse
    • nsClientMaxPort
    • nsClientMinPort
    • nsClientPicklistExpiration
    • nsClientPicklistSize
    • nsClientPortRetry
    • nsClientPortRetryInterval
    • requestWaitTimeout
    • serviceAvailable
    • serviceFaultLevel
    • serviceLogEntryTypes
    • serviceLoggingLevel
    • sessionMode
    • staleO4GLObjectTimeout
    • waitIfBusy
•  Command and Utility Reference
  • ADAPTCONFIG
  • ADAPTMAN
  • AIACONFIG
  • ASBMAN
  • ASCONFIG
  • ESBOEGEN
  • NSCONFIG
  • NSMAN
  • PROADSV
  • RESTGEN
  • RESTMAN deploy
  • RESTMAN disable
  • RESTMAN enable
  • RESTMAN getdefaults
  • RESTMAN getprops (Application)
  • RESTMAN getprops (Management Agent)
  • RESTMAN getstats (Application)
  • RESTMAN getstats (Management Agent)
  • RESTMAN list
  • RESTMAN query (Application)
  • RESTMAN query (Management Agent)
  • RESTMAN resetdefaults (Management Agent)
  • RESTMAN resetprops
  • RESTMAN resetstats (Application)
  • RESTMAN republish (Application)
  • Deleting a REST Web application's files
  • RESTMAN resetstats (Management Agent)
  • RESTMAN setdefault (Management Agent)
  • RESTMAN setprops (Application)
  • RESTMAN setprops (Management Agent)
  • RESTMAN undeploy
  • RESTMAN unpublish (Application)
  • WSACONFIG
  • WSAMAN deploy
  • WSAMAN disable
  • WSAMAN enable
  • WSAMAN export
  • WSAMAN getdefaults
  • WSAMAN getprops (Service)
  • WSAMAN getprops (WSA)
  • WSAMAN getstats (Service)
  • WSAMAN getstats (WSA)
  • WSAMAN import
  • WSAMAN list
  • WSAMAN query (Service)
  • WSAMAN query (WSA)
  • WSAMAN resetdefaults
  • WSAMAN resetprops
  • WSAMAN resetstats (Service)
  • WSAMAN resetstats (WSA)
  • WSAMAN setdefault
  • WSAMAN setprops (Service)
  • WSAMAN setprops (WSA)
  • WSAMAN undeploy
  • WSAMAN update
  • WSCONFIG
  • WTBMAN
•  Reference to Dynamic Server Properties
  • Overview
  • Dynamic properties