FME Server REST API Manual Deployment (2010 or previous)

Downloads

• Rest.zip

THIS ARTICLE APPLIES TO FME SERVER 2010 OR PREVIOUS.

Here are the steps to deploy the REST API (assuming the servlet engine is Tomcat):

• When Apache Tomcat is running, copy file fmerest.war to <Tomcat Dir>\webapps. Make sure the WAR file is automatically expanded to folder ‘fmerest’
• In ‘<Tomcat Dir>\webapps\fmerest\WEB-INF\conf’ folder, rename ‘propertiesFile.propertiesTEMPLATE’ to ‘propertiesFile.properties’.
• Open the ‘propertiesFile.properties’ file in a text editor and replace the place holders below with your actual values (make sure you use forward-slashes / not back-slashes \, and replace everything including the curly-braces, eg. {SAFE{fmeserverHostname}} becomes localhost):

1. {SAFE{fmeserverHostname}}, the host name of your FME Server. If the Server is running locally, it’s ‘localhost’.
2. {SAFE{fmeserverRequestPort}}, the request port of your FME Server. It should be 7071 for most of the time.
3. {SAFE{resourcesDir}}, the path to the texual resources of the log, e.g. C:/Program Files/FMEServer/Server/resources
4. {SAFE{clientsDir}}, the path to the clients directory in FME Server installation, e.g. C:/Program Files/FMEServer/Clients

• Stop and restart Tomcat.

If you have build before 6376 you also need to do the following:

• In you In your fmeEngineConfig*.txt files, you should have the subsection definition below (ensure that there are no blank lines between the lines):

SUB_SECTION REST_SERVICE \
FME_MAPPING_DIR "C:/Program Files/FMEServer/Server/repository" \
FME_TRANSFORMATION_LOG_DIR "C:/Program Files/FMEServer/Logs/rest" \
SUCCESS_RESPONSE 0:Translation Successful|NumFeaturesOutput=!FME_NUM_FEATURES_OUTPUT!|LogFileLocation=C:/Program Files/FMEServer/Logs/jobsubmitterservice/!FME_AUTO_FILE_NAME_SIMPLE.log! \
FAILURE_RESPONSE !FME_ERROR_NUMBER!:!FME_ERROR_MSG!|LogFileLocation=C:/Program Files/FMEServer/Logs/jobsubmitterservice/!FME_AUTO_FILE_NAME_SIMPLE.log!

• Folder ‘C:\Program Files\FMEServer\Logs\rest’ should exist
• Folder ‘C:\Program Files\FMEServer\Clients\resources\fmerest\htmlTemplates’ should exist with a list of XSL template files. If not, unzip the zip file \\shockwave\Dropbox\REST\htmlTemplates.zip to get templates.
• Now restart FME Server itself by restarting the Windows Service
• The FME Server Rest service should now be available from the following url: http://<host>:<port>/fmerest