How to Configure the Web Interface

This article contains the following topics:
casm172
This article contains the following topics:
HID_ConfigureWebInterface
When you install CA SDM, the
web interface
(commonly referred to as the
browser interface
) is automatically installed.
Select the web server depending on the CA SDM configuration. Consider the following use cases:
  • Conventional: No additional action is required when the web server and the primary server are on the same computer. If they are installed on a different computer, install and configure both primary and secondaryserver.
  • Advanced Availability: No additional action is required when the web server and the background server are on the same computer. But if they are on a different computer, install and configure both background and application server. The web interface for end usersis never hostedfrom the background server. The web interface must be hosted only on the application servers.
Select the computer on which the web server resides depending on your CA SDM configuration:
  • Conventional: Secondary server. Install this server after you install the primary server.
  • Advanced Availability: Application server. Install this server after you install the background server.
By default, Tomcat is the default web server. If you want to use IIS as your web server, manually configure the product and select IIS. For information, see the
Server Configuration Online Help
.
To configure the web interface, complete the following steps:
  1. (Required) Enable the web engine on the secondary server on Windows or UNIX.
Web Engines or Web Directors
Web engines help prepare web pages for the web client. All systems have one or more web engines. Each web engine connects to an object manager for processing all requests to CA SDM objects. Depending on your configuration type, CA SDM installs a default web engine on the following servers:
  • Conventional: Primary server.
  • Advanced Availability: All servers.
You can modify the default web engine to suit your requirements.
Web directors are optional, and are used when there are two or more web engines installed on a single server. Web Director receives connection requests from users, selects a web engine to handle the request, and redirects the request to that web engine.
Add Web Engines or Web Directors
Web engines connect to an object manager for processing all requests to CA SDM objects. Web directors are optional, and are used when two or more web engines are installed on a single server. You can configure web directors on any server. Depending on the CA SDM configuration, CA SDM installs a default web engine on the following servers:
  • Conventional: Primary server.
  • Advanced Availability: All servers.
Follow these steps:
  1. Select Systems, Configurations
     
    on the Administration
     
    tab.
    The Configurations List page opens.
  2. Select the configuration to which you want to add the web engine or web director.
    The Configuration Detail page opens.
    : If you are changing the configuration for the first time, then create a configuration first. When you want to make a configuration change, always create or copy an existing one. This process allows you to revert to the previous configuration, if needed.
  3. Select the Web Engines/Web Directors tab.
    The Web Engine/Web Directors Listpageopensdisplays the web engines and web directors that are configured for the server.
    • Conventional: A web engine exists by default on the primary server. You can add web directors to any server.
    • Advanced availability: A web engine exists by default on all servers. You can add more web directors on any CA SDM server.
  4. Click Add Web Engine/Web Director.
    The Create New Web Engine/Web Director page opens.
  5. Complete the following fields:
     Enter only English characters for all the input fields for any localized language.
  • Host Name
    Specifies the host name for the web engine or web director. You can click Search to look up for the servers.
    For an advanced availability configuration type, the host name is read-only and is automatically populated based on the host name you specified while creating the configuration.
  • Type
    Specifies if you are configuring a webengineorwebdirector. Based on the option that is selected, the relevant fields are automatically populated.
    • Select Web Engine
       
      if you want to configure a web engine.
    • Select Web Director if you want to configureawebdirector.
    Ensure that you have selected the appropriate option. You cannot edit the process type after you have saved the configuration.
  • Web Director
    Specifiesthewebdirector that is assigned to the web engine. You can click Search to look up for the web directors added to the server.
    When implementing any web engine load-balancing scheme, SSL-Login, or both, at least two web engines must be assigned to the same web director.
  • CGI Name
    Specifies the unique CGI name for the web engine. It is the name of an actual CGI executable when IIS or Apache is used as the HTTP server; it is a servlet parameter when Tomcat is used as the HTTP server.
    Examples: (web engines) pdmweb1, pdmweb2, (web directors) pdmweb_d1, and pdmweb_d2.
    Default:
     pdmweb.exe (The CGI name must be unique).
  • CGI Port Number
    Specifies the port on which CA SDM web clients can connect. The CGI port number is the same port on which the tomcat server is running.
    Default:
     8080
  • Protocol
    Specifies the protocol for accessing the web engine.
    • Select HTTPS if the web engine is configured to handle all CA SDM web-client user authentication requests.
    • Select HTTP if the web engine is configured to handle all web client non-user authentication requests (afteruserisauthenticatedthrough the secure login web engine).
  • Record Status
    Specifies whether the web engineorwebdirector is active or inactive.
    Before setting the record status of a web director to inactive, remove the link between the web director and the associated web engines.
  • Object Manager
    Specifies the object manager that you want to assign to the web engine.
    • Default
      Specifies that the default object manager is assigned to the web engine.
    • ANY
      Specifies that the web engine can connect to any available object manager with more willingness value. Willingness value is the availability of the server to accept new clients. A willingness value of zero means that the web engine does not accept any sessions.
    • Choose
      Allows you to specify an object manager for the web engine. Selecting this option provides you the option to add multiple object managers or aliases to the configuration.
Click Save.
The web engineorwebdirectorthatyouadded appears in the Web Engines/Web Directors List.
Web Director List
Web directors are used when there are two or more web engines installed on a single server. Web Director receives connection requests from users, selects a web engine to handle the request, and redirects the request to that web engine. All
The Webdirectors List page opens that displays all the web directors that are configured for the server.
Configure the Web Interface
If the default web interface configuration specified does not meet the CA SDM installation requirements, modify the
web.cfg
file. The
web.cfg
is located in the
installation-directory
\bopcfg\www. Edit the file using a text editor, such as Notepad or WordPad.
Each entry in the file consists of a single line containing a property name, optionally followed by a value. Lines beginning with a pound sign (#) are treated as comments and are ignored.
Start the Web Interface
Verify that the Daemon Server services and the database server are started before starting the web interface. If the secondary server is configured, the Remote Daemon Proctor service must be started before starting the primary server service. To start the services on Windows and Linux OS, perform the following steps:
  • (Windows): Select Start, Control Panel, Administrative Tools, Services). Right-click the CA SDM Remote Proctor and select Start.
  • (Linux): Run the
    pdm_init 
     command to start the primary server and
    pdm_proctor_init
    to start the secondary server.
Verify that the services are started and then start the web interface. You can also start the web interfacefroman internal web site. If you are on the primary or secondary server system and are using the Internet Information Services (IIS), perform the following steps:
  • Select Start, All Programs, CA, Service Desk Manager, Service Desk Manager Web Client.
  • On a system that is not a primary or a secondary server, open a web browser and enter the following URL address:
    http://servername:8080/CAisd/pdmweb.exe
    In this URL,
    servername
    is the name of the computer that is hosting the CA SDM web server.
  • On a System that is not a primary or secondary server with IIS as the web server, open a web browser and enter the following URL address:
    http://servername/CAisd/pdmweb.exe
  • To start the web interface from an internal website, add
    /pdmweb.exe
    to the URL for your web pages. Use the following sample HTML code as a guide:
    A HREF=http://<server-name>:<port-no>/CAisd/pdmweb.exe
    In this URL,
    server-name
    identifies your computer and
    port-no
    is the port on which your web server is listening.
    If the Internet Explorer browser security is set to high, a warning message appears after starting the web interface. To avoid this message, add the website to your trusted sites or lower your security settings. In advance availability, the default web interface is readily available with the default installation and configuration.
Record Locking Behavior in the Web Interface
Editing a database record using the web interface, the user is given an exclusive lock of two minutes. You can change the default time by using the ExclLockSeconds property in the web.cfg file.
The following conditions apply when a database record is updated:
  • If a user
    can
    edit and submit changes within an allotted time, the changes are included the database.
    When the database record is locked, other users (both web and non-web users) can view the record, but cannot edit the record. If they try to edit the record when it is locked, an error message appears.
  • If a user
    cannot
    edit and submit changes within an allotted time, the record lock automatically drops and other users can edit the record.
    When the user submits the updates, time stamps are checked to ensure that nobody else has changed the record:
    • If the record has not been changed since the exclusive lock was dropped, the user updates are saved to the database.
    • If another user has edited the record after the lock expires, the user receives an error response and the changes are not saved. The user must restart the edit process and must reapply the changes.
Enabling the CAPA Help
CA Productivity Accelerator (CAPA) provides context-sensitive in-application performance support for the CA SDM analyst web forms. The CAPA player package directly integrates with the Context Help menus of CA SDM analyst web pages. The integration of CAPA Help content with CA SDM is achieved through the help menu scripts. These scripts launch the CAPA recorded Help content from the CA SDM Help menu drop-downs and right-click context help.
This section does not include information about the CAPA recording tool, obtaining and configuring the CAPA Help content, and installing the Smart Help.
 
CA SDM provides a unique identifier to recognize each web form uniquely. If an identification element is present in the top frame of the CA SDM, the CAPA recording tool recognizes the web application form. Once the top frame is recognized, all sub frames are considered to be part of this application. The sub frames that are loaded from a different domain must also be identified. Otherwise, these sub frames are not considered a part of CA SDM. To enable CAPA help, prepare the help content and configure the options to launch the CAPA help.
 To modify the HTML files, use the invoke methods from the ias_helper.js files for the CAPA recorder to recognize the html forms.
 
CAPA Help is not supported on the CA SDM Employee, Customer, or PDA interfaces.
Follow these steps:
  1. Open the capa.properties file from the following CA SDM directory:
    %NX_ROOT/bopcfg/www/wwwroot
  2. Change the following values in the file:
    • Enable_Alerts
      = 0. This option verifies and displays the javascript alert messages in a browser console when the CA SDM web page loads.
  3. Save the file.
  4. Go to the web.cfg file in the CA SDM directory, add DebugScript=1, and restart the web engine.
    The recorded content is prepared, published, and deployed on the CAPA server.
  5. Open the capa.properties file and change the following values:
    • Enable_For_Recording
      = 0
    • Show_Learn_Links
      = 1. This value displays the CAPA Help option in the CA SDM Help Menu and in the right-click Help context menu.
    • Server_Name
      = name of the server where CAPA published content is deployed.
    • Server_Port =
      CAPA server port where the CAPA published content is deployed. For example, the TOMCAT port.
    • Virtual_Dir
      = virtual directory where the CAPA published content is deployed on the CAPA server.
    • Namespace
      = application context namespace. For example, app.SDM.Project123;en.
    • Enable_Alerts
      = 0
  6. Save the file.
    You are ready to launch the CAPA Help from the CA SDM analyst web forms.