Proxy

Select System Configuration > Network & Email.

  • Estimated Time Required: 15-20 minutes
  • Skill Level: Intermediate
  • Prerequisites:
    • Proxy server address is known.

A proxy server is a computer on your LAN that allows you to connect to external servers without compromising the security of your internal network. If you are consuming FME Flow Web Services and your organization uses a proxy server on your network, you can configure FME Flow to connect through the proxy.

What is not supported on a proxy in FME Flow?

  • Certain Database Connections, including connections to MongoDB databases, will fail. Safe Software has not fully tested proxy support for all database formats; you may need to test your database connections to determine support.
  • If Authentication Method Digest or NTLM is specified, these connections will fail:
  • Automations or Notification Service protocols (including triggers, external actions, publishers, and subscribers) that do not communicate through HTTP. These protocols include watching directories, email (SMTP and IMAP), FTP, JMS, SFTP, UDP, and WebSocket.
  • (Windows) Any applicable Exceptions configured in your Proxy server LAN Settings (under Internet Properties) or in a PAC file.
  • (Linux) Any applicable exceptions configured in network tools or the /etc/environment file.

Can I map URLs through a custom proxy?

Custom proxy maps must be configured manually. For more information, see To Configure Custom Proxy Maps (Manual) (below).

To Configure FME Flow with a Proxy Server

Click Proxy. Complete the following fields, and click Save.

Note  If Version Control is enabled, you must restart FME Flow to apply any changes to proxy settings.
  • Proxy Enabled: Click to enable a proxy connection.
  • Host: The proxy server hostname.
  • Port: The port through which communication with the proxy server takes place.
  • No Proxy For: (optional) A list of hostnames and IP addresses that will be accessed through a direct connection, bypassing the proxy. To avoid entering multiple hosts in the same domain, hosts can be prefixed and appended with the wildcard character *.

    • To delimit the list, use commas, semicolons, or press the tab or enter keys. Do not copy-paste a list of entries. To delineate properly in the display, each entry must be added separately.

    Example:

    Note  Specifying localhost does not include, by default, 127.0.0.1 or ::1. To bypass the proxy when the local host is referenced, you must explicitly specify any other expected forms for referencing local traffic.
  • Authentication Required: Click if authentication is required to access the proxy server.
    • Username: The account username for running the proxy server, and complete the following:
    • Password: The password for the proxy server account.
    • Authentication Method: The authentication method used by the proxy server, either Basic, Digest, or NTLM.

To Configure Custom Proxy Maps (Manual)

You can specify custom proxy maps instead of using the system proxy. A custom proxy map allows you to map access to specific URLs through an alternative proxy on your system. Use a custom proxy map if you need to bypass your network's default rules or system proxy settings in order to access these URLs.

When configuring custom proxy maps, keep in mind the following:

  • Unlike a system proxy, custom proxies apply only to connections from FME Engines. Connections from the FME Flow Core, such as accessing Resources, Database Connections and Web Connections, and Automations trigger and external action notifications, are not supported through custom proxies.
  • Custom proxy maps do not work in conjunction with configuring a system proxy (above). You can configure only one or the other.
  1. Run the Windows Command Prompt as administrator, and navigate to: $(FME_SERVER_HOME)\Server\fme
  2. Run the following command, repeating all parameters for each URL you want to map through the custom proxy, as shown:

    3. fme.exe APPLY_SETTINGS SYSTEM "Proxy/Custom Proxy Map" "<Source_URL>,<Proxy_URL>,<Proxy_Port>,<Requires_Authentication>,<UserName>,fme_encrypt(<Password>),<Authentication_Method>[,<Source_URL>,<Proxy_URL>,<Proxy_Port>,<Requires_Authentication>,<UserName>,fme_encrypt(<Password>),<Authentication_Method>]"

    Where:

    • <Source_URL> is the URL you want to access. The URL must be an exact match with the URL in the request; for example, http://www.lib.uwaterloo.ca/locations/umd/digitization_project/Roads_NTDB.zip.
    • <Proxy_URL> is the URL of the proxy server on your system that will handle requests to the <Source_URL>.
    • <Proxy_Port> is the port number on the proxy server through which requests are handled.
    • <Requires_Authentication> is true or false, depending on whether the proxy server requires authentication to access. If true, provide <UserName>, <Password>, and <Authentication_Method> (Basic, Digest, or NTLM).
  3. Open fmeServerConfig.txt.
  4. Under the heading FME SERVER SETTINGS START, add the following line:

    5. ENABLE_ENGINEPROXY=false

  5. Save and close the file.
  6. Restart FME Flow.

Other Notes

To use a proxy server without authentication, instead specify:

fme.exe APPLY_SETTINGS SYSTEM "Proxy/Proxy Server Require Authentication" "false"

To stop using the proxy server, run:

fme.exe APPLY_SETTINGS SYSTEM "Proxy/Proxy Setting" "No Proxy"

  1. Run the Linux command line and navigate to: /opt/fme-engine-<year>, where <year> is the FME Flow release version, such as 2016.
  2. For each URL you want to map through the custom proxy, run the following command:

    3. ./fme APPLY_SETTINGS SYSTEM "Proxy/Custom Proxy Map" "<Source_URL>,<Proxy_URL>,<Proxy_Port>,<Requires_Authentication>,<UserName>,<Password>,<Authentication_Method>"

    Where:

    • <Source_URL> is the URL you want to access. The URL must be an exact match with the URL in the request; for example, http://www.lib.uwaterloo.ca/locations/umd/digitization_project/Roads_NTDB.zip.
    • <Proxy_URL> is the URL of the proxy server on your system that will handle requests to the <Source_URL>.
    • <Proxy_Port> is the port number on the proxy server through which requests are handled.
    • <Requires_Authentication> is true or false, depending on whether the proxy server requires authentication to access. If true, provide <UserName>, <Password>, and <Authentication_Method> (Basic, Digest, or NTLM).
  3. Open fmeServerConfig.txt.
  4. Under the heading FME SERVER SETTINGS START, add the following line:

    5. ENABLE_ENGINEPROXY=false

  5. Save and close the file.
  6. Restart FME Flow.

Other Notes

To use a proxy server without authentication, instead specify:

./fme APPLY_SETTINGS SYSTEM "Proxy/Proxy Server Require Authentication" "false"

To stop using the proxy server, run:

./fme APPLY_SETTINGS SYSTEM "Proxy/Proxy Setting" "No Proxy"