Introduction

Please download the tutorial data before starting the examples below. The tutorial will work for FME Server 2016. For earlier versions of FME Server, please refer to this article (https://knowledge.safe.com/articles/729/fme-server-resources-uploading-referencing-and-con.html)

Resource folders are a convenient storage area for uploading and storing data, and data being stored in a resources folder can be used when publishing or running workspaces. In addition, existing directories (such as UNC shares) can be mounted and used when publishing from workbench, or browsed when submitting a job through the web interface.

Downloads

required-data.zip

Example 1: Upload Data Via the FME Server Web Interface

This example will demonstrate how to upload data to a Resources folder on FME Server through the web interface, and then utilize the data when running a job from a published workspace

(1) Upload data to FME Server through the web interface

• Open the Web Interface > Manage > Resources
• Select the Data folder > click New Folder > enter your first name
• Select the new folder and click Upload
• Click Choose Folder > browse to the downloaded tutorial data and select CityData.gdb

(2) Generate a simple workspace

• Open Workbench > File > New > Generate Workspace
• Source: ESRI Geodatabase (File Geodb Open API), TutorialDownloadPath/data/CityData.gdb
• Select only the CITY_GRID
• Destination: ESRI Geodatabase (File Geodb Open API)
• Run the workspace to test to see that it is working correctly
• File > Publish to FME Server > create new repository named "Resources Tutorial" > Use workspace name: example1.fmw
• Register with Data Download service.

(3) Browse and use data uploaded to FME Server

• Open the Web Interface. From the Last Published Workspaces, navigate to and select example1.fmw
• Source Geodatabase > Browse ellipse ‘...’ > Resources Tab > Data > your first name > check the CityData.gdb folder > Run Workspace

Example 2: Upload Data Via FME Workbench

This example will demonstrate how to upload data to a Resources folder when first publishing a workspace from FME Workbench using the ‘select files’ option. This data then becomes available for use at any time by other published workspaces.

(1) Generate a simple workspace

• Open Workbench > File > New > Generate workspace
• Source: MapInfo TAB (MITAB), TutorialDownloadPath/data/parks.tab
• Destination: MapInfo TAB (MITAB)
• Run the workspace to test to see that it is working correctly

(2) Publish a workspace and upload data

• File > Publish to FME Server > Repository: Resources Tutorial > Use workspace name: example2.fmw
• Click "Select Files..."
• Check the ‘Files’ checkbox to select all the files
• Click "Select Location..."
• Check "Upload to a shared resource folder"
• Click Location … > Data > first name. OK. OK
• Register with the Job Submitter service and finish publishing
• Open the Web Interface. From the Last Published Workspaces, navigate to and select example2.fmw
• Source MapInfo TAB > notice that the resource folder is already specified
• Now that the data is already up there you can reference it in future workspaces that require the CityParks.tab dataset.

Example 3: Add a Resource Folder From a Network Location

This example demonstrates how to add a directory on your network as an accessible resource on FME Server (not applicable to FME Cloud).

(1) Configure the network resource

• Follow the instructions under the heading 'Adding Resource Directories' at the bottom of the following page: Managing Resources on FME Server

• Load the Web Interface and click on the Manage > Resources section. Make sure the new resource is listed. Note: If you have not already changed the user account that the FME Server Core service is using then please use guide here.

(2) Run a workspace using the new network resource

• Open the Web Interface. From the Last Published Workspaces, navigate to and select example2.fmw
• Source MapInfo TAB > Browse ellipse ‘...’ > navigate to your network resources folder > Run

Example 4: Using a Resource Folder Within a Workspace

This example demonstrates how to create a macro that contains a resource location and then utilize it within an FME Workspace. Note: if you see an error message such as "Failed to open...", you may need to change the user account that the FME Server Engines service is using. See guide here.

(1) Create a Macro allowing direct access to the Resource

• On the FME Server machine, open the <FMEServerDir>/Server/fmeEngineConfig.txt file
• Find MACRO_DEF FME_SHAREDRESOURCE_BACKUP "C:/ProgramData/Safe Software/FME Server///resources/backups/"
• add a \ character to the end of the line:

MACRO_DEF FME_SHAREDRESOURCE_BACKUP "C:/ProgramData/Safe Software/FME Server///resources/backups/"

• Add the following, replacing the <hostname> with the actual machine hostname:

MACRO_DEF FME_SHAREDRESOURCE_MYDATA "//<hostname>/data/"

• Save the file
• Restart FME Server

(2) Testing the Macro

To test a workspace containing a macro, create a new workspace that makes use of a private parameter to define the source dataset.

• Open example2.fmw
• Create a new private parameter. Type: Text, Name: FME_SHAREDRESOURCE_DATA, Prompt Value: <local path to the resource>, (e.g.) C:\data
• Remove the Source Parameter and add the private parameter FME_SHAREDRESOURCE_DATA created in the example above
• Publish the workspace to FME Server
• Register with the Job Submitter service and finish publishing
• Open the Web Interface. From the Last Published Workspaces, navigate to and select example2.fmw. Run the workspace.

Once the workspace has been published to FME Server, the private parameter that points to the local resource path will be replaced by the macro that was defined in the fmeEngineConfig.txt configuration file.

4a: Read Data within a Resource Folder

This example demonstrates reading data, using a macro to specify the location.

(1) Add the Macro to a simple workspace reader

• Open example2.fmw
• Expand the MITAB Reader
• Remove Source Parameter and add the Resource Macro created in the example above: $(FME_SHAREDRESOURCE_MYDATA)/Parks.tab

(2) Publish and run the workspace

• File > Publish to FME Server > Repository: Resources Tutorial > Use workspace name: example3.fmw
• Click Select Files
• Make sure that 0 files are set to upload
• Register with the Job Submitter service and finish publishing
• Open the Web Interface. From the Last Published Workspaces, navigate to and select example3.fmw. Run the workspace.

4b: Write Data to a Resource Folder

This example demonstrates writing data, using a macro to specify file location.

(1) Add the Macro to a simple workspace writer

• Open Workbench > File > New > Generate workspace
• Source: MapInfo TAB (MITAB), TutorialDownloadPath/data/parks.tab
• Destination: Esri Shape (SHAPE)
• Add the Resource folder to the Dataset parameter: (FME_SHAREDRESOURCE_MYDATA)/Parks.tab

(2) Publish and run the workspace

• File > Publish to FME Server > Repository: Resources Tutorial > Use workspace name: example4.fmw
• Click Resources
• Make sure that 0 files are set to upload
• Finish publishing
• Open the Web Interface. From the Last Published Workspaces, navigate to and select example4.fmw. Run the workspace.
• Open the network directory and confirm that new shapefiles have been added.

4c: Use a Resource Folder File in a Parameter

This example demonstrates how to utilize a macro in order to access files in a Resource folder. This method can be used to allow files to be used in reader and writer parameters. For example seed, template or SDE connection files can be specified and shared between workspaces.

(1) Add the Macro to a simple workspace writer

• Open Workbench > File > New > Generate Workspace
• Source: MapInfo TAB (MITAB), TutorialDownloadPath/data/parks.tab
• Destination: AutoCAD Map 3D (AUTOCAD_OD)
• Create a new Private Parameter;
• Type: Text Name: Template_File Prompt: My Template File: Value: $(FME_SHAREDRESOURCE_MYDATA)/template.dwt

• Expand the Parks Writer and Right-click the "Template File" Parameter: Link to User Parameter > Resources_Dir

(2) Publish and run the workspace

• File > Publish to FME Server > Repository: Resources Tutorial > Use workspace name: example5.fmw
• Click Resources
• Make sure that 0 files are set to upload
• Finish publishing
• Open the Web Interface. From the Last Published Workspaces, navigate to and select example5.fmw.
• Source MapInfo TAB > Browse ellipse ‘...’ > navigate to your network resources folder > check parks.tab > Run