Create an internal data download service (to complement a reverse proxy data download) (2014 and older)

<FMEServerDir> is the FME Server installation directory. For example, C:\apps\FMEServer
<WebApps> is the directory containing the individual web applications for FME Server. For example, <FMEServerDir>\Utilities\tomcat\webapps
<host>:<port> is the internal name of the server and port number

Add the service definition

• Open the FME Server Admin UI.
• Click the Services Tab > New
  • Name: fmedatadownload2
  • Display name: Internal Data Download
  • URL Pattern: http://<host>:<port>/fmedatadownload2

Add the FME Engine configuration

• Open \Server\ fmeEngineConfig_Engine1.txt in a text editor
• Copy the entire FILE_DOWNLOAD_SERVICE subsection and paste it underneath the existing one.
• Rename the copied subsection to FILE_DOWNLOAD_SERVICE2.
• Modify the section as follows:

SUB_SECTION FILE_DOWNLOAD_SERVICE2 \
FME_WORKING_DIR "!FME_SERVER_ROOT!/DefaultResults2" \
FME_TRANSFORMATION_LOG_DIR "!FME_SERVER_ROOT!/Logs/datadownload2" \
FME_TRANSFORMATION_LOG_NAME "!FME_AUTO_FILE_NAME_JOBID!.log" \
PRE_COMMAND mkdir "!FME_AUTO_DIR_NAME!" \
MACRO_DEF FME_SERVER_DEST_DIR "!FME_AUTO_DIR_NAME!/" \
SUCCESS_RESPONSE 0:Translation Successful|NotificationLocation=!FME_AUTO_DIR_NAME!_nw|
OutputLocation=!FME_AUTO_DIR_NAME!|ResultPrefix=http://<host>:<port>|
ResultRootDir=/fmedatadownload2/results|NumFeaturesOutput=!FME_NUM_FEATURES_OUTPUT!|
LogFileName=datadownload2/!FME_TRANSFORMATION_LOG_NAME! \
FAILURE_RESPONSE !FME_ERROR_NUMBER!:!FME_ERROR_MSG!|LogFileName=datadownload2/!FME_TRANSFORMATION_LOG_NAME!

• Copy the new subsection definition into the other fmeEngineConfig files. For the master file (no engine number), the same process should be followed, but as there are additional directives in the subsection, it should not be copied over from the other files.

Create the web application for the new service

• Place the fmedatadownload2.war file in <WebApps> and wait for it to deploy. Deployment will create a folder called fmedatadownload2.
• Copy <WebApps>\fmedatadownload\WEB-INF\conf\propertiesFile.properties into the corresponding location in fmedatadownload2
• Open the copied properties.properties file (see attached) in a text editor and add/modify the following lines after the line that starts with 'SECURITY_CLIENT_ID='

 #ENGINE_SUBSECTION - The subsection name used for workspace transformation ENGINE_SUBSECTION=FILE_DOWNLOAD_SERVICE2

Tell the Web UI how to handle the new service

FME Server 2013 and later

In FME Server 2013 and later, there are multiple references to fmedatadownload in the fmeserver web application. fmedatadownload2 should be added in all these cases, so that the new service will behave in the same way as the standard one.

Changes to be made:

File 1
<WebApps>\fmeserver\js\fme-web\app\controller\WorkspaceConfig.js
Old line
if (serviceName.toLowerCase() === 'fmedatadownload'||serviceName.toLowerCase() === 'fmejobsubmitter'){
New line
if (serviceName.toLowerCase() === 'fmedatadownload'||serviceName.toLowerCase() === 'fmejobsubmitter' || serviceName.toLowerCase() === 'fmedatadownload2'){

File 2
<WebApps>\fmeserver\js\fme-web\app\view\repositories\RepositoryItemView.js
Old line
'<tpl case="fmedatadownload" case="fmejobsubmitter">' +
New line
'<tpl case="fmedatadownload" case="fmejobsubmitter" case="fmedatadownload2">' +

File 3
<WebApps>\fmeserver\js\fme-web\app\view\RepositoriesView.js
Old line
hidden: (fme.serviceName !=="fmedatadownload" && fme.serviceName !== "fmejobsubmitter"),
New line
hidden: (fme.serviceName !=="fmedatadownload" && fme.serviceName !== "fmejobsubmitter" && fme.serviceName !=="fmedatadownload2"),

File 4
\fmeserver\sectionViews\ test.jsp
Old line
if (fme.serviceName=="fmedatadownload" || fme.serviceName =="fmejobsubmitter"){
New line
if (fme.serviceName=="fmedatadownload" || fme.serviceName =="fmejobsubmitter" || fme.serviceName=="fmedatadownload2"){

File 5
<WebApps>\fmeserver\sectionViews\WorkspaceConfigSectionView.js
Old line
if (fme.serviceName==="fmedatadownload" || fme.serviceName ==="fmejobsubmitter"){
New line
if (fme.serviceName==="fmedatadownload" || fme.serviceName ==="fmejobsubmitter" || fme.serviceName==="fmedatadownload2"){

File 6
\fmeserver\WEB-INF\jsp\ configure-workspace.jsp
Old line
if (fme.serviceName=="fmedatadownload" || fme.serviceName =="fmejobsubmitter"){
New line
if (fme.serviceName=="fmedatadownload" || fme.serviceName =="fmejobsubmitter" || fme.serviceName=="fmedatadownload2"){

FME Server 2012 and earlier

• Open <WebApps>\fmeserver\WEB-INF\web.xml (see attached) in a text editor
• Locate the following line:

fmedatadownload : COM.safe.fmeserver.webui.plugins.DataDownloadPlugin

• Duplicate this line and replace 'fmedatadownload' with 'fmedatadownload2'.

Test it out

• Publish a workspace to FME Server and register it with the new, internal data download service
• Open the FME Server Web UI and browse to the workspace you published
• Run the workspace through the new service
• The Download Results URL should provide the correct link