-
Welcome to FME Workbench
What's New in FME Desktop?
n Explore What's New and Great
FME Desktop Help Map
This map will help you find the information you need, from
getting started to technical resources:
n FME Desktop Help
Download Transformer Quick-Reference
Click the link below to open a printable booklet in PDF
format:
n FME Transformers Reference Guide
Note that you must have a PDF reader to open this file. You can
get Adobe Reader from here for free.
Getting Started
n Workbench interface...
n Using Templates
n Create a new workspace...
n Look up transformers...
Copyright and Trademark Notices
http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://www.adobe.com/products/acrobat/readstep2.html
-
Welcome to FME Workbench
What's New in FME Desktop?
n Explore What's New and Great
FME Desktop Help Map
This map will help you find the information you need, from
getting started to technical resources:
n FME Desktop Help
Download Transformer Quick-Reference
Click the link below to open a printable booklet in PDF
format:
n FME Transformers Reference Guide
Note that you must have a PDF reader to open this file. You can
get Adobe Reader from here for free.
Getting Started
n Workbench interface...
n Using Templates
n Create a new workspace...
n Look up transformers...
Copyright and Trademark Notices
http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://www.safe.com/highlight/fme2013/http://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://www.adobe.com/products/acrobat/readstep2.html
-
FME Desktop Help
Installed product documentation is accessed from the Start menu
> FME Desktop > Documentation, from any FME component
Help menu, or inthe FME installation directory > help.
FME Desktop documentation includes:
Documentation Description
FME Workbench The primary FME Desktop application for
translating and transforming data.
FME Data Inspector Allows you to view data in any FME-supported
format. Use the Data Inspector to preview data before translation,
ver-ify it after translation, and check data at any point during a
translation.
FME Readers andWriters
A reference to the 300+ spatial and non-spatial data formats
that FME Workbench is capable of reading and writing.
FME Reader andWriter Parameters
A reference to the FME reader and writer format parameters,
which control how data is read and written.
FME Transformers A reference to the 400+ FME transformers. These
objects are used in FME Workbench to perform geometric andattribute
restructuring of features during a translation.
FME Coordinate Sys-tems
A guide to associating coordinate systems with features in FME
Desktop.
FME Quick Translator A lightweight alternative to FME Workbench,
the Quick Translator allows you to perform fast and easy data
con-versions.
FME Integration Con-sole
Allows you to integrate certain third-party applications with
FME Desktop.
Additional Resources
Safe Software provides the following additional resources to
assist in learning about FME Desktop:
l FME Getting Started Guide
Discover just how easy it is to get up and running with FME.
This handy guide is available from the Start menu > FME Desktop
> Doc-umentation > Getting Started with FME or at
http://fmepedia.safe.com/knowledgeDocumentation.
l FME Installation and Licensing Manual
Find out how to install and license your version of FME.
Available at http://fmepedia.safe.com/knowledgeDocumentation.
l FME Desktop Tutorial
Learn the basics about FME Desktop. Through detailed instruction
and step-by-step exercises you'll explore the power of FME
Desktopand learn how to accomplish several fundamental tasks.
Available at
http://www.safe.com/learning/training/on-demand/tu-torials/#desktoptutorial.
l FMEpedia
FMEpedia is the online source for all information on Safe
Software products including documentation, demos and support
resources:
http://FMEpedia.com
l Training
Training courses on FME Desktop and FME Server (offered by Safe
Software and our Value-Added Reseller (VAR) network)
The current public training calendar is available from:
http://fmepedia.safe.com/knowledgeDocumentationhttp://fmepedia.safe.com/knowledgeDocumentationhttp://www.safe.com/learning/training/on-demand/tutorials/http://www.safe.com/learning/training/on-demand/tutorials/http://www.safe.com/learning/training/on-demand/tutorials/http://www.safe.com/learning/training/on-demand/tutorials/http://fmepedia.com/
-
http://www.safe.com/learning > Course Schedule
Contact your Safe Software account manager to arrange a private
training course for your organization.
l Twitter
Read Safe Software news: @SafeSoftware
Discuss technical matters with Safe Software
Experts:@FMEDoctors
Find out about new FME features:@FMEEvangelist
http://www.safe.com/learninghttp://twitter.com/SafeSoftwarehttp://twitter.com/FMEDoctorshttp://twitter.com/FMEEvangelist
-
FME Workbench Transformers Reference Guide
Click the link below to open the guide (from Safe Software's
website). You can also right-click on the link and choose Save
Target As to save thefile directly to your computer or another
location.
n Transformers Reference Guide (PDF format)
Note that you must have Adobe Reader to open the PDF file. You
can get it from here for free.
http://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://cdn.safe.com/resources/fme/FME-Transformer-Reference-Guide.pdfhttp://www.adobe.com/products/acrobat/readstep2.html
-
What is FME?
FME (originally, the “Feature Manipulation Engine”) was designed
to overcomemany of the problems associated with traditional
translationmethods.
Traditionally the software used to translate geographic data to
a different format had limited capabilities. Most of the data would
be forcedthrough a limited data model causing much of the meaning
to be lost in translation. We call this a “thin-pipe
translation”.
What is Spatial ETL?
FME was the first tool designed to be a Spatial ETL application.
ETL (Extract, Transform and Load) can be described as a data
warehousing toolthat extracts data from a source, transforms it to
fit the users’ needs, and then loads it into a destination or data
warehouse.
Spatial ETL tools can read, write, and manipulate spatial data.
While an ETL tool must have processing capabilities for the various
column typesthat are in a non-spatial database or system, a spatial
ETL tool must also have the spatial operations – geoprocessing
capabilities that changethe structure and representation of spatial
data – needed to move data from one spatial database or GIS to
another.
How Does FME Work?
FME has a number of key characteristics:
Centralized
FME is a central engine amongst a whole array of supported
formats (right). Data can be read from any format and written to
any other. Thismeans adding support for a new format automatically
adds support to convert that data to or from any existing
format.
Semantic
FME has a rich data model designed to cover all possible
geometry and attribute types. Data will not lose meaning as it is
read. The only lim-itations are those inherent in the destination
format, and, where possible, FME will automatically compensate to
create a seamless translationprocess.
Thick-Pipe
The ‘T’ in ETL is what traditional format translators lack. FME
provides tremendous transformation functionality, resulting in
output that can bemuch greater than the sum of the inputs.
-
FME Components
Primary Components
FME is actually a number of different software applications that
comprise a number of spatial data handling components. All
applications listedhere are included with every edition of FME.
Browse your FME installation directory to access the
components.
FME Workbench
FME Workbench is an application for solving data translation and
processing problems.
With Workbench, underlying FME functionality is exposed in an
intuitive interface that allows you to graphically define a custom
data flow fromsource, through transformation, to destination.
Workbench has tools for defining the source and destination
dataset structure (or schema), and also for manipulating the
geometry and attrib-utes of spatial data.
Workbench is fully integrated to interact with other FME
applications such as the Universal Viewer (FME Data
Inspector). It is also integratedwith other products such as FME
Server, and is the authoring tool for FME Server models.
It is quite feasible that you will only ever need to use
Workbench and the FME Universal Viewer or FME Data
Inspector.
FME Universal Viewer
The FME Universal Viewer allows quick viewing of data in any
FME-supported format. It is used primarily for data validation and
quality assur-ance by allowing you to preview data before
translation, or review data after translation.
FME Data Inspector (FME technology preview)
The FME Data Inspector is a Safe Software technology preview,
intended to eventually replace the FME Universal Viewer. Although
it maintainsmany of the same features as the FME Universal Viewer,
the Data Inspector is cross-platform, it uses the latest display
technology, and it sup-ports 3D viewing.
For this release, users have the option of using both.
FME Quick Translator
FME Quick Translator (originally called the FME Universal
Translator) was the first FME application to be developed.
Translations are definedthrough a scripting language rather than a
graphic interface. For this reason, the Quick Translator is largely
superseded by FME Workbench;however, as its name suggests, it is
good to use for quick, format-to-format translations.
FME Command-Line Engine
The FME Command-Line Engine enables translation requests to be
submitted at the command-line level.
-
Developer Components
These additional development components are all included as part
of the standard FME package.
FME Objects
FME Objects is a software library for working with spatial data.
Application developers use FME Objects to add spatial data reading
and writingsupport into their stand-alone applications.
FME Application Extenders
FME Application Extenders are components by which FME technology
is used or embedded into other GIS applications. These are then
known asFME Enabled Applications. Application Extenders enable a
GIS product to view datasets not native to that application.
FME Plug-In SDK
The FME Plug-In SDK allows developers to add their own formats
or functionality to the FME translation core.
FME Integration SDK
The FME Integration SDK allows developers to create FME-enabled
applications for users who already have FME installed on the same
PC.
Localized Software
FME localization add-ons are available in other languages. For
more information, please see localized FME software and
documentation on ourwebsite.
About FME Server
Note: You must have an FME Server configured with your system in
order to take advantage of its features and benefits. Contact Safe
Soft-ware for details.
FME Server is a networked data transformation application that
uses the same underlying technology as FME Desktop. It can operate
on a local-area network or over the Internet.
FME Server has the following advantages:
l Desktop users can share translation resources through a
repository mechanism.
l Desktop users can run resource intensive translations on a
dedicated server.
l Non-FME users can run translations on demand.
l Translation output can be streamed directly to a chosen
spatial application.
FME Server allows users to easily share spatial data. It is
scalable, so it can easily grow as demands on the system
increase.
FME Server is also a Model-Driven Architecture (MDA) meaning it
processes data using predefined workflows. These workflows are
definedusing FME Desktop, making it simple to convert a desktop
process to one usable by a client anywhere.
FromWorkbench, you can communicate directly with an FME Server
by publishing and downloading workspaces. This allows you to
manageand share workspaces, data and published parameters, and
create services from FME's powerful data translation and
transformation tools.
For example, FME Server can create GeoRSS, WFS and WMS web
services, providing your data in a true web service
architecture.
See Publishing to an FME Server and Downloading from an FME
Server.
http://www.safe.com/technology/FMEplatform/localized.phphttp://www.safe.com/technology/FMEplatform/localized.phphttp://www.safe.com/technology/FMEplatform/localized.phphttp://www.safe.com/technology/FMEplatform/localized.phphttp://www.safe.com/technology/FMEplatform/localized.phpmailto:[email protected]:[email protected]:[email protected]:[email protected]
-
System Requirements
For a complete list of system requirements, including the
differences between 32-bit and 64-bit FME, please visit our
website.
Windows 32-bit (win32)
l Windows 7
l Windows Vista
l Windows 2008 Server
l Windows 2003 Server
l Windows® XP SP1
Windows 64-bit (win64):
l Windows 7 64-bit
l Windows Vista 64-bit
l Windows 2008 Server 64-bit
l Windows 2003 Server 64-bit
All 64-bit Windows editions listed above also support 32-bit
FME. Please visit www.safe.com for information on the differences
between32-bit FME and 64-bit FME.
For more information, please contact [email protected].
For FME Premium Editions, FME Smallworld Edition:
l TCP/IP network connection to an Esri® SDE server (to use the
SDE modules)
UNIX (command line only):
l IBM® RS/6000 AIX 6.1
Linux (Desktop Light [without Workbench]):
l Linux® Intel x64 (Red Hat Enterprise Linux AS/ES/WS 5.0)
Note that FME 2012+ releases are not provided on the Linux
Intel x86 platform.
Browser
l To view the Help files, you will need Internet Explorer 5.0 or
higher (6.0 recommended)
Specifications
System specifications will vary depending on your FME usage,
including the size of your data files. However, at minimum, we
recommend:
l Minimum Intel® Pentium® III or 4 processor
l 1 GB of RAM
l 1.5 GB of available disk space
Note: To run FME on the Citrix Platform, a Floating License is
required.
http://www.safe.com/products/desktop/specifications.php
-
FME Tutorial and Training Options
FME Tutorial
One of the best ways to get up to speed with FME is to download
the FME product tutorial.
On-Demand Training
Improve your proficiency with FME at a pace that suits your
schedule. Access a variety of self-guided modules – based on
official FME trainingcourses – for convenient learning from your
office.
Improve your proficiency with FME at a pace that suits your
schedule. Our FME self-study modules will help you build the FME
skills you need tosolve your data integration challenges. Work
through the complete package of 8 modules one at a time, as your
availability allows. Or, if you'realready an intermediate-level FME
user, dive right into the topics that interest you the most.
Scheduled Training Courses
For more in-depth, instructor-led training, consider taking one
of our FME Training Courses. Both regular and advanced courses are
offered,and each include practical exercises designed to help you
apply your new FME skills to common data processing tasks.
Choose from Training options.
FME Demos
Please visit the Safe Software website.
http://www.safe.com/support/onlinelearning/overview.phphttp://www.safe.com/support/onlinelearning/overview.phphttp://www.safe.com/support/onlinelearning/overview.phphttp://www.safe.com/support/onlinelearning/overview.phphttp://www.safe.com/support/onlinelearning/overview.phphttp://www.safe.com/learning/training/http://www.safe.com/support/demos/index.phphttp://www.safe.com/support/demos/index.phphttp://www.safe.com/support/demos/index.php
-
FME Filenames and Locations
Dataset Locations
Click on readers and writers in the Navigator and select Open
Containing Folder (Ctrl + O).
File Extensions
FME has many associated file extensions. The default
locations are listed here but can also change depending on where
you installed FME.
Filename/File Exten-sion
Type/Description Default Location
coordsys.db contains the names anddescriptions of all
prede-fined coordinate systems
FME installation directory
.fds Custom Formats My Documents\FME\Formats
.fme FME mapping file(FME Quick Translator)
user-defined
.fmv FME Universal Viewer file user-defined
.fmw FME Workbench work-space
My Documents\My FME Work-spaces
.fmwt FME Workbench tem-plate
This extension is alsoused for templates down-loaded from
theFME Store.
My Documents\FME\Templates
.fmx Custom Transformers My Documents\FME\Transformers
.fmxlist User-defined trans-former list
My Doc-uments\FME\Tra-nsformerCategories
.fmc FME catalog file
Contains instructions todirect Workbench todownload a
specifiedresource from FMEpe-dia.com. Since thesefiles contain only
instruc-tions (XML), they aresmall in size.
.gdc, .gsb, .las, .los,
.mrt, .txt, .csvCoordinate system andgrid data files
Reproject
Reproject\GridData
.wbtheme Workbench theme file My Documents\FME\Themes
MyCoordSysDefs.fme custom coordinate sys-tem definitions
In the FME installation directory,Reproject subdirectory
-
Local-CoordSysDefs.fme
This file is automaticallyloaded and made avail-able to each FME
ses-sion, to allow sites to addtheir own coordinate sys-tems. It
contains a seriesof COORDINATE_SYS-TEM_DEF, DATUM_DEF,
ELLIPSOID_DEF, and UNIT_DEFlines that define addi-tional,
site-specific coor-dinate systems.
You can edit these filesto add your own def-initions.
Reproject subdirectory under theFME installation directory
Defining Custom Units
-
Daylight Savings Time
FME’s performance is not affected in any way by changes in local
time zones related to daylight savings, or by extensions to the
number ofweeks of daylight savings time, as long as your computer’s
clock has been set to automatically adjust for daylight saving
changes.
If you are running FME on a Windows operating system, you can
ensure that this option is already set by opening the Control
Panel, selectingDate and Time options, then selecting the Time Zone
tab.
-
Adjusting Memory Resources
One issue that can affect FME performance when you're working
with very large datasets is available RAM.
If you run a very large dataset through a workspace, you may see
a message box that says “Out of Memory. Please free somememory,
thenchoose retry.” This means that no more memory can be
allocated.
You can try the following options:
n Refer to the hints on FMEpedia, in Performance Tuning FME.
n If you have 4 GB of RAM available, you can try turning on the
3GB switch.
http://fmepedia.safe.com/articles/How_To/Performance-Tuning-FMEhttp://fmepedia.safe.com/articles/How_To/Performance-Tuning-FMEhttp://fmepedia.safe.com/articles/How_To/Performance-Tuning-FME
-
Using the /3GB Switch
Note: The /3GB switch is not required for all, or even most,
users of FME. The /3GB switch will only benefit those who require
translationsthat will not currently run with 2GB of addressable
memory.
Thirty-two-bit versions of the Windows operating system can
manage a maximum of 4GB of addressable memory. The 4GB is divided
into 2GBfor user applications and 2GB for kernel processes. This
means that any given application is restricted to 2GB of
memory.
Beginning with FME 2006 GB, FME takes advantage of a /3GB switch
which causes the operating system to divide the available 4GB of
memoryinto 3GB for user applications and 1GB for kernel processes.
Many translations that previously failed due to memory limitations
will now run suc-cessfully when the /3GB switch is used.
Which operating systems support the 3GB Switch?
The /3GB switch is supported on the following operating
systems:
l Windows 7l Windows Vistal Windows XP Professionall Windows
Server 2003l Windows Server 2003, Enterprise Editionl Windows
Server 2003, Datacenter Editionl Windows 2000 Advanced Serverl
Windows 2000 Datacenter Serverl Windows NT Server 4.0, Enterprise
Edition
The /3GB switch is not supported on Windows 2000 Server.
Which version of FME do I need?
FME 2006 GB and greater.
How do I enable the 3GB Switch for Windows 7 or Windows
Vista?
1. Open the Accessories program group of the Start menu and
right-click on Command Prompt.
2. Click Run as Administrator.
3. At the command prompt, enter:
bcdedit /set IncreaseUserVa 3072
4. Restart your computer.
To disable the 3GB switch for Windows 7 or Windows Vista:1. Open
the Accessories program group of the Start menu and right-click on
Command Prompt.
2. Click Run as Administrator.
3. At the command prompt, enter:
bcdedit /deletevalue IncreaseUserVa
4. Restart your computer.
How do I enable the 3GB Switch for other versions of
Windows?
Before FME can use the /3GB switch, you will need to edit your
system’s boot.ini file.
You can access this file by doing the following:
-
1. Open the System Properties dialog. You can access this dialog
by either opening Control Panel and selecting System, or by
right-clickingon My Computer and selecting properties.
2. Select the Advanced tab at the top of the System Properties
dialog.
3. Click the Settings button under Startup and Recovery.
4. Click the Edit button under System startup. Notepad will open
with the boot.ini file.
Under [operating systems], there should be a line that ends with
/fastdetect. Add /3GB to the end of this line.
The following is an example of a boot.ini file before the /3GB
switch has been added:
[boot
loader]timeout=30default=multi(0)disk(0)rdisk(0)partition(2)\WINDOWS[operating
systems]multi(0)disk(0)rdisk(0)partition(2)\WINDOWS="Microsoft
Windows XP Professional" /fastdetect
When the /3GB switch is added, the above boot.ini file should
look like the following:
[boot
loader]timeout=30default=multi(0)disk(0)rdisk(0)partition(2)\WINDOWS[operating
systems]multi(0)disk(0)rdisk(0)partition(2)\WINDOWS="Microsoft
Windows XP Professional" /fastdetect /3GB
You will now need to restart your computer. When your computer
has finished rebooting, your translation should be able to finish
without run-ning out of memory.
To disable the 3GB switch for other versions of Windows:Note: It
is recommended that you remove the /3GB switch when you don’t
require it.
Simply remove the /3GB switch from your boot.ini file and
restart your computer.
Will this work on my 64-bit machine?
It doesn't need to! For 64-bit versions of windows, FME can take
advantage of 4GB of addressable memory. If you are running FME on a
64-bitversion of Windows, no further action is required.
Translations that previously failed because of limited memory
should now work.
For more information, see this documentation from Microsoft
(http://msdn.microsoft.com/library/default.asp?url=/library/en-us/mem-ory/base/4gt_ram_tuning.asp).
Where can I find more information?
Both this link
(http://www.microsoft.com/whdc/system/platform/server/PAE/PAEmem.mspx)
and this link
(http://-support.microsoft.com/default.aspx?scid=kb;en-us;328882&Product=exch2k)
have some good information.
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/memory/base/4gt_ram_tuning.asphttp://msdn.microsoft.com/library/default.asp?url=/library/en-us/memory/base/4gt_ram_tuning.asphttp://msdn.microsoft.com/library/default.asp?url=/library/en-us/memory/base/4gt_ram_tuning.asphttp://msdn.microsoft.com/library/default.asp?url=/library/en-us/memory/base/4gt_ram_tuning.asphttp://www.microsoft.com/whdc/system/platform/server/PAE/PAEmem.mspxhttp://www.microsoft.com/whdc/system/platform/server/PAE/PAEmem.mspxhttp://support.microsoft.com/default.aspx?scid=kb;en-us;328882&Product=exch2khttp://support.microsoft.com/default.aspx?scid=kb;en-us;328882&Product=exch2k
-
Setting the Temporary Directory
When FME runs a large, multi-dataset translation, it often
requires a lot of temporary disk space. This is particularly true
when running a Data-set Fanout, because there is no guarantee that
the features will arrive at the fanout in a single dataset group.
Therefore, FME has to write out allof the datasets to temporary
storage, and then fan them out afterwards. So the amount of
available disk space is important, but on a per-formance issue you
might be more concerned about the speed of all this disk
activity.
Many of the FME temporary files are created when caching data
for larger datasets or for display in FME Universal Viewer or Data
Inspector.Using a faster hard drive can make a significant
difference to the FME translation if disk cache I/O speeds are
improved. An example would be ifyou have an SSD (Solid-State Drive)
on your computer. These are typically quite a bit faster than
traditional HHD drives, so if you can point yourFME_TEMP to an SSD
then you'll see a bit of a performance increase when working with
larger datasets.
Where possible, set your temporary directory to point to the
fastest disk you have available.
The FMEpedia article setting a different temporary directory
tells you how to set the FME_TEMP environment variable. (In Windows
7, lookunder Control Panel > System > Advanced >
Environment Variables).
Usage Notes
Don't set your temporary directory on the same disk that the
operating system uses; FME might be slowed down by the operating
system writ-ing to the same disk at the same time.
Try to set the temporary directory to a disk that has a large
amount of free space – it won't improve the speed, but it might
prevent a large trans-lation from failing due to a lack of disk
space.
http://fmepedia.safe.com/articles/FAQ/FME-TEMP-environment-variablehttp://fmepedia.safe.com/articles/FAQ/FME-TEMP-environment-variablehttp://fmepedia.safe.com/articles/FAQ/FME-TEMP-environment-variablehttp://fmepedia.safe.com/articles/FAQ/FME-TEMP-environment-variablehttp://fmepedia.safe.com/articles/FAQ/FME-TEMP-environment-variable
-
Purging Temporary Files
FME creates temporary files during translations. During a normal
shutdown, FME automatically purges these files.
If FME does not shut down cleanly, the temporary files will not
be purged, and they will occupy unnecessary disk space.
A "clean" shutdown is if you stop a translation by using the
"Stop Translation" button on the toolbar, or when the workspace
runs to completion.Temporary files are not purged if, for example,
your computer crashes or if you close Workbench in
mid-translation.
It’s a good idea to periodically purge any remaining files by
selecting Tools > Purge Temporary Files.
-
License Borrowing
Tools > License Borrowing
If your FME Desktop product uses a floating license, you
can borrow a license for offline use. As long as the license is
available, you can borrowit and run FME for a maximum of 7
days on a computer that is no longer connected to the license
server.
When this period of time expires, the license also expires.
After the expiry date, the license automatically becomes available
for other users toborrow.
You do not have to return the license after an expiry date;
however, you can choose to return a license early.
-
FME Workbench Interface
FME Workbench is an application for defining data translation
and transformation processes.
With Workbench, underlying FME functionality is exposed in an
intuitive interface that allows users to graphically define a
custom dataflowfrom source, through transformation, to
destination.
Workbench has tools for defining the source and destination
dataset structure (or schema), and also for manipulating the
geometry and attrib-utes of spatial data.
Workbench is fully integrated to interact with other FME
applications such as the FME Universal Viewer and other products
such as FME Server,and is the authoring tool for FME Server
models.
Menu bar and Toolbar
The menu bar and toolbar contain a number of tools: for example
tools for navigating around the workspace, controlling
administrative tasksand adding or removing source datasets.
Canvas
The Canvas is where you graphically define your workflow. By
default, the workflow reads from left to right; the reader (source
data) is on theleft, the transformation tools are in the center,
and the writer (data destination) is on the right. Connections
between each item represent theflow of data and may branch in
different directions or even lead to a dead-end if required.
Translation Log
The log pane displays a report on translation results.
Information includes any warning or error messages, translation
status, length of trans-lation and number of features
processed.
Navigator
The navigator is an explorer type tool that displays a text
definition of source and destination datasets, plus all the
settings that apply to thesedatasets.
Transformer Gallery
The transformer gallery is a tool for the location and selection
of FME transformation tools.
Overview Window
The overview window displays a view of the entire workspace, and
highlights the outline of the current canvas window display upon
it.
Additional viewing options
Additional panes can display lists of feature and attribute
connections.
Related Information
Creating Workspaces
About the Workbench canvas.
About the Workbench Navigator.
About the translation log.
Tell me how to include transformers in my workspace.
Tell me how to manage feature type connections.
Tell me how to manage attribute connections.
-
Starting FME Workbench
Find FME Desktop in the All Programs area of the Windows
start menu. Click FME Workbench in the submenu.
Note that, depending on your version of Windows, the Start menu
configuration might look slightly different.
When Workbench opens, it displays a Start tab. The information
is generated from a live web page, so this tab will always display
the most up-to-date FME news, downloads, and resources:
-
The Getting Started and Recent Files areas provide options for
creating new workspaces or opening existing files.
-
Menus and Toolbar
Menu Bar
The pull-down menus on the top of the Workbench window contain
commands that will affect the entire workspace. Individual command
menuswithin the graphical interface (displayed by clicking the
right mouse button after making a selection) are applicable to
separate workspace com-ponents.
Toolbar
The toolbar gives you quick access to various commands. To see
what a toolbar button does without actually selecting it, float
your cursor overthe button to view a short description of its
function.
Customize the Toolbar
Right-click in an empty spot on the Workbench toolbar, and click
Customize Toolbar.
This opens the FME Options dialog, and displays the Toolbar
options.
Status Bar
The area at the bottom left-hand side of the Workbench window
displays progress information, as well as short descriptions of
selected menuitems or toolbar buttons. This area also displays the
FME version and build number.
Quick Navigation
To quickly move through a workspace, use keyboard
navigation.
l The arrow keys will move you to different parts of a
workspace, including links, and the Enter key will open properties
for editing.
l Press the Esc key to quickly cancel a pan or zoommode.
l When you are zoomed out in a workspace, you can float your
cursor over constants and annotations to display tool-tips that
show theirtext.
l Press and drag the middle mouse button (this is the mouse
wheel on most mice) to pan around the workspace.
l Hold down the Ctrl key and roll the mouse wheel to zoom in and
out.
l Use keyboard shortcuts.
-
Menu Commands
See also Workbench Keyboard Shortcuts for an additional list of
shortcuts.
File
Command Keyboard Shortcut Function
New Opens the Create Workspace dialog, which provides
differentoptions for creating a new workspace.
Open Ctrl + O Opens a file browser so you can pick an
FME workspace (.fmw)file.
Close Closes the current workspace.
Publish/Republish to FME Server Publishes a workspace to an
FME Server. Note that you must havean FME Server
configured as part of your system.
Download from FME Server Downloads a workspace from an
FME Server. Note that you musthave an FME Server
configured as part of your system.
Save Ctrl + S Saves the current workspace.
Save As Saves the current workspace to a different name. You can
alsosave a simple workspace to a mapping file (.fme) for use
withthe FME Quick Translator.
Save As Template Saves the current workspace as a template
(.fmwt).
Export as Custom Transformer Exports the workspace as a custom
transformer.
Export As Custom Format Exports the workspace as a custom
transformer.
Page Setup Sets page layout for print.
Print/Print Preview Prints the workspace. See also View >
Page Breaks.
Run Translation F5 Runs the workspace with existing
parameters.
Prompt and Run Translation Ctrl + R Runs the translation
and prompts you to change parameters (forexample, if you want to
use different source data).
Batch Deploy Runs the translation in batch mode.
Send To Opens your e-mail client with the current workspace
attached to anew e-mail.
Edit
Command Keyboard Shortcut Function
Undo Ctrl + Z Reverses the most recent action in a
workspace.
Redo Ctrl + Y Repeats the most recent action that you
reversed in a workspace.
-
Command Keyboard Shortcut Function
Cut Ctrl + X Cuts a selection and sends it to the clipboard.
Copy Ctrl + C Copies a selection and sends it to the
clipboard.
Paste Ctrl + V Pastes a selection from the clipboard.
Delete Del (key) Deletes a selection.
Bring to Front/Send to Back Brings objects forward on the canvas
or sends them behind otherobjects.
Select All Ctrl + A Selects all content on the canvas.
View
Command Keyboard Shortcut Function
Windows Shows/hides various Workbench windows.
Show Grid Displays the grid set in grid settings.
Snap to Grid Snaps object to the grid.
Grid Settings Sets the grid pattern.
Page Breaks If you print a workspace, this option displays the
current place-ment of page breaks.
Expand All/Collapse All Expands/collapses all workspace
objects.
Annotations Shows/hides annotations.
Summary Annotations Shows/hides summary annotations, which
display a box that con-tains information about the feature type or
transformer.
Bookmarks Shows/hides bookmarks.
Zoom Sets default zoom properties.
Locate the corresponding tool Zoom Mini-bar in FME >
Options >Toolbar.
The tool has a slider, +/- buttons, and a text entry box so you
canenter a zoom value. It also includes a "zoom to extents" button
tofit the workspace into the available canvas area.
Maximize Canvas Shift + F11 Maximizes the canvas to the size of
the current window.
Full Screen F11 Maximizes the canvas to the size of the
screen.
-
Insert
Command Keyboard Shortcut Function
Constant Supplies a destination attribute with a constant
value.
Parameter Reference Create a parameter reference that can assign
the value of thatparameter to an attribute in the workspace.
Annotation Inserts a free-floating annotation. Right-clicking on
the annotationallows you to attach it to objects.
Inspector Adds an Inspector transformer to the canvas.
Bookmark Adds a new bookmark to the canvas.
Parameter Creates a parameter that is not related to an existing
workspacesetting. This is the same as right-clicking on Published
or Privateparameters in the Navigator.
Custom Transformer Adds a custom transformer to the
workspace.
Transformer Input, Output, Loop Adds options onto Custom
Transformers (advanced FME).
Readers
Command Keyboard Shortcut Function
Add Reader Adds a reader to the workspace.
Import Feature Type Imports a feature type from a different
dataset.
Update Feature Types Updates feature types if the structure of
the data has changed out-side the workspace.
Enable/Disable Feature Types Temporarily disables (or enables)
feature types in the workspace.
Remove Feature Types Removes a feature type.
Remove Reader Removes a reader.
Add Reader as Resource Inserts a reference to a dataset to be
used in the workspace.
Writers
Command Keyboard Shortcut Function
Add Writer Adds a writer to the workspace.
Add Feature Type Adds a new feature type to the workspace.
Import Feature Type Imports a feature type from a different
dataset.
Update Feature Types Updates feature types if the structure of
the data has changed out-side the workspace.
Enable/Disable Feature Types Temporarily disables (or enables)
feature types in the workspace.
-
Command Keyboard Shortcut Function
Remove Feature Types Removes a feature type.
Remove Writer Removes a writer.
Move Feature Types Moves feature types between datasets.
Redirect to Inspection Application Redirects the output to the
FME Universal Viewer or the FME DataInspector (depending
on options set).
Inspection (Feature Inspector commands)
Command Keyboard Shortcut Function
Feature Inspector Displays the Feature Inspector window.
Run Translation with Inspection Shift + F5 Runs the translation
using the Feature Inspector, after you definean inspection
point.
Toggle Inspection Point F9 Turns the inspection point into a
regular link, or turns a regularlink into an inspection point.
Enable Inspection Point Enables a disabled inspection point.
Disable Inspection Point Disables an inspection point.
Remove all Inspection Points Removes all defined inspection
points from the workspace.
Enable all Inspection Points Enables all disabled inspection
points.
Disable all Inspection Points Disables all inspection
points.
Edit Inspection Point Opens the Inspection Point Parameters.
Tools
Command Keyboard Shortcut Function
Remove Unattached Removes any unattached objects from the
workspace.
Edit Parameters Displays all reader and writer parameters in a
dialog. This is use-ful especially if you have a large workspace or
multiple read-ers/writers.
Edit Header Allows you to add format directives into the
workspace (Advanceduser task)
Purge Temporary Files Purge temporary Workbench-related
files.
Browse Coordinate Systems Opens the Coordinate System
Gallery.
Browse Readers and Writers Opens the Reader and Writer
(supported formats) Gallery.
Auto Layout Provides layout settings for the canvas.
License Borrowing Allows floating license holders to temporarily
use another floating
-
Command Keyboard Shortcut Function
license.
FME Options Sets default options.
-
Workbench Keyboard Shortcuts
See
http://docs.safe.com/fme/pdf/FMEWorkbench_Keyboard_Shortcuts.pdf.
http://docs.safe.com/fme/pdf/FMEWorkbench_Keyboard_Shortcuts.pdfhttp://docs.safe.com/fme/pdf/FMEWorkbench_Keyboard_Shortcuts.pdfhttp://docs.safe.com/fme/pdf/FMEWorkbench_Keyboard_Shortcuts.pdf
-
FME Options
-
Appearance
Select Tools > Options and click the Appearance icon.
Welcome Dialog
Toggle the checkbox to enable/disable the welcome dialog that
appears by default when you start Workbench.
Fonts
Canvas and Log font: Set the default font to be used on the
workspace canvas, and in the translation log.
Set Sound Options
You can adjust FME sound events using the Windows Sound and
Audio Devices Properties. You can set Workbench to make a
distinctive soundwhenever an object is cut, pasted, connected, and
deleted. It will also tell you when a translation is successful or
has failed. You can also settwo events in the FME Universal Viewer:
when a data load is complete, and when a redraw is performed (but
only if the redraw is longer than 3seconds). Note that by default
all the sounds are set to Off. Follow these steps to enable
them:
1. Click the Configure Sound Events button.
2. Scroll through the Program Events until you find FME
Workbench.
3. Select the sound to associate with the applicable event.
4. Click OK.
Workspace Search Options
By default, the Workspace Search appears as a link in the
Navigator. When you click the link, the Workspace Search dialog
appears:
You can change the way the Workspace Search appears in
Workbench. Check Search bar embedded in Navigator window to change
the link inthe Navigator to an embedded search bar at the bottom of
the Navigator window.
Detailed information on usingWorkspace Search
-
Themes
You can change the way objects are displayed on the canvas.
Currently, there are two different themes to display: Classic
and Default:
If you select a theme from the Current Theme pull-down menu, the
canvas will immediately reflect the change.
By default, Workbench Theme files (.wbtheme) are stored in the
My Documents\FME\Themes folder.
Restore Defaults
Click the Restore Defaults button at the bottom of the dialog to
revert this page to FME installation defaults. You will be prompted
to confirm yourselection.
-
Runtime
Select Tools > Options and click the Runtime icon.
Translation Priority
Sets the CPU priority for running translations. In most cases,
the default Normal setting will be adequate. If you regularly run
large trans-lations, you can keep the default setting, or change it
to Low, so the translations won't dominate your CPU (and so you can
do other work in theforeground while the translation is running).
If you have other CPU-intensive tasks running concurrently, you may
want to set the priority toHigh to make sure the translation gets
its share of the CPU.
Track Usage Statistics
If you check this box, FME will transmit information about your
version of Windows and how you use FME. The information collection
process iscompletely anonymous, and your results will be
automatically combined with other users' results. The resulting
statistics will help us identifytrends and usage patterns (for
example, which formats and processing facilities are utilized more
than others), which in turn will help us focusour development
efforts for future versions of FME. We will not collect your name,
address or any other personally identifiable information.
Log File Defaults
n Save log file: Save the translation log in the default
workspace directory. (When you choose "Save to file" in the log
pane, the default loca-tion will be the location you choose under
Default Workspace Directory, below. The default filename will be
translation_log.txt.)
n Append to log file: Appends log results to the previously
generated log, instead of overwriting the file.n Log Timestamp and
Debugging Information: You can choose to add these additional
details to your log file output.
Log Filter
Choose the type of messages that you want to view in the log
file. For example, you might want the log to display only Warnings
and Errors.
Python Interpreter
To choose a different Python interpreter for FME, locate the
interpreter's DLL file and follow these steps:
l Check Use Custom Python Interpreter.l Browse to the location
of the Python DLL you wish to use (for example, python26.dll).l
Click OK to save your changes.
For more information on Python and FME, see Startup and Shutdown
Python Scripts.
-
Workbench
Select Tools > Options and click the Workbench icon.
Set General Defaults
n Automatically save workspace before running: Automatically
saves your .fmw file after a translation, using a defaultname based
on your source and destination formats.
n Open up attributes when linking transformers: By default,
feature types are expanded to display attributes when-ever a link
is established.
n Draw bookmarks with a filled background: Bookmarks are shaded
instead of transparent.
n Allow reader feature type editing: This feature, which is
unchecked by default, allows you to edit the definition of asource
file.
n Enable quick connect: To connect elements of a workspace, you
can enable this feature to click an output port,release the mouse
button, and then click an input port. This provides an easy
alternative to the "drag and con-nect" method.
n Display Feature Counts: Enable or disable the feature
count display.
n Number of recent workspaces: This feature saves the name and
location of a selected number of recently openedworkspaces to the
bottom of the File menu. The default number of filenames to display
is 4 but you can selectup to 15. Note that if you change this
option, you will have to restart Workbench before it will take
effect.
n Bring Start tab to front: Choose how often the Start tab
should appear in the front when starting Workbench.
Reset Warnings
l Reset All Warnings: Redisplays all warnings that were
dismissed with Do not remind me again.
Set Annotation Defaults
n Automatically generate header annotations: New workspaces will
appear with the default Source Types, Data Flow, and
DestinationTypes annotations that appear at the top of the
workspace.
n Use transparent annotations: Gives annotations a transparent
background.n Automatically create summary annotation: Summary
annotations display detailed information on feature types or
transformers.
Set Save Options
n Save recovery data: Specify whether (and how often) you want
Workbench to write a recovery file for your workspace.
Inspector Application
n Choose the application to use as the
default: FME Universal Viewer or FME Data
Inspector.
Default Inspector Application
You can change the default Inspector application in Tools >
FME Options > Inspector Application.
FME can process true three-dimensional features; however, the
FME Universal Viewer shows data in only two dimensions.
TheFME Data Inspector application (which is a technology
preview) provides full 3D support.
-
Toolbar
Select Tools > Options and click the Toolbar icon.
Toolbar Preview
This is a representation of your current FME Workbench
toolbar.
l To understand a tool's function, float your cursor over the
tool to view its tooltip.l To add a tool, double-click an icon in
the Toolbar Preview, or drag it from the Available Actions pane to
the Toolbar Preview.l To remove a tool, select it and click the
delete (-) button.l Tomove a tool left or right, select it and
click the right or left arrow, or drag it to a new location.
Click Apply to apply the changes without closing the dialog, or
OK to apply the changes and close the dialog.
-
Transformers
Select Tools > Options and click the Transformers icon.
Display Options
Show transformer version in tooltip
With new releases of FME, transformers are sometimes upgraded to
include new functionality. If you have a large workspace whose
historyspans multiple FME versions, it may also span multiple
transformer versions.
Previous versions of transformers will work the same way they
always did, but you might also find it useful to enable transformer
tooltips toshow the transformer version (especially if you have
different versions of the same transformer). In this example, the
transformer version is 2:
Truncate transformer names on: This option allows you to specify
text abbreviations from the left, right or center. For example, if
your text con-sists of frequently occurring prefixes, you may want
to truncate names from either the center or the left so you can see
more text at a glance.
Use Drag-and-Insert Transformers
Enables a feature that allows you to drop a transformer onto an
existing connection. The selections for multiple input ports and
multiple outputports will be the default port connections.
Quick Add Options
l Show Quick Add on first keypress: Enables the Quick Add
search functionality on the Workbench canvas.
l Auto connect after Quick Add: If you select a Feature Type
before initiating the Quick Add search, the trans-former will
connect automatically to the feature type.
l Quick Add placement follows mouse: The transformer will be
placed underneath your cursor.
Editor Preferences
These settings apply to Transformer Parameter menus:
l Use Advanced Editor: This setting determines which text
editor will open by default when you select OpenEditor.
l Replace tabs with spaces: Replace tab characters with
spaces.
l Default Indentation Width: Sets the number of spaces used to
replace tabs. The default is 4.
-
Workspace Defaults
Select Tools > Options and click the Workspace Defaults
icon.
Stroking
This advanced setting is used by FME whenever arcs need be
stroked into lines to make sure the distance between resulting line
and the truemathematical arc is never more than the value
specified.
You can set a default tolerance here for all workspaces, or you
can set it on individual workspaces through Workspace Settings >
Advanced >Stroking Tolerance.
-
Default Paths
Select Tools > Options and click the Default Paths icon.
Default Workspace Folder
Sets the default location to save your workspaces. You can
choose to always save to the source data location, a custom
location, or aMy FMEWorkspaces subfolder in My Documents.
When you create a workspace, FME suggests a default workspace
name based on the formats used in the workspace. For example, if
your work-space is set up to read from an Esri Shapefile and write
to both an Access MDB file and AutoCAD drawing, then
shape2mdb_dwg.fmw wouldbe the suggested default name.
Shared Resource Directories
A shared resource is any FME file that has been made available
for other users to use. These files are:
n workspaces (*.fmw)
n mapping files (*.fme)
n custom transformers (*.fmx)
n custom formats (*.fds)
n custom coordinate systems (*.fme is best, although most file
formats will work)
n transformer categories (*.fmxlist)
This option is especially useful for workgroups. For instance,
if an entire workgroup uses just a few custom coordinate system
definitions, keep-ing these definitions in one place means that
everyone doesn't have to have a copy. Then, whenever any of the
definitions are updated, theentire group automatically has access
to the new version.
1. Locate the directory that you want to share, and create
subdirectories with these names (or, FME will createthem
automatically for you during step 5): Transformers, Format,
Coordinate Systems. (Note that your systemadministrator may have to
set up permissions and subdirectories for this folder.)
2. Click Tools > Options and click the Default Paths
icon.
3. Click the Add button.
4. Browse to the folder that you want to open for sharing.
5. Click the Open button. If the subdirectories in step 1 do not
exist, FME will automatically create them.
The directory name will appear in the list.
Every time you start FME, it will scan the folders for new or
updated files.
Note: Any locally stored formats, transformers and coordinate
systems take precedence over any shared directories. If there is a
namingconflict, for example, if you have a transformer with the
same name as a transformer in a shared directory, FME will always
use the trans-former that is stored locally.
FME Server Shared Directories
See FME Server Shared Directories.
Removing Shared Directories
Select the directory name and click the Delete button.
-
Network
Select Tools > FME Options and click the Network
icon.
Your organization may require you to use a proxy before you can
use FME. Proxies are often part of corporate firewalls.
You can also use this setting to specify a proxy server for
FME Server. See Connecting to FME Server.
Proxy Options
l No proxy: Choose this if you don't want to use a proxy. This
is the default setting.
l Use system proxy settings: Choose this if you want to use the
proxy settings configured for your operating sys-tem (Control Panel
> Internet Options > Connections > LAN Settings).
l Proxy server requires authentication: If your proxy server
requires login access, can enter it here. (Ask yoursystem
administrator for configuration information).
-
Coordinate Systems
Select Tools > FME Options and click the Coordinate
Systems icon.
How to determine which grid shift files are installed
A number of grid shift files are included when you install FME.
For details, see Included Grid Shift Files.
How to maintain and edit grid shift files
This option allows you to maintain and edit grid files. You can
manage the grid files by selecting a file and clicking the Edit
button (or, simplydouble-click the file). The dialog that appears
lists one or more grid shift files:
n Add button: Opens a file browser so you can select a new file
and add it to the list.
n Remove button: Removes a selected file.
Note: We recommend that you make sure that the grid files
you need are in the list, and that you remove any files that you do
not need. SeeNAD27/NAD83 Datum Shifts in U.S. and Canada on
FMEpedia for information on why it is important to configure
FME to use the correctfiles.
n Fallback Datum: Select the datum to use if the selected grid
file does not cover the area of your input data. Fallback datums
are listedin individual .gdc files, which you can open with any
text editor.
n Move Up and Move Down buttons: Note that these buttons will
rearrange the list, but they do not determine the order of
precedenceof the grid files.
Click OK to apply changes, and Cancel to discard changes.
WARNING!If you add a file, you are not copying the file – you
are only pointing to the file’s location. Thus, if you delete a
file from its original location,the entry you create here will
point to a nonexistent file. Safe Software recommends that you copy
each grid file to FME’s Repro-ject\GridData subdirectory before
adding any files to your configuration.
How to add a grid shift file to FME
Follow these steps to install a grid file so that FME will
recognize the file:
1. Copy the new file to FME's Reproject\GridData
subdirectory.
2. Select Tools > FME Options and click the Coordinate
Systems icon.
3. Select the applicable datum shift and click the Edit
button.
4. A dialog displays the files already recognized by FME for the
applicable datum shift. To include new files, click the Add button,
browse tothe applicable directory and find the file in
Reproject\GridData subdirectory.
5. Select the file and click OK.
More Information
For additional information on grid shift files, see the
Coordinate Systems section of this help file, or view these
specific topics:
How FME Handles Grid Files
Included Grid Shift Files
http://www.fmepedia.com/index.php/NAD27_NAD83_Datum_Shifts_In_US_and_Canada
-
Workbench Canvas
The main Workbench canvas displays the connections between the
readers (source data), transformers, and writers (destination
data). Bydefault, it is the largest area of the workspace on the
right.
After you save what you are working on, the workspace name is
displayed in the window’s title bar. Here's what an example
workspace lookslike, with the addition of a few customizations like
transformers and annotations:
-
Overview Window
View > Windows > Overview
The Overview window displays a mirrored view of the entire
workspace.
The outline of the current canvas window is highlighted, so if
you have a very large workspace, you can quickly get your bearings
in relation tothe rest of the workspace.
If you zoom or pan the canvas window, the overview window also
compensates its view; if you move anything on the canvas, it is
mirrored inthe Overview window.
-
Searching in Workspaces
By default, a Workspace Search link will display in the
Navigator.
(You can choose to change this link to a search bar at the
bottom of the Navigator window. Set these options through the FME
Options dialog.)
Results will include feature type names, attribute names and
values, transformer names and parameters, parameter names and
values, pub-lished parameters.
Workspace Search Modes
You can search within a workspace using one of three search
modes.
Exact substring match (default)
This is the default mode, which looks for the matching string in
workspace objects. For example, entering
ce re
will return the result Source Redirect:
Wildcard search (**)
To perform a wildcard search, prefix all search strings with two
asterisks. These asterisks ensure that the search engine will
switch to the wild-card search mode. For example, entering
**s*tcl
will return the results Startup TCL Script: and Shutdown TCL
Script:
Advanced search ('')
To perform an advanced search, prefix search strings with two
single quotation marks. These quotation marks ensure that the
search enginewill switch to the Advanced search mode. For example,
entering
''engine OR readers
will return the results Ignore Failed Readers and Reprojection
Engine
l AND queries: A search string may contain multiple words
(without enclosing quotes), in which case it will returncontent
that contains all of the words. For example, entering
''feature type (without the quotes)
means find content that contains both "feature" and "type".
l OR queries: Inside a search string, the OR operator may be
used to get matching content containing either oftwo words. For
example,
''feature OR type
is the OR query that will find content that contains either
"feature" or "type".
l Excluding terms: The - operator excludes any content
containing the search word which follows it. For example,
''feature -type means find content that contains "feature" but
not "type"
-
Setting the Feature Count Display
The feature count display shows how many features passed through
each link. This function helps analyze the results of a workspace,
and pro-vides a reference for debugging if the destination results
are not what you expected. Feature counts are also written to the
Log file but you canfind the references more quickly on the links
in a workspace.
To enable feature count display, click the Display Feature
Counts tool on the toolbar or click Tools > FME Options
> Workbench and checkDisplay feature counts. Click the tool
again to turn off feature counts (although you will have to run the
workspace again to refresh the display).
In this example, you can see that 84 features entered the
transformer and that 11 of the features had unique values.
The example below shows the feature counts when spatial and
non-spatial data is merged: 10 features from each stream are merged
to form10 output features.
-
Window Management
You can customize the layout of all areas of the Workbench
interface. Click View > Windows to see a list of the panes that
you can enable or dis-able.
The square button in the right-hand corner of each pane lets you
choose how you want your display (floating, stacked, or tabbed).
Click the but-ton to toggle between displays.
By default, the Transformer and Navigator panes are tabbed, so
they are displayed on top of each other. Similarly, the Transformer
Descriptionand Log panes are tabbed beneath the canvas. You can
click the tabs to toggle between them.
Clicking the window management button once detaches the first
tabbed pane from the main Workbench window. Click the title bar of
the paneand position it anywhere.
You can place different panes on a separate monitor, leaving the
main screen free to maximize the workspace canvas. To increase the
canvassize to the size of your current window, click View >
Maximize Canvas (Shift + F11).
To re-dock panes, drag them onto the Workbench interface.
Windows can be docked to either the left, right, upper or lower
boundaries of theWorkbench frame. When two or more windows are
docked in the same location, you can arrange them either stacked or
tabbed.
-
Printing Workspaces
File > Page Setup
n Paper Type: Choose from standard page sizes.
n Orientation: Portrait or Landscape
n Margins: Set margins in millimeters. The default is 10 mm from
each edge of the page.
n Scale: Choose to always fit the workspace on a page, or always
scale to a certain percentage.
n Decorations: Check this box to include file-type information,
page number and corner borders on the printout.
File > Print Preview
Select to preview a topic before you print. You can also print
directly from this window.
File > Print
Bypass preview mode.
-
About Templates
Templates allow you to create a workspace using a predesigned
format and structure. They are one of the best ways to get started
withFME Workbench, whether you're new to FME, whether you're
setting up a new workflow and you want some hints to get started,
or even if youwant to implement some best practices in your
workspaces.
FME templates can include source datasets within the file. Both
a workspace example and the data required to run the workspace can
be bun-dled together.
Templates have the file extension .fmwt.
Advantages
There are several advantages to using templates in
Workbench:
l Wrapping up source data and workspace inside a single file
makes it very easy to provide a set of related files to another
user.l When a series of workspaces use the same source or
destination data, a template allows you to duplicate Readers and
Writers withouthaving to recreate the workspace each time.
l Templates are a great way to store a set of processing tasks
for re-use. You can create a workspace from the template and add
your ownreaders and writers.
How to Use Templates
Saving a Workspace as a Template
Creating Workspaces from Templates
-
Creating Workspaces from Templates
The Create Workspace dialog (File > New) contains a list of
available templates, either stored locally or downloadable from the
FME Store:
1. This area lists template types and categories.
2. This area displays the templates that are stored in the
selected category on the left.
3. The tabs contain information associated with the template.
See Workspace Properties for a description.
4. Filter templates by keyword.
My TemplatesWhen you create templates from existing workspaces,
the template categories are added to this list. Click a category to
see the workspaces
Installed TemplatesSome templates are included with each
FME Desktop installation. These will be shown here, along with
any templates that you download andinstall from the FME Store
for use with both FME Desktop and FME Server.
Downloadable templates are updated frequently.
-
FME StoreThese templates are downloadable from the
FME Store. The FME Store contains templates and custom
transformers that are described as partof solutions on
FMEpedia.safe.com, as well as workspace elements created by third
parties.
Downloading a Template
1. To download a template, select it and click Choose, or
double-click the template name.2. The Workbench log window shows
the status of the download. The log window will look something like
this:
Requesting catalog details for selected template...Retrieved
catalog details.Connecting to FME Store...Successfully
connected.Downloading '.fmwt.fmwt'...Successfully downloaded
file.Successfully downloaded '.fmwt' from FME Server to
'\FME\FMEStore\Templates\LAS_PDF_3D.fmwt'.Disconnecting...Successfully
disconnected.
Note that if you have an open workspace, you will be prompted to
save and close the workspace.
3. When the template opens in Workbench, it will already contain
input data and transformers (if applicable), along with explanatory
anno-tations.
4. Click File > Save to save the template as a workspace on
your computer. FME will create a folder on your local drive
that contains boththe workspace and any associated input data. The
default location on Windows is \Documents\My FME Workspaces.
http://fmepedia.safe.com/
-
Saving a Workspace as a Template
Open a workspace and select File > Save As Template. The Save
as Template dialog opens.
You can edit the default name that Workbench assigns to the
template.
Select or type a category in which to store the template. If you
have not previously saved a template, the Category field pull-down
list will not dis-play any selections.
The tabbed areas of the dialog are meant to catalog information
applicable to the current workspace. For a description of the
information toinclude in these areas, and how the information is
displayed in a workspace, seeWorkspace Properties.
Any associated datasets are listed in the Select files to add
area. The default is to include the dataset as part of the
template. You can alsochoose to include additional files, including
multiple datasets.
The default Save location is \Documents\FME\Templates\.fmwt.
Click the Save button to save the template and close the
dialog.
-
Click Save and Publish to connect to an FME Server and
publish the template. Note that you must have an FME Server
configured with your sys-tem.
-
Reader and Writer Overview
FME contains a large number of formats because there are so
many different fields that use spatial data.
At Safe Software, we sometimes call these families of data and
each family has data with a set of characteristics that
differentiates it from thestructures of other data types.
Type Characteristics
CAD High-precision elements, traditionally backed by little or
no underlying intelligence.
GIS Spatial representation of real-world features, mostly with
underlying intelligence.
Raster Representations of spatial data as a series of cells –
usually for GIS or visualization purposes.
Database Data held as a centralized collection of records and
usually processed using transactions.
BIM/3D Data of buildings, often based on a data model where the
building is divided into components.
Web Any form of spatial data – vector or raster – that is stored
online and distributed through a network.
In addition, these families could also include:
Type Characteristics
Cartographic Data optimized to visually highlight certain
spatial characteristics or concepts.
Transfer Formats specifically designed as a means to standardize
the supply of data.
Of course, the big challenge is to preserve meaning and content
when working with different types of data; for example, combining
car-tographic and database data into a GIS-ready output. This is
where in-depth knowledge of FME’s readers and writers is a great
benefit.
Reading or Writing
It’s worth noting that not every FME-supported format permits
both reading and writing. Some formats only support reading,
whereas othersonly support writing.
Non-Spatial Formats
FME support includes a number of non-spatial formats. Therefore,
not only can FME work with the non-spatial attributes of spatial
features, itcan also work on a completely non-spatial basis.
Licensing and System Requirements
FME is available in various editions. The FME edition is
determined by the license, rather than by the product that is
installed, so the FME instal-lation disk and downloads for FME are
all identical.
Each different FME edition differs only in the formats
available. Only the FME Desktop Base Edition has a different (more
limited) set of func-tionality. Editions are often named for the
type of formats they support; for example, support for GE
Smallworld format datasets is provided bythe FME Smallworld
Edition.
Some formats are only supported when suitable application
software is also installed on the user’s system. Esri GeoDatabase
is an example ofthis. Because FME uses ArcObjects to read from a
GeoDatabase, it’s necessary that ArcGIS is installed and licensed
to enable this format inFME.
Format Plug-Ins
Some FME supported formats relate to very specialist data types.
In these cases, support is provided by an extra-cost plug-in. In
some casesthese plug-ins are created by third-party suppliers using
the FME Plug-In SDK.
-
FME Terminology
There are many unique terms associated with FME. It’s
particularly useful to know these terms when doing batch processing
or otherwise work-ing with multiple datasets.
Readers and Writers
A Reader is an FME term for the object in a translation that
reads a source dataset and a Writer is the FME term for the object
in a translationthat writes to a destination dataset.
Each representation in the Navigator is either a Reader or a
Writer, as shown here:
There is a distinction between Readers/Writers and Datasets
because many FME translations work on multiple datasets. Sometimes
source data-sets are identical in format and structure and can be
handled more efficiently by a single Reader. Sometime source
datasets – although iden-tical in format – may have different
structures that require separate readers to handle them.
Datasets and Feature Types
Datasets
The Association for Geographic Information defines a dataset as
an organized collection of data with a common theme, and this is a
gooddescription of what the termmeans within FME.
In FME a dataset refers to a collection of data you want to
translate from or to. FME can read from or write to multiple
datasets, and the datasetscan all exist in the same location or be
dispersed in multiple locations.
Feature Types
Feature Type is the FME term that describes an identifiable
subset of records within a dataset; so each dataset may contain a
number of dif-ferent feature types.
Common alternatives for this term are layer, feature class, and
object class.
For example, a collection of spatial data may relate to Planning
Infowithin which is information on roads, properties, and schools.
In FME, Plan-ning Infowould be the name of the dataset, and roads,
properties, and schools would be different feature types.
-
Dataset Types
A dataset can be one of several different types. Dataset type is
distinguished on the basis of data storage and structure and, since
FME handleseach type differently, it’s important to be aware of the
differences and to know which type of data you are working
with.
Dataset Type Characteristics Example
File a single file AutoCAD DXF
Folder a set of files in a single folder Esri Shape
Database a database Oracle Spatial
Web an Internet site Web Feature Service (WFS)
File-Based Datasets
A file-based dataset is a complete dataset stored within a
single file.
An AutoCAD DXF file is a good example of this: each DXF file is
a separate dataset.
Feature Types within File Based Datasets
File-based datasets usually have somemethod of assigning data to
different categories. In FME, these categories are the different
featuretypes.
For example, in an AutoCAD file, the data is defined in terms of
a number of layers. Each layer in a DXF file is a feature type in
FME. A DGN for-mat file uses levels instead of layers.
Folder-Based Datasets
The logic behind a folder-based dataset can be slightly
confusing. In this form of dataset, the dataset is the folder or
directory holding the data.For example, in
C:\FMEData\Data\Properties the dataset name is Properties.
Esri Shape, MapInfo TAB, and CSV formats are examples of
folder-based datasets.
Feature Types within Folder-Based Datasets
In a folder-based dataset, data is held as a series of files.
Commonly, each differently named file is a feature type within the
dataset.
For example, within the following MapInfo MIF/MID data
structure, the dataset is called EastA. The feature types are
BoundaryArea,HydrographyLine, and RoadLine.
C:\FMEData\Data\DemoData\MultiDataset\EastA\BoundaryArea.mif
C:\FMEData\Data\DemoData\MultiDataset\EastA\HydrographyLine.mif
C:\FMEData\Data\DemoData\MultiDataset\EastA\RoadLine.mif
FME users commonly mistake all individual files for a dataset.
When there is no method of subdividing the data within the file
itself, FMEusually treats the file as a feature type within a
folder-based dataset.
Database Datasets
A database dataset, as the name implies, is a set of data stored
within a database. Generally each different database is a different
dataset(although, to be strictly accurate, each user/schema within
a database would be a different dataset).
The most obvious example is an Oracle database. It will be
treated the same way whether it is spatial or non-spatial.
Feature Types within Database Datasets
In a database dataset, each different table within the database
is treated as a feature type.
-
For example, an Oracle database called resources has tables
called users, vehicles and equipment. The dataset is resources, the
feature typesare users, vehicles, and equipment.
Web Datasets
A web dataset is a collection of data stored on an Internet
site. A Web Feature Service (WFS) server is an example of this. In
this case, the nameof the dataset is the same as the name of the
URL (Universal Resource Locator).
Feature Types within Web Datasets
Web datasets commonly have a number of layers. Each layer
represents a different feature type. WFS format is one example of
this type of data-set.
-
Adding Readers to the Workspace
You can add one reader, or specify multiple datasets to include
as multiple readers.
Adding a Reader
1. Select Readers > Add Reader.
2. Browse to the dataset file (or group of files) that you want
to add. FME can usually determine the format from the file
extension, and willautomatically populate the Format field.
3. Specify parameters and coordinate system (if applicable).
If you drag the file directly onto the Workbench canvas, the Add
Reader dialog box will appear with the format and dataset name
already filledin.
Workflow Options
Workflow options determine the number of feature types that will
be displayed on the canvas. Selecting either one will not affect
the outcome ofthe workspace: these options determine only how the
feature types appear on the canvas, and how they are interpreted
within the workspace.
By default, the Individual Feature Types option will be
selected. This means that for every feature type in the dataset
(assuming there is morethan one), Workbench will display a
corresponding feature type on the canvas. This has always been the
default workflow for Workbench andfor most workspaces, this option
is sufficient.
If, however, you want to display only one feature type on the
canvas, you can select Single Merged Feature Type. All feature
types in the sourcedataset are merged into one single feature
type.
Note: If you want to separate the feature types later, you
can do this through the Feature Type Properties dialog.
Initiating the Action
After you press OK, the log window will display processing
information, and the feature types will appear in the reader area
of your workspace.
Adding Multiple Readers
To extend the input of your workspace to include multiple source
datasets that are in a different format than your existing source
dataset:
1. Select Readers > Add Reader.
2. Specify the source format.
-
3. To select multiple datasets, click the Advanced Browse button
. Type directly in the Directory field (you can use wildcards to
includeall files of a specific format), or click Add Folder button
to browse for a specific directory name. Click the Subfolders box
to also includeall subfolders below that directory. If you know
that files are the same schema, check the Identical Schemas box
(this can have an effecton overall processing time if you have many
datasets).
4. Specify parameters and the coordinate system (if
applicable).
-
Adding a Reader as a Resource
When you add a reader as a resource, you are inserting a
reference to a dataset to be used in the workspace. This reader
will not perform anyactual data reading, except when up-to-date
schema is required at runtime. When required, schemamay be
requested from that reader.
Currently, this option is only used by the writers that are
configured to use Dynamic Parameters.
In the dynamic mode, a writer will extract schema information
from one or more of the specified readers or reader resources to
use during atranslation. This feature is particularly useful when a
writer needs to get the schema and features from several different
datasets.
The difference between a Reader and a Reader Resource is that
adding a Reader will also add all the associated feature types – a
readerresource can be used as a source for schema without actually
providing any feature types.
Setting up the Reader Resource
Select Readers > Add Reader as Resource or right-click
Workspace Resources in the Navigator:
The process in Workbench is similar to adding a workspace
Reader. You will need to select the dataset file (or group of
files) that you want toadd as a resource (FME can usually
determine the format from the file extension, and will
automatically populate the Format field). If required,specify any
additional format parameters.
After you click OK, the log file will display the processing
statistics associated with the selected dataset, and you will see a
Translation SUC-CEEDED message, indicating that Workbench has
successfully processed the dataset.
You will see an additional Workspace Resources parameter in the
Navigator window:
This Reader will remain in the list as a resource of the
workspace.
Setting up the Writer to use the Reader Resource
When you want to use the Reader in a translation, open the
Writer Feature Type Properties. Clicking Dynamic Parameters enables
the SchemaSources and Schema Definition fields.
-
Click the Browse button beside the Schema Sources field to
select from a list of existing schema readers. Only the readers
that you haveselected will be used at runtime.
Changing the Dynamic Schema Properties (Advanced FME)
In most cases, you can use the default Dynamic Schema
properties.
However, the dynamic writer can operate with a few variations on
the schema definition. These are feature type fanouts, more complex
schemareader definitions and defining the destination feature
geometry.
To display dynamic schema parameters, click the Browse button
beside the Schema Definition field in the Feature Type Properties
dialog.
-
Feature Type Name
This controls the name of the destination feature type that is
written. Default uses either the source schema or the schema reader
feature typename. Fixed uses the name of the feature type in the
workspace. From Attribute has the same effect as the dataset fanout
with a new featuretype for each value of the specified
attribute.
Schema Definition
If the feature types in the Schema Reader do not match the
fme_feature_type, then you can set an attribute that defines the
name of theschema reader feature type to be used for the schema
definitions.
Geometry
Some formats, e.g. Esri Shape, have a fixed geometry. This
option defines where the definition for the geometry is derived
from.
Attributes to Remove
This option allows you to remove attributes from the feature.
The unchecked attributes will be retained.
See also
About Dynamic Workspaces
-
Merging Similar Datasets
If data sources reside in different locations, you can select
them using the advanced browser.
You can add datasets of the same format and with the same schema
(data model) to any source dataset you have already defined in your
work-space. These datasets will be merged together when you run the
translation. For formats that support coverages, you can also add
directoriesand subdirectories.
Double-click the dataset name in the Navigator and select Open
Advanced Browser from the Edit Parameter menu:
This opens the Select File dialog:
Subdirectories: If there are subdirectories below the
initial dataset location, check the box to include them.
Add Files: Opens the file browser. You can select individual
files, or Ctrl + click to select multiple files.
Add Directories: Opens the file browser so you can select entire
directories to add to the reader. All files that are in the
specified format inthose directories will be included.
Identical Schema Check this box if you know that all the files
have the same schema. This is a time-saving function: there
will be no dif-ference in the workspace results. If you know the
files have the same schema, FME will not have to perform an
initial scan of all the files to deter-mine their schema. Instead,
FME will take the first file as being representative of the
data model.
-
Click OK to close the dialog, then OK to close Edit
Parameter dialog and merge the selected files/folders with the
original dataset. To see theseresults reflected in the Navigator
view, float the cursor over the dataset name.
When you run the translation, Workbench will add the selected
files and/or folders, and merge the specified datasets.
-
Adding Multiple Writers
You can write to multiple destination datasets. (You can also
set the output coordinate system for each dataset to its own unique
coordinate sys-tem.)
1. Select Writers > Add Writer.
2. Specify the format and dataset filename. See Choosing from
the Formats List.
3. Specify parameters and coordinate system (if applicable), and
click OK. The log window will display proc-essing information,and a
new Reader will appear in the navigator view.
4. Add new feature types for the new destination dataset using
one of the following methods:
Select Add Feature Type from the Writers menu. You will be
prompted to create a new feature type. You can also or right-click
on thebackground of the workspace and select Insert Writer Feature
Type. From here, you can set the geometry (for some formats), the
fea-ture type name, and user attributes. See Changing Feature Type
Properties.
Select the Feature Type, right-click and choose Copy Attributes
From Feature Type. Choose the destination feature types from
anexisting destination dataset and they will copy to the new
dataset. Now when you display your destination feature type
properties,you will see a list with unique filenames. You can also
select an existing destination dataset, copy and then paste it onto
your work-space.
If you don't want to add an entire dataset you can import
another dataset's definitions. Select Import Feature Types from the
Writers menu, andthen adjust the imported feature types so that
they more closely reflect your dataset.
You can change the displayed name of a writer by right-clicking
on it in the Navigator pane, and choosing Rename.
-
Readers and Writers: Zip Files and URLs
Besides reading a dataset directly from a file (or set of
files), FME can also read data that stored or managed in a number
of different ways:
Reading from a Zip File
l Usage Notes
Writing to a Zip File
l ExistingWriter
l Multiple File Extensions
l Using the Generic Writer
l Using Dataset Fanout
Reading from a URL
l Reading from a Cloud Storage URL
-
Reading from a Zip File
FME can read file or folder datasets stored in a compressed
(zip) folder. Upon being read, the data will be extracted and used
just as if it were anormal dataset. FME is able to read data stored
directly in a zip file, or within a top-level sub-folder.
Defining a zipped dataset to be read is as simple as selecting
that zip file from within any of FME’s dataset selection tools.
For example, when adding a reader:
1. Select the Format.
2. Click the Browse button to open the file browser. In the
bottom right of the file browser, select Zip Files fromthe filter
list.
3. Select the zip file in the file browser and click Open to add
the dataset to the reader:
Note: If the file extensions inside the zipped folder are
different (for example, png and PNG), include \*.* toopen all of
the files within the folder. For example,
C:\ZIPSTER\zipster.zip\*.*
4. Click OK to add the reader to the workspace.
Usage Notes
l Zip support includes the ability to read multiple files from
inside the same zip file. It does not include the abilityto read
data stored inside nested folders within a zip file.
l If the format is set, it is not necessary to select individual
files from inside the zip file. FME will know which filesto read
based on the file extension related to the chosen format.
l While it is possible to write zipped datasets using the
Generic writer, it is not possible to read them using theGeneric
Reader with the format set to Guess format name from Extension.
l Reading from a password-protected zip file is not currently
supported.
-
Writing to a Zip File
FME can write output datasets directly into a zip folder. This
is useful for when the output needs to be compressed to a smaller
storage size, orwhen a folder-based dataset (such as Shape) is
comprised of several files that need to be stored together.
Defining a zipped output dataset is as simple as setting a .zip
extension in the output dataset name. For convenience, when the
chosen for-
mat supports this featu