Skip to main content

Alternative Options for IIS 7 or Later (Windows)

This page contains instructions for configuring atypical options for configuring Microsoft IIS for use with the InterSystems Web Gateway. For these options:

Installing the ISAPI and CGI Services

IIS 7 does not, by default, run ISAPI extension, ISAPI filters, or CGI modules. For all the atypical options for IIS 7, you must install these services.

Note that, with the ISAPI extensions service installed, all versions of the Web Gateway work with IIS 7.

Install these legacy services through the Windows Control Panel.

  1. Open the Windows Control Panel.

  2. Select Programs and Features and select Turn Windows Features on or off.

  3. Navigate to Internet Information Services and expand World Wide Web Services and Application Development Features.

    Select ISAPI Extensions. Also select ISAPI Filters and CGI, if these additional services are required. Select OK.

  4. In the Windows Control Panel, open Administrative Tools and Internet Information Services (IIS) Manager.

  5. In the left panel, highlight [MACHINE_NAME] ([machine_name]\[user_name])

  6. In the middle panel, double-click the Modules icon.

  7. In the right panel, select Add Native Module.

  8. In the left panel, expand the top level, expand Web Sites and expand Default Web Site

    [MACHINE_NAME] ([machine_name]\[user_name])
                  Web Sites
                         Default Web Site
  9. In the middle panel, double-click Handler Mappings.

  10. In the middle panel, highlight the ISAPI-dll handler.

  11. In the right panel, select Edit Handler Permissions.

  12. Select Execute and select OK. This allows ISAPI extensions to be invoked through direct calls to the name of the ISAPI DLL.

Alternative Option 1: Using the ISAPI Modules (CSPms*.dll)

Use this option if your Web Gateway DLLs are unable to support the Native Module interface (the Recommended Option). This is the default (and best performing) solution that was supplied for earlier versions of IIS.

IIS 7 does not, by default, run ISAPI extensions, ISAPI filters or CGI modules. This option requires the ISAPI extensions service.

Follow the instructions in Installing the ISAPI and CGI Services (If Required) for installing and configuring the ISAPI extensions service.

The web server should be configured such that it recognizes InterSystems file types and passes them to the Web Gateway for processing.

Enabling the ISAPI Extensions

DLLs: CSPms.dll and CSPmsSys.dll

Before these extensions can be used they must be registered with IIS as being “Allowed” applications. This is done in the Internet Information Services (IIS) Manager control panel.

  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel, highlight [MACHINE_NAME] ([machine_name]\[user_name]).

  3. In the middle panel, double-click ISAPI and CGI Restrictions.

  4. In the right panel, select Add.

  5. In the Add ISAPI or CGI Restriction dialog, enter the following details:

    ISAPI or CGI Path: C:\Inetpub\CSPGateway\CSPms.dll

    Description: WebGatewayRunTime

    Allow extension path to execute: Select

    Select OK

Mapping InterSystems IRIS File Extensions

Choose one of the following configuration methods:

If you are serving static files from the web server, map the InterSystems file types to the Web Gateway ISAPI extensions as follows:

Extension Binary
*.csp C:\Inetpub\CSPGateway\CSPms.dll
*.cls C:\Inetpub\CSPGateway\CSPms.dll
*.zen C:\Inetpub\CSPGateway\CSPms.dll
*.cxw C:\Inetpub\CSPGateway\CSPms.dll
  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

    [MACHINE_NAME] ([machine_name]\[user_name])
                Web Sites
                        Default Web Site
    Note:

    This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

  3. In the middle panel, double-click the Handler Mappings icon.

  4. In the right panel, select Add Script Map.

  5. In the Add Script Map dialog, enter:

    Request Path: *.csp

    Executable: C:\Inetpub\CSPGateway\CSPms.dll

    Name: WebGateway_csp

  6. Select Request Restrictions.

    Clear: Invoke handler only if request is mapped to

    Select OK to return to Add Script Map dialog.

    Select OK.

  7. At this point you may be prompted as follows:

    “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

    Select Yes.

    You can later find the list of allowed applications as follows:

    In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

    In the middle panel, double-click ISAPI and CGI Restrictions.

    If the Web Gateway ISAPI components are not included in the list of allowed applications, add them.

    You can add text of your own choice in the Description field. For example:

    WebGatewayManagement for CSPmsSys.dll

    WebGatewayRunTime for CSPms.dll

  8. Repeat the above process: Use the Add Script Map dialog to enter the following two mappings:

    Request Path: *.cls

    Executable: C:\Inetpub\CSPGateway\CSPms.dll

    Name: WebGateway_cls

    Request Path: *.zen

    Executable: C:\Inetpub\CSPGateway\CSPms.dll

    Name: WebGateway_zen

    Request Path: *.cxw

    Executable: C:\Inetpub\CSPGateway\CSPms.dll

    Name: WebGatewayManagement

Operating and Managing the Web Gateway

To access the Web Gateway’s systems management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp/bin/CSPmsSys.dll

If you see an unauthorized user error message, see “Web Gateway and Security.”

Alternative Option 2: Using a Native Module with the NSD (CSPcms.dll)

IIS 7 does not, by default, run ISAPI extensions, ISAPI filters, or CGI modules. This option requires the CGI modules service for running the Web Gateway Management module (nph-CSPcgiSys.exe).

Follow the instructions in Installing the ISAPI and CGI Services (If Required.

Configure the web server so that it recognizes InterSystems file types and passes them to the Web Gateway for processing.

Registering the Runtime Native Module

DLL: CSPcms.dll

Before this module can be used, it must be registered with IIS. This is done in the Internet Information Services (IIS) Manager control panel.

  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

  3. In the middle panel, double-click the Modules icon.

  4. In the right panel, select Add Native Module.

  5. Select Register and enter the following details in the Register Native Module dialog:

    Name: CSPcms

    Path: C:\Inetpub\CSPGateway\CSPcms.dll

    Select OK.

  6. In the left panel, expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

    [MACHINE_NAME] ([machine_name]\[user_name])
                Web Sites
                        Default Web Site
  7. In the right panel, select Add Native Module.

  8. In the Add Native Module dialog select CSPcms then select OK.

Enabling the CGI module for Web Gateway Management

Executable: nph-CSPcgiSys.exe

Before this module can be used, it must be registered with IIS as being an Allowed application. This is done in the Internet Information Services (IIS) Manager control panel.

  1. Open the Internet Information Services (IIS) Manager.

  2. In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

  3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

  4. In the right panel, select Add.

  5. In the Add ISAPI or CGI Restriction dialog, enter:

    ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

    Description: WebGatewayManagement

    Allow extension path to execute: Select

    Select OK.

Mapping InterSystems IRIS File Extensions

Note:

Do not use Add Wildcard Script Mapping utility for this file extension mapping process; it gives an error. Instead, use the utility called Add Module Mapping for *.

Choose one of the following configuration methods:

  • Serve all content (including static content) from InterSystems IRIS. Map * to the Web Gateway. If you are configuring the web application so that the InterSystems IRIS server serves all static files, then see Mapping Additional File Types.

  • Serve static content from the web server.

    Map only InterSystems file types to the Web Gateway.

If you are serving static files from the web server, map the InterSystems file types to the Web Gateway modules as follows:

Extension Native Module Binary
*.csp CSPms C:\Inetpub\CSPGateway\CSPms.dll
*.cls CSPms C:\Inetpub\CSPGateway\CSPms.dll
*.zen CSPms C:\Inetpub\CSPGateway\CSPms.dll
*.cxw   C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe
  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel, expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

    [MACHINE_NAME] ([machine_name]\[user_name])
                Web Sites
                        Default Web Site
    Note:

    This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

  3. In the middle panel, double-click the Handler Mappings icon.

  4. In the right panel, select Add Module Mapping.

  5. In the Add Module Mappings dialog, enter:

    Request Path: *.csp

    Module: Select CSPcms

    Name: WebGateway_csp

  6. Select Request Restrictions.

    Clear: Invoke handler only if request is mapped to

    Select OK to return to the Add Module Mappings dialog.

    Select OK.

  7. Repeat the above process to add the following Module Mappings:

    Request Path: *.cls

    Module: Select CSPcms

    Name: WebGateway_cls

    and

    Request Path: *.zen

    Module: Select CSPcms

    Name: WebGateway_zen

  8. In the left panel, highlight the Default Web Site section:

    [MACHINE_NAME] ([machine_name]\[user_name])
                Web Sites
                        Default Web Site
  9. In the middle panel, double-click the Handler Mappings icon.

  10. In the right panel, select Add Script Map.

  11. In the Add Script Map dialog, enter:

    Request Path: *.cxw

    Executable: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

    Name: WebGatewayManagement

  12. Select Request Restrictions.

    Clear: Invoke handler only if request is mapped to

    Select OK to return to the Add Script Map dialog.

    Select OK.

  13. You may be prompted as follows: “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

    Select Yes.

    You can later find the list of allowed applications as follows:

    In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

    In the center panel, double-click the ISAPI and CGI Restrictions icon.

    If the Web Gateway Management CGI module is not included in the list of allowed applications, add it.

    You can add text of your own choice in the Description field. For example:

    WebGatewayManagement for nph-CSPcgiSys.exe

Operating and Managing the Web Gateway

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

Start the CSP NSD as described in the section, Starting the NSD.

To access the Web Gateway’s Systems Management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp-bin/nph-CSPcgiSys

If you see an unauthorized user error message, see Web Gateway and Security.

Alternative Option 3: Using an ISAPI Module with the NSD (CSPcms.dll)

Use this option if your Web Gateway DLLs are unable to support the Native Module interface (Alternative Option 2).

IIS 7 does not, by default, run ISAPI extensions, ISAPI filters or CGI modules. This option requires both the ISAPI extensions and the CGI modules service.

Follow the instructions in Installing the ISAPI and CGI Services.

The web server should be configured such that it recognizes InterSystems file types and passes them to the Web Gateway for processing.

Enabling the Runtime ISAPI Extension

DLLs: CSPcms.dll

Before this extension can be used, it must be registered with IIS as being “Allowed” applications. This is done in the Internet Information Services (IIS) Manager control panel.

  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel, highlight: [MACHINE_NAME] ([machine_name]\[user_name])

  3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

  4. In the right panel, select Add.

  5. In the Add ISAPI or CGI Restriction dialog, enter:

    ISAPI or CGI Path: C:\Inetpub\CSPGateway\CSPcms.dll

    Description: WebGatewayRunTime

    Allow extension path to execute: Select

    Select OK

Enabling the CGI module for Web Gateway Management

Executable: nph-CSPcgiSys.exe

Before this module can be used, it must be registered with IIS as being an Allowed application. This is done in the Internet Information Services (IIS) Manager control panel.

  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel, highlight: [MACHINE_NAME] ([machine_name]\[user_name])

  3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

  4. In the right panel, select Add.

  5. In the Add ISAPI or CGI Restriction dialog, enter:

    ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

    Description: WebGatewayManagement

    Allow extension path to execute: Select

    Select OK.

Mapping InterSystems IRIS File Extensions

Choose one of the following configuration methods:

  • Serve all content (including static content) from InterSystems IRIS. Map * to the Web Gateway. If you are configuring the web application in InterSystems IRIS so that the InterSystems IRIS server serves all static files, see Mapping Additional File Types.

  • Serve static content from the web server.

    Map only InterSystems file types to the Web Gateway.

If you are serving static files from the web server, map the InterSystems file types to the Web Gateway Modules as follows:

Extension Binary
*.csp C:\Inetpub\CSPGateway\CSPcms.dll
*.cls C:\Inetpub\CSPGateway\CSPcms.dll
*.zen C:\Inetpub\CSPGateway\CSPcms.dll
*.cxw C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe
  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel, expand the top level and expand Web Sites. Highlight Default Web Site.

    [MACHINE_NAME] ([machine_name]\[user_name])
                Web Sites
                        Default Web Site
    Note:

    This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

  3. In the middle panel, double-click Handler Mappings.

  4. In the right panel, select Add Script Map.

  5. In the Add Script Map dialog, enter:

    Request Path: *.csp

    Executable: C:\Inetpub\CSPGateway\CSPcms.dll

    Name: WebGateway_csp

  6. Select Request Restrictions.

    Clear: Invoke handler only if request is mapped to

    Select OK to return to the ‘Add Script Map’ dialog.

    Select OK.

  7. At this point you may be prompted as follows:

    “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

    Select Yes.

    You can later find the list of allowed applications as follows:

    In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

    In the middle panel, double-click the ISAPI and CGI Restrictions icon.

    If the Web Gateway ISAPI module is not included in the list of allowed applications, add it.

    You can add text of your own choice in the Description field. For example:

    WebGatewayRunTime for CSPcms.dll

    WebGatewayManagement for nph-CSPcgiSys.exe

  8. Repeat the above process: Use the Add Script Map dialog to enter the following two mappings:

    Request Path: *.cls

    Executable: C:\Inetpub\CSPGateway\CSPcms.dll

    Name: WebGateway_cls

    Request Path: *.zen

    Executable: C:\Inetpub\CSPGateway\CSPcms.dll

    Name: WebGateway_zen

    Request Path: *.cxw

    Executable: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

    Name: WebGatewayManagement

Operating and Managing the Web Gateway

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

  1. Start the CSP NSD as described in the section dedicated to this service.

To access the Web Gateway’s Systems Management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp-bin/nph-CSPcgiSys

If you see an unauthorized user error message, see “Web Gateway and Security.”

Alternative Option 4: Using the CGI Modules with the NSD (nph-CSPcgi*.exe)

In most cases, the all-inclusive Native Module-based solution (the Recommended Option) is the option of choice, and is the implementation that gives the best performance. The CGI/NSD hybrid is useful for cases where it is necessary, for operational reasons, to manage the Web Gateway independently of the hosting web server. For example, if multiple instances of the web server are to share the same Web Gateway installation. In option 1 each instance of the core web server process binds to its own instance of the Web Gateway.

Another factor in choosing this approach might be that the in-house requirements of your web master (or ISP) dictate that all web server extensions are implemented using the CGI protocol.

IIS 7 does not, by default, run ISAPI extensions, ISAPI filters or CGI modules. This option requires the CGI modules service.

Follow the instructions in for installing the CGI service, Installing the ISAPI and CGI Services.

Configure the web server so that it recognizes InterSystems file types and passes them to the Web Gateway for processing.

Enabling the CGI Modules

Executables: nph-CSPcgi.exe and nph-CSPmsSys.exe

Before these modules can be used they must be registered with IIS as being “Allowed” applications. This is done in the Internet Information Services (IIS) Manager control panel.

  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

  3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

  4. In the right panel, select Add.

  5. In the Add ISAPI or CGI Restriction dialog, enter:

    ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

    Description: WebGatewayRunTime

    Allow extension path to execute: Select

    Select OK.

  6. Repeat the above steps for nph-CSPcgiSys.exe, entering the following details in the Restrictions dialog:

    ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

    Description: WebGatewayManagement

    Allow extension path to execute: Select

Mapping InterSystems IRIS File Extensions

Choose one of the following configuration methods:

  • Serve all content (including static content) from InterSystems IRIS. Map * to the Web Gateway. If you are configuring the web application in InterSystems IRIS so that the InterSystems IRIS server serves all static files, see Mapping Additional File Types.

  • Serve static content from the web server.

    Map only InterSystems file types to the Web Gateway.

If you are serving static files from the web server, map the InterSystems file types to the Web Gateway CGI modules as follows:

Extension Binary
*.csp C:\Inetpub\CSPGateway\nph-CSPcgi.exe
*.cls C:\Inetpub\CSPGateway\nph-CSPcgi.exe
*.zen C:\Inetpub\CSPGateway\nph-CSPcgi.exe
*.cxw C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe
  1. Open the Internet Information Services (IIS) Manager window.

  2. In the left panel expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

    [MACHINE_NAME] ([machine_name]\[user_name])
                Web Sites
                        Default Web Site
    Note:

    This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

  3. In the middle panel, double-click the Handler Mappings icon.

  4. In the right panel, select Add Script Map.

  5. In the Add Script Map dialog, enter:

    Request Path: *.csp

    Executable: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

    Name:WebGateway_csp

  6. Select Request Restrictions.

    Clear: Invoke handler only if request is mapped to

    Select OK to return to the Add Script Map dialog.

    Select OK.

  7. At this point you may be prompted as follows: “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

    Select Yes.

  8. You can later find the list of allowed applications as follows:

    In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

    In the middle panel, double-click the ISAPI and CGI Restrictions icon.

    If the Web Gateway CGI components are not included in the list of allowed applications, add them.

    You can add text of your own choice in the Description field. For example:

    WebGatewayManagement for nph-CSPcgiSys.exe

    WebGatewayRunTime for nph-CSPcgi.exe

  9. Repeat the above process: Use the Add Script Map dialog to enter the following two mappings:

    Request Path: *.cls

    Executable: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

    Name: WebGateway_cls

    Request Path: *.zen

    Executable: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

    Name: WebGateway_zen

    Request Path: *.cxw

    Executable: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

    Name: WebGatewayManagement

Operating and Managing the Web Gateway

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

  1. Start the CSP NSD as described in the section dedicated to this service.

To access the Web Gateway’s Systems Management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp-bin/nph-CSPcgiSys

If you see an unauthorized user error message, see Web Gateway and Security.

FeedbackOpens in a new tab