You are here: Reference Manual > FME Server Web Services > Utility Services > REST Service > Key Service Properties

Web Application Properties

FME REST Service Properties File Content

# -----------------------------------------------------------------------------
# FME REST Servlet configuration file
# -----------------------------------------------------------------------------
# This file details the installation parameters of the Stream Download Servlet.
#
# -----------------------------------------------------------------------------
# Server name and version
SERVER_VERSION = {SAFE{fmeserverName}}
 
# The current FME server build string containing version number information
BUILD_STRING = {SAFE{fmeserverBuild}}
 
# SERVER_NAME - The computer where the FME Server is running. Can be specified
# as a network name (ie: "ATHENA") or an IP. The default value is
# "localhost".
SERVER_NAME={SAFE{fmeserverHostnameLocal}}
 
# SECURITY_FME_SERVER_CLUSTER - The security FME Server cluster used for authentication
SECURITY_FME_SERVER_CLUSTER={SAFE{securityCluster}}
 
# SERVER_PORT - The port on which the FME Server is running on the remote
# machine. This is an integer between 1025 and 65535.
# The default value is the default Transformation Manager listening port,
# which is 7071.
SERVER_PORT={SAFE{fmeserverRequestPort}}
 
# DEPLOYMENT_PORT - The port on which the Process Manager for system-level processes is listening.
DEPLOYMENT_PORT={SAFE{processMonitorAdminPortCore}}
 
# SCHEDULER_PORT - The port on which the Scheduler Manager is listening.
SCHEDULER_PORT={SAFE{schedulerPort}}
 
# NOTIFIER_REQUEST_PORT - The request port of FME Notifier
NOTIFIER_REQUEST_PORT={SAFE{notifierRequestPort}}
 
# RELAYER_REQUEST_PORT - The request port of FME Relayer
RELAYER_REQUEST_PORT={SAFE{relayerRequestPort}}
 
# CONFIGURATION_REQUEST_PORT - The request port of FME Configuration
CONFIGURATION_REQUEST_PORT={SAFE{fmeConfigRequestPort}}
 
# MOUNT_POINT_REQUEST_PORT - The request port of FME Mount Point Manager
MOUNT_POINT_REQUEST_PORT={SAFE{mountpointRequestPort}}
 
# NAMED_CONNECTION_REQUEST_PORT - The request port of FME Connection Manager
NAMED_CONNECTION_REQUEST_PORT={SAFE{connectionRequestPort}}
 
# CONNECTION_POOL_EXPIRY - The length of time in seconds in which an FME Server connection remains idle
# before expiring from the connection pool.
# If a value of less than or equal to zero is specified, then there is no
# connection pooling.
CONNECTION_POOL_EXPIRY=300
 
# RESOURCE_PATH - This is the path to the textual resources of the log.
# This file stores all the messages that will appear in the
# log as well as their code.
RESOURCE_PATH={SAFE{resourcesDir}}
 
# FME_SHAREDRESOURCE_LOG - This is the path to the Server logs directory.
FME_SHAREDRESOURCE_LOG={SAFE{repositoryServerRootDir}}/resources/logs/
 
# FME_SHAREDRESOURCE_DATA - This is the path to the Server data directory.
FME_SHAREDRESOURCE_DATA={SAFE{repositoryServerRootDir}}/resources/data/
 
# FME_SHAREDRESOURCE_TEMP - This is the path to the Server temp directory.
FME_SHAREDRESOURCE_TEMP={SAFE{repositoryServerRootDir}}/resources/temp/
 
# FME_SHAREDRESOURCE_SYSTEM - This is the path to the Server system directory.
FME_SHAREDRESOURCE_SYSTEM={SAFE{repositoryServerRootDir}}/resources/system/
 
# FME_SHAREDRESOURCE_DASHBOARD - This is the path to the Server dashboards directory.
FME_SHAREDRESOURCE_DASHBOARD={SAFE{repositoryServerRootDir}}/resources/dashboards/
 
# FME_SHAREDRESOURCE_BACKUP - This is the path to the Server backup directory.
FME_SHAREDRESOURCE_BACKUP={SAFE{repositoryServerRootDir}}/resources/backups/
 
# FME_SHAREDRESOURCE_ENGINE - This is the path to the Server engine directory.
FME_SHAREDRESOURCE_ENGINE={SAFE{repositoryServerRootDir}}/resources/engine/
 
# MIN_TIME_BETWEEN_REQS - This is the minimal amount of time that a client
# must wait before sending another request. If a
# request is sent before that interval, it will be
# ignored. The time is specified in milliseconds.
MIN_TIME_BETWEEN_REQS=1000
 
# LOG_CONFIG_PATH - The folder path that contains the log file configuration.
LOG_CONFIG_PATH={SAFE{utilitiesDir}}/config
 
# LOG_FILE_NAME - The file name that the log files will have in common.
LOG_FILE_NAME=rest.log
 
#DEFAULT_RESPONSE_FORMAT - The default response format
DEFAULT_RESPONSE_FORMAT=HTML
 
#DEFAULT_USER_ID - The default user ID to log in FME Server
DEFAULT_USER_ID=guest
 
#DEFAULT_PASSWORD - The default password for default user ID
DEFAULT_PASSWORD=guest
 
#SECURE_CLIENT_ADDRESS - A boolean value that determines if token authentication includes the client
# address. Set it to true if enhanced security is required. The default value
# is false.
SECURE_CLIENT_ADDRESS=false
 
#TOKEN_PROVIDER - URL to the Token Provider Service which by default is on same App Server.
TOKEN_PROVIDER=/fmetoken
 
#HTML_TEMPLATE_DIRECTORY - The directory where the HTML response XSLT templates are stored.
HTML_TEMPLATE_DIRECTORY={SAFE{resourcesDir}}/clients//fmerest/htmlTemplates
 
#LOCALE_CONFIG_PATH - the path to the FME localization config file which contains the FME_LOCALE property
#
# If no file path or an invalid file path is specified, then the default system locale is used.
#
# If a valid file path is specified, the FME locale in the specified file is used.
# If there is no FME_LOCALE property in the file, then the default system locale is used.
#
# The language, country and variant are separated by underscores.
# Language is always lower case, and country is always upper case.
# Examples: "en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr__MAC"
#
LOCALE_CONFIG_PATH={SAFE{resourcesDir}}/fmeLocaleConfig.txt
 
#FAILOVER_SERVER_NAME - (Optional) The name of the FME Server host that is designated for failover.
# If connection to the primary FME Server is lost, the Service will attempt to connect
# to the specified FME Server host that is designated for failover.
#
# To use FAILOVER_SERVER_NAME below, uncomment the line and replace <failoverServerName> with
# the FME Server failover host name. Do not include the angle-brackets in the failoverServerName.
# For example: FAILOVER_SERVER_NAME=fmecore2
#
#FAILOVER_SERVER_NAME=<failoverServerName>
 
# CORS Shared Configuration File - File system path to the configuration file for cross-origin resource sharing that
# is itself shared by all FME Server services.
CORS_SHARED_CONFIGURATION_FILE={SAFE{resourcesDir}}/clients/cors.properties
 
# Charset Encoding Filter Configuration File - File system path to the configuration file for
# charset encoding filter.
CHARSET_ENCODING_FILTER_CONFIGURATION_FILE={SAFE{resourcesDir}}/clients/charsetEncoding.properties
 
################### Stream Download Servlet configuration file END #####################