Icon Using the Server Manager

The server manager is used to define web servers that can be accessed by the IDE for the both client and server application deployment, remote server application debugging, and server administration. Please see the Deploying a Project topic for more information on how to select a web server when deploying a client or server application, the Running and Debugging a Project topic for more information on how to select a web server when debugging a server application, and the Web Server Administration topic for more information on using the server manager to administer a web server.

Image

For ease of use, the IDE includes an embedded version of the Elevate Web Builder Web Server for development. By default, this web server is called Internal and is automatically set up during the IDE startup with a specific configuration for use with the localhost loopback host and the standard HTTP/HTTPS ports 80 and 443. You can use the instructions below on how to edit a web server in order to change any of the settings for the Internal web server. However, the Internal web server cannot be renamed or deleted in the server manager.

You can manually start and stop the Internal web server by clicking on the embedded web server button in the server manager toolbar:

Image

If the embedded web server button is selected, the Internal web server has been started.

Information It is important to note that these web servers are being defined from the perspective of the IDE, and these settings have no bearing on how the web server instance being accessed by the IDE is configured. Therefore, these settings must be correct for the target web server instance or various aspects of the IDE, such as application deployment and server administration, will not work properly. The only exception to this is the Internal web server. For the Internal web server, the ports and resource names do actually control how the Internal web server is configured. Any changes to these settings for the Internal web server will result in the web server being automatically restarted in the IDE so that the new settings take effect.

Creating a New Server
Use the following steps to create a new server using the server manager:
  • Right-click on the Servers node of the server manager. The context menu for the server manager will appear. Click on the New Server menu option.

    Image
The New Server dialog will now appear:

Image

After making any changes, click on the OK button to save the changes, or the Cancel button to discard the changes.

General

The General page provides options for specifying the name and description of the web server, along with the Base URL to use with any HTTP requests to the web server and the insecure HTTP and secure HTTPS ports to connect to when accessing the web server.

Image

SettingDescription
NameThe name of the web server.
DescriptionThe description of the web server.
Base URLThe base URL to use with any HTTP requests to the web server. The default base URL is "http://localhost".
Information The base URL works in conjunction with the insecure HTTP port and secure HTTPS ports to determine whether access to the web server occurs in an insecure or secure manner. For example, if the base URL is "http://localhost", then any HTTP requests to the web server will be made to the insecure port. However, if the base URL is "https://localhost", then any HTTP requests to the web server will be made to the secure port.
PortThe port to use for insecure HTTP requests. The default port is 80.
Secure PortThe port to use for secure HTTP requests. The default secure port is 443.
Auto-StartThis check box is only enabled for the Internal web server and determines if the embedded web server is automatically started during the IDE startup. By default, the Internal web server is set to auto-start.

Authentication

The Authentication page allows you to enter the user name and password to use during authentication. The IDE will first authenticate the user on the web server before making any HTTP requests, and will also authenticate the user on-demand if the web server indicates that the server session has expired.

Image

SettingDescription
User NameThe user name to use for authentication on the web server.
PasswordThe password for the user name. Click on the button with the eye icon in order to show the entered password.

Resources

The Resources page provides options for specifying the defined resources on the web server. These resource names are used in conjunction with the base URL defined on the General page to construct HTTP requests for the various APIs surfaced by the web server.

Image

SettingDescription
Keep-Alive Resource NameThe resource name to use for keep-alive requests. The default value is "keepalive".
Authentication Resource NameThe resource name to use for authentication requests. The default value is "authentication".
Administration Resource NameThe resource name to use for administration requests. The default value is "administration".
Databases Resource NameThe resource name to use for database requests. The default value is "database".
Applications Resource NameThe resource name to use for server application requests. The default value is "applications".
Modules Resource NameThe resource name to use for native server module requests. The default value is "modules".
Debugger Resource NameThe resource name to use for debugger requests. The default value is "debugger".

Editing an Existing Server
Use the following steps to edit an existing server using the server manager:
  • Right-click on the server node that you want to edit. The context menu for the server manager will appear. Click on the Edit Server menu option.

    Image
The Edit Server dialog will now appear:

Image

After making any changes, click on the OK button to save the changes, or the Cancel button to discard the changes.

Deleting an Existing Server
Use the following steps to delete an existing server using the server manager:
  • Right-click on the server node that you want to delete. The context menu for the server manager will appear. Click on the Delete Server menu option.

    Image


  • A confirmation dialog will be displayed, asking you to confirm the removal of the server. Click on the Yes button to continue, or the No button to cancel the removal.


  • Image
Migrating an Existing Server
You can easily migrate defined server objects and/or content from one existing server to another existing server. Use the following steps to execute a server migration using the server manager:
  • Right-click on the server node that you want to migrate. The context menu for the server manager will appear. Click on the Migrate Server menu option.

    Image
The Migrate Server dialog will now appear:

Image

After making any changes, click on the Migrate button to begin the migration, or the Cancel button to cancel the migration.

OptionDescription
Target ServerUse this combo box to select the target web server for the migration.
Migrate PrivilegesUse this check box to specify whether privileges should be migrated.
Migrate RolesUse this check box to specify whether roles should be migrated.
Migrate UsersUse this check box to specify whether users should be migrated.
Migrate DatabasesUse this check box to specify whether databases should be migrated.
Migrate ApplicationsUse this check box to specify whether installed server applications should be migrated.
Information This option will cause all server applications to be migrated first, followed by the server applications being installed on the target web server.
Migrate ModulesUse this check box to specify whether installed native server modules should be migrated.
Information This option will cause all native server modules to be migrated first, followed by the native server modules being installed on the target web server.
Migrate ContentUse this check box to specify whether all static content should be migrated.
Migration ConflictsUse this combo box to select what to do if a server object or file that is being migrated already exists on the target web server.

Viewing the Status of a Server
Use the following steps to view the status of a server using the server manager:
  • Right-click on the server node that you want to examine. The context menu for the server manager will appear. Click on the Server Status menu option.

    Image
The server status panel will now appear at the bottom of the server manager:

Image

You can use the combo box to select which statistic you would like to view. The server statistics are updated in real time every 3 seconds.

Information Certain statistics for the embedded Internal web server are not valid because the web server is embedded in the IDE. For example, the Memory Usage statistic represents the total amount of memory used by the entire IDE, not just the Internal web server.
Image