F Me Getting Started

Getting Started with FME
Desktop
What's New in FME Desktop?
n Explore What's New and Great
What's New in FME Desktop?
ii Getting Started with FME Desktop
FMEDesktop Help Map
Installed product documentation is available from any FMEcomponent Help
menu, or in the FME installation directory > help.
FME Desktop documentation includes:
Documentation Description
FME Workbench This is the primary FME Desktop application for
translating and transforming data.
FME Data Inspector View data in any FME-supported format. Use the
Data Inspector to preview data before trans-
lation, verify it after translation, and check data
at any point during a translation.
FME Readers and Writers This is a technical reference to the 300+ spatial
and non-spatial data formats that FME Work-
bench is capable of reading and writing. It also
includes format parameters that are visible in
Workbench.
FME Transformers This is a comprehensive reference to the 400+
FME transformers. Transformers are used in
FME Workbench to perform geometric and attrib-
ute restructuring of features during a trans-
lation.
FME Coordinate Systems This is 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 conversions.
FME Integration Console This component allows you to integrate certain
third-party applications with FME Desktop.
Getting Started with FME Desktop iii
Quick Start
Setting up a Workspace
Adding Transformers
Detailed Transformer Help
Quick Start
iv Getting Started with FME Desktop
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 with FME Desktop v
Safe Software Inc. makes no warranty either expressed or implied, includ-
ing, but not limited to, any implied warranties of merchantability or fitness
for a particular purpose regarding these materials, and makes such mater-
ials available solely on an as-is basis.
In no event shall Safe Software Inc. be liable to anyone for special, col-
lateral, incidental, or consequential damages in connection with or arising
out of purchase or use of these materials. The sole and exclusive liability of
Safe Software Inc., regardless of the form or action, shall not exceed the
purchase price of the materials described herein.
This manual describes the functionality and use of the software at the time
of publication. The software described herein, and the descriptions them-
selves, are subject to change without notice.
Copyright
1994 2014 Safe Software Inc. All rights are reserved.
Revisions
Every effort has been made to ensure the accuracy of this document. Safe
Software Inc. regrets any errors and omissions that may occur and would
appreciate being informed of any errors found. Safe Software Inc. will cor-
rect any such errors and omissions in a subsequent version, as feasible.
Please contact us at:
Safe Software Inc.
Suite 2017, 7445 132nd Street
Surrey, BC
Canada
V3W 1J8
www.safe.com
Safe Software Inc. assumes no responsibility for any errors in this doc-
ument or their consequences, and reserves the right to make improve-
ments and changes to this document without notice.
vi Getting Started with FME Desktop
Trademarks
FME is a registered trademark of Safe Software Inc.
All brands and their product names mentioned herein may be trademarks or
registered trademarks of their respective holders and should be noted as
such.
Document Information
Document Name: Getting Started with FME Desktop
Version: FME Desktop 2014
Updated: January 2014
Getting Started with FME Desktop vii
Version Information
FME Desktop 2014 is Version 7.8 of the FME software.
As of 2013, the version number for FME software will be indicated in the
Properties dialog box of the fme.dll:
File Version:
<ReleaseYear>.<MajorVersion>.<MinorVersion>.<BuildNumber>
viii Getting Started with FME Desktop
Version Information
Contents
What's New in FME Desktop? ii
FMEDesktop Help Map iii
Quick Start iv
Download Transformer Quick-Reference v
Version Information viii
About Safe Software and FME 1
About this Manual 2
Installation and Licensing 4
What Makes FME Unique? 5
Primary FME Components 6
FME Workbench 6
FME Data Inspector 6
FME Quick Translator 7
FME Command-Line Engine 8
Other FME Components 9
FME Universal Viewer 9
FME Objects 10
FME Application Extenders 10
FME Plug-In SDK 10
FME Integration SDK 10
Help and Tutorials 11
FME Desktop Training 11
Help Files 11
FME Community 12
FMEpedia Community and Knowledge Base 12
Starting FME Workbench 13
What is a workspace? 15
Workbench User Interface 16
Canvas 16
Navigator 17
Transformer Gallery 19
Menu Bar and Toolbar 21
Overview 22
Log 22
Additional Viewing Options 23
About the Reader and Writer Gallery 25
Format Information 25
Getting Started with FME Desktop ix
Custom Formats 26
Format Details FME Readers and Writers Manual 26
Understanding Workbench Concepts 27
Data Transformation Types 28
Transforming Structure 28
Transforming Content 28
Geometric Transformation 28
Attribute Transformation 28
Schema Definition 30
How Does FME Represent the Schema? 30
Viewing the Schema in FME Workbench 31
Editing Schema 35
Schema Mapping 39
Feature Type and Attribute Mapping 39
Schema Mapping in FME Workbench 40
Feature Type Mapping in FME Workbench 40
Attribute Mapping in FME Workbench 41
Features 42
Using Transformers 43
Creating a Workspace 45
Refining the Reader and Writer 49
Defining Writer Characteristics 50
Using the Default Coordinate System 51
Changing Coordinate System Parameters 52
Adding Transformers 53
Locating Transformers 53
Placing a Transformer 54
Transformer Ports 55
Quick Add 55
Quick Connect 57
Smart Delete 58
Multiple Transformers 59
About Transformer Parameters 59
Custom Transformers 62
Detailed Transformer Help 63
Transformers Reference Guide 63
Creating a Custom Format 64
Organizing the Workspace 65
Using Bookmarks 65
Creating Annotations 66
x Getting Started with FME Desktop
Version Information
Running the Translation 69
Using the Feature Count Display 69
Running a Batch Translation 71
For More Information 72
Workbench Keyboard Shortcuts 72
Using the FME Data Inspector 73
Starting FME Data Inspector 75
FME Data Inspector Viewer Interface 76
Menu Commands, Tools, and Shortcuts 77
Log Window 83
Viewing Data 84
View Modes 84
Adding Datasets 84
Filtering Feature Display 85
Using_the_Measuring_Tool 86
Querying Features 87
Querying Raster and Point Cloud Features 89
Saving Data 91
Using FME Quick Translator 93
Specifying the Reader 94
Merging Similar Datasets 94
Reader Parameters 95
Converting Coordinate Systems 96
Choosing from the Coordinate System Gallery 97
Viewing the Reader Dataset 98
Entering Writer Information 99
Writer Parameters 99
Choosing a Mapping File 101
Deciding on the Next Step 102
Switching to FME Workbench 102
Performing a Basic Translation 102
Running the Translation 103
Running a Batch Translation 103
Stopping a Translation 103
Saving Log Text 104
Copying and Searching Log Text Information 104
Viewing the Output File 105
Getting Started with FME Desktop xi
About Safe Software and FME
One of the most compelling questions for organizations today is the question
of where? Using spatial data, business leaders, managers, and spatial data
experts can all get more information and better answers to drive more accur-
ate decision making and planning.
The next most compelling question is often: How do we use this data? The
enormously diverse range of spatial data formats and evolving standards
often means that interoperability can become a big challenge.
At Safe Software, were dedicated to making sure that FME will always help
you do the most with your spatial data.
Built by experts from every corner of the industry, the FME technology plat-
form sets a higher standard for transforming spatial data to use and share. It
solves more spatial data transformation challenges across more formats
than any other solution, making it easier for professionals to solve their data
interoperability problems.
Getting Started with FME Desktop 1
About this Manual
When you are working with FME Desktop, what you can do with the res-
ulting data is almost unlimited every user can have a different require-
ment, depending on the task, the source data, and the type of
transformation.
For that reason, this Getting Started manual covers only basic concepts and
workspace setup.
For intermediate or advanced Workbench examples, it is recommended
that you download and work through the FME Tutorial, available on our web-
site at www.safe.com. The FME Tutorial includes sample data and a work-
book. Taking an FME Training course is also highly recommended.
FME components contain detailed on-line help, available from each Help
menu. Help is also available from the main FMEDesktop Help window,
which is a comprehensive viewer containing both technical documents and
user documents.
FME Workbench This is the primary FME Desktop application for
translating and transforming data.
2 Getting Started with FME Desktop
About this Manual
FME Data Inspector View data in any FME-supported format. Use
the Data Inspector to preview data before
translation, verify it after translation, and
check data at any point during a translation.
FME Readers and Writers This is a technical reference to the 300+ spatial
and non-spatial data formats that FME Work-
bench is capable of reading and writing. It also
includes format parameters that are visible in
Workbench.
FME Transformers This is a comprehensive reference to the 400+
FME transformers. Transformers are used in
FME Workbench to perform geometric and
attribute restructuring of features during a
translation.
FME Coordinate Systems This is a guide to associating coordinate sys-
tems 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 conversions.
FME Integration Console This component allows you to integrate certain
third-party applications with FME Desktop.
Installation and Licensing
Instructions for installing and licensing FME are available in the FME Install-
ation and Licensing Manual.
What Makes FME Unique?
What Makes FME Unique?
FME provides unrivalled format support for data translation and integration,
and unlimited flexibility in data model transformation and distribution.
Format Support
FME is a central engine in the midst of over 200 formats. You can read from
any supported format and write to any supported format.
Data Model
FMEs data model is designed to cover all possible geometry and attribute
types. You can accurately restructure the schema of your data as it moves
from the source to the destination, without losing semantic information.
FME is also smart enough to compensate automatically for limitations in a
destination format to create a seamless translation process whenever pos-
sible.
Translate, Transform, Integrate
FME has what traditional format translators lack: the ability to also trans-
form the data. You can work with an entire dataset or isolate specific feature
types or attributes, and then add transformers to manipulate the data so you
get the output that you want.
FME includes a gallery of over 400 powerful transformers that provide tre-
mendous functionality.
Primary FME Components
FME Workbench
FME Workbench has an intuitive point-and-click graphic interface that
enables you to visualize the data flow. FME Workbench is the primary tool
for data translations in FME.
FME Workbench offers powerful transformation and translation capabilities
traditionally reserved for custom software solutions. Using Workbench, you
can graphically adjust the way your data flows from its source to the des-
tination.
If you want to add customizations or detailed transformations, including
those that require multiple input and output formats, FME Workbench is the
best tool.
FME Data Inspector
The FME Data Inspector maintains many of the same features as the FME
Universal Viewer; however, the Data Inspector is cross-platform, it uses
the latest display technology, and it supports 3D viewing.
Primary FME Components
You can choose whether to use the FME Universal Viewer or the FME Data
Inspector. Choose Tools > FME Options and click the Workbench icon.
FME Quick Translator
For simple translations that do not involve any customization, you can get
quick results by using the FME Quick Translator. Advanced FME users can
also run custom mapping files through this interface.
FME Quick Translator (originally called the FMEUniversal Translator) was
the first FME application to be developed.
Translations are defined through 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 lets you submit translation requests at the
command-line level.
Type fme at the command line to see a list of available commands. The FME
Fundamentals manual contains more detailed information on using FME
from the command line.
Other FME Components
Other FME Components
These additional components are all included as part of the standard FME
package.
FME Universal Viewer
Note that the default inspection application is the FMEData Inspector.
The FMEUniversal Viewer will eventually be removed from FME.
FME Universal Viewer allows quick viewing of data in any of the FME-sup-
ported formats. It is used primarily for data validation and quality assurance
by allowing you to preview the data before translation, or review it after
translation.
FME Objects
FME Objects is a software library for working with spatial data. Application
developers use FME Objects to add spatial data reading and writing support
to 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 as
FME Enabled Applications. Commonly 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 func-
tionality to the FME translation core.
FME Integration SDK
The FME Integration SDK allows developers to create FME-enabled applic-
ations for users who already have FME installed on the same PC.
Help and Tutorials
Help and Tutorials
In-depth technical reference documentation is integrated with FMEDesktop
help files, is included with your FMEinstallation, and located at www.safe.-
com/support/onlinelearning.
The FME Desktop Tutorial is an ideal way to start using FME. It includes
instructions and examples to help you accomplish the following tasks:
n Quick Translation Perform simple data translations with the FME
Quick Translator.
n Custom Translation Transform data with FME Workbench, and create
Custom Formats from existing transformations.
n Data Inspection View and query data in the FME Data Inspector.
Look for the FME Desktop Tutorial at http://fmepe-
dia.safe.com/knowledgeDocumentation.
The FME Self-Study Modules are designed to help you improve your pro-
ficiency with FME at a pace that suits your schedule. The FME self-study mod-
ules help you build the FME skills you need to solve your data integration
challenges. For more information, visit www.safe.-
com/support/onlinelearning.
FME Desktop Training
Safe Software provides courses and resources for both FME Desktop and
FMEServer, offered at a range of skill levels. You can choose how you want
to learn: in-person, on-line instructor-led, or with self-paced resources like
tutorials and demos.
To access these resources, visit http://www.safe.com/training/.
Help Files
Select FME Workbench from the Help menu or visit http://fmepe-
dia.safe.com/knowledgeDocumentation.
FME Community
Our online community consists of an enthusiastic group of users and Safe
Software staff who participate in various online resources. These technical
resources are a forum where FME users ask questions, receive help, and
exchange information on FME products. We welcome and encourage ques-
tions about FME formats, processing capabilities, future plans, doc-
umentation, FME Objects, mapping files, and coordinate conversion issues.
FMEpedia Community and Knowledge Base
Ask questions and share advice at the new question and answer site for
FMEusers:FMECommunity Answers.
FMEpedia Knowledge Base contains informative resources and tools
designed to help you optimize your use of FME Desktop and FME Server.
Starting FME Workbench
You can start FME Workbench in the following ways.
To start Workbench as a stand-alone application do one of the following:
n From your desktop, click the Workbench shortcut .
n From the Windows Start menu, select All Programs > FME Desktop >
FME Workbench.
n Use Windows Explorer find the FME folder (by default, in the Program
Files folder) and double-click the Workbench icon.
If you start Workbench using the preceding options, the Workbench start-up
window opens. From here, you can choose a number of different start-up
options.
To start Workbench from Windows Explorer using existing Workbench
(.fmw) files do one of the following:
n Double-click a Workbench file.
n Right-click the file and select Edit with FME Workbench from the com-
mand menu.
n Right-click the file, and select Open With > FME Workbench from the
command menu.
n Drag and drop the .fmw file onto a shortcut pointing to Workbench.
Workbench starts up and opens the existing workspace.
To start Workbench using an existing file (other than .fmw) as input
data:
n Right-click a file that does not have the .fmw extension. The file can be
in any format that your FME license supports. Select Transform with
FME Workbench from the command menu.
n You can also drag and drop the file onto a shortcut pointing to Work-
bench. Workbench automatically extracts the filename and type for
your source data.
Workbench starts and opens the New Workspace dialog with the source
information already filled in.
You might also be interested in:
What is a workspace?
Workbench User Interface
About the Reader and Writer Gallery
A workflow that is defined in Workbench is called a workspace. Workspaces
contain readers and writers (which contain format information) and their
attributes, as well as transformers that manipulate the data. You can work
with only one workspace at a time; however, you can start an additional FME
Workbench and copy and paste information to your current workspace.
Workspace files have the extension .fmw. For a default workspace name
(which you can always change), FME suggests a filename based on the
formats used in the workspace. For example, if your workspace is set up to
read from an Esri Shapefile and write to both an Access MDB file and
AutoCAD drawing, then shape2mdb_dwg.fmw would be the suggested default
name.
The Workbench user interface consists of different work areas, or windows.
You can choose which areas are shown by selecting them from the View
menu. You can also click and drag the title bar of a window to dock it in a
different location, or drag it to a separate area of your monitor, and you
can distribute the windows across multiple monitors.
Legend
1 Menu bar and toolbar 5 Log
2 Navigator 6 Help tab
3 Canvas 7 Status bar
4 Transformer Gallery (not
default location)
Canvas
The canvas is where you graphically define the workflow. By default, the
workflow reads from left to right: the data source is on the left, the trans-
formation tools are in the center, and the data destination is on the right.
Connections between each item represent the flow of data and may branch in
different directions or even lead to a dead-end if required.
Navigator
The Navigator is an Explorer-type tool that shows a text definition of all the
components that comprise the workspace, including data, feature types,
transformers, and specific parameters. You can edit most definitions.
The Navigator also highlights anything that needs attention, such as trans-
former parameters that require input before you can run the workspace.
The Navigator includes general workspace properties including name, cat-
egory, and description. It also includes information about the workspace,
such as save date and build. Most of these properties are optional but can be
useful if you want to maintain a workspace history.
Workspace Parameters include settings related to more advanced tasks,
such as log file name, parameter settings, and source and destination redir-
ect instructions. These are described in the Workbench help topic Workspace
Navigator > Workspace Parameters.
Transformer Gallery
In FME Workbench, source and destination data is represented by objects in
the workflow. In the same way, both geometric and attribute restructuring
are represented by objects called Transformers. The Transformer Gallery
stores all transformers.
To view the Transformer Gallery, click the tab below the Workbench Nav-
igator.
This tab is enabled in the Workbench interface by default. You can toggle it
on/off by selecting View > Windows > Transformer Gallery.
Displaying Transformer Help
Open a folder and click a transformer to view a description of its function.
This description is displayed in the Transformer Description area of the Work-
bench interface.
To show the entire Transformer help file, choose Help > FME Transformers,
or select a transformer in your workspace and press the F1 key.
Adding a Transformer to the Canvas
To include a transformer on the canvas, you can drag-and-drop it, double-
click the transformer name, or, once you are more familiar with transformer
names, you can also use the function described in Quick Add.
You can find detailed information on each transformer by selecting Help >
FMETransformers, or by pressing the F1 key when you select a transformer
in Workbench. The FME Workbench Transformers Reference Guide is a good
resource that provides high-level information about each transformer.
Note: FME Professional Edition contains more transformers
than FME Base Edition. For details, visit the Products page at
www.safe.com. Any transformers that are not supported by
your FME license will appear as gray icons in the Trans-
former Gallery.
For more information, see Locating Transformers.
Menu Bar and Toolbar
The menu bar and toolbar contain a number of shortcuts; for example, you
can use tools to navigate the workspace, control administrative tasks, and
add readers and writers.
In general, the pull-down menus on the menu bar contain commands that
affect the entire workspace, whereas individual command menus within the
graphical interface (shown by right-clicking your selection) are applicable
to separate workspace components.
You can customize the toolbar to include specific buttons. Right-click in a
blank area of the toolbar and select Customize Toolbar, or select Tools >
FME Options and click the Toolbar icon.
To see what a tool does without actually selecting it, float your cursor over
the button to view a short description (tooltip) of its function.
Overview
The Overview window (View > Windows > Overview) shows a view of the
entire workspace and highlights a selected portion of the canvas. It is not
meant to show detail; however, it can help orient you when you are work-
ing in a large workspace. You can move and resize the magnifier to focus
on certain areas of a workspace.
The example here shows an Overview window that has been docked under-
neath the Workbench main window. The magnifier shows the area in detail
above.
Log
When you run a translation the Log shows statistics and processing inform-
ation that includes the following:
n FME version
n reader being used
n writer being used
n logging information
n warning messages
n command line information, including published parameters
Information messages are shown until the translation is complete.
In the event of an error message or unexpected output, you can analyze the
workspace to find which error has been introduced into the workflow defin-
ition. The log window is the most important place to look for information if a
translation does not complete as you expected.
You can search for text in the log window, copy selected contents of the win-
dow directly to another application, or save the contents to a text file.
By default, the log is overwritten each time a translation is run. You can con-
figure FME Workbench to append successive translations to the log file. On
the menu bar, select Tools > FME Options. Under Runtime, check Append to
log file.
Additional Viewing Options
To see all available viewing options for the Workbench interface, select View
> Windows:
You can select any window pane to toggle it on or off in the Workbench
interface.
The status bar below the canvas displays progress information and tooltips.
The Reader and Writer Gallery is a list of all formats supported by your FME
license. To open it, click the Tools menu and select Browse Readers and
Writers.
Format Information
The Reader and Writer Gallery includes the following information about each
format.
Select Tools > Browse Readers and Writers.
Column Definition
Description Full format name
Short Name Common abbreviation for the format
Extensions Lists file extension(s) associated with the format
Type Indicates whether the format is a file- or directory-
based format
Read/Write Indicates whether the format is a reader, a writer,
or both
Column Definition
Coordinate System Indicates whether a custom coordinate system is
associated with the format
Licensed Some formats require that you obtain special licens-
ing, or specific versions of FME. This column indic-
ates whether your FME is licensed to read/write the
format
Search field Enter a keyword or a partial text string to filter res-
ults.
Custom Formats but-
tons
n Create a new format using the Custom Format
wizard.
n Import a custom format and add it to the gal-
lery.
n Edit an existing custom format.
Close Close the gallery.
Details Click on a format, then click Details to display the
technical documentation for the format.
Some formats (for example, custom formats) are
preceded by an icon. For information, select the
format and click the Details button.
Custom Formats
The Custom Formats area of the Reader and Writer Gallery contains but-
tons for adding, importing, editing, and removing custom formats. This is
considered an advanced FME task.
For information, see Custom Formats in the Workbench help file.
Format Details FME Readers and Writers Manual
To view detailed technical information about a format, select a format
name in the list and click the Details button. This opens the applicable
format chapter in the FME Readers and Writers manual.
Understanding Workbench Concepts
Although FME can easily move data from one format to another, it is much
more than just a translator.
Data transformation is FME's ability to restructure data through the use of
transformers. One of the key features is that the transformation auto-
matically takes place between the reading (extract) and writing (load) of
data. By combining transformers in interesting ways, you can resolve a vari-
ety of translation and transformation challenges.
For users who are familiar with FME, transformers are best described as
packages around FME functions and factories, which are documented in the
FME Functions and Factories manual). In fact, most transformers include a
reference to a related function or factory. Just like functions and factories,
some transformers add attributes to features, others erase attributes, and
still others operate on the geometry. Transformers may operate on indi-
vidual features one at a time or on groups of features.
When the output from the Reader feature type or a transformer is connected
to another transformer, Workbench makes an implicit connection between
all attributes that have the same name. If necessary, Workbench auto-
matically assigns attributes to transformers based on both the transformer
itself (usually one specific attribute like count or length, for example) and
then appends the attributes contained in the input connection.
Data Transformation Types
Data transformation can be subdivided into two distinct operations: Trans-
forming Structure and Transforming Content.
Transforming Structure
This type of transformation refers to FMEs ability to channel data from
source datasets to destination datasets in an almost infinite number of
arrangements. This includes the ability to merge data, divide data, reorder
data, and define custom data structures.
FME transforms the structure of a dataset by manipulating its schema.
Transforming Content
This type of transformation refers to the ability to alter the content of a
dataset: manipulation of a feature's geometry or attribute values is the
best example of how FME can transform content.
Geometric Transformation
Geometric transformation is the act of restructuring the spatial component
of an FME feature. In other words, the physical geometry of the feature
undergoes some form of change to produce a different output.
Here are some examples of geometric transformation:
n Generalization a cartographic process that restructures data to be
more easily visualized at a given map scale.
n Warping adjustment of the size and shape of a set of features to
more closely match a set of reference data.
n Topology Computation conversion of a set of linear features into a
node/line structure.
Attribute Transformation
Attribute transformation is the act of restructuring the non-spatial com-
ponent of an FME feature. In other words the attributes relating to the phys-
ical geometry undergo some form of change to produce a different output.
Some examples of attribute transformation are:
Data Transformation Types
n Concatenation joining two or more attributes.
n Measurement measuring a feature's length or area to create a new
attribute.
n ID Creation creating a unique ID number for a particular feature.
Schema Definition
A schema (or data model) is the structure of a dataset or, more accurately,
a formal definition of a dataset's structure.
Each dataset has its own unique structure (schema) that includes feature
types, permitted geometries, user-defined attributes, and other rules that
define or restrict its content. A schema is a physical representation of the
data.
How Does FME Represent the Schema?
When you create a new workspace, FME reads the source dataset and cre-
ates a workspace definition of the schema. Usually, FME also creates a
placeholder for the destination schema; that is, a definition of the structure
of the destination dataset.
The example below shows the source and destination schema as they
appear in Workbench. Source data is on the left and destination data is on
the right. Each item is a separate feature type, so the example shows one
Reader feature type and one Writer feature type. Each feature type has a
set of attributes.
Connections between each item represent the flow of data. These con-
nections can branch in different directions, or even lead to a dead-end. You
will see a similar view to the one shown here after you generate the initial
workspace and before you add any customizations like new attributes or
transformers:
Schema Definition
A new workspace usually has identical reader and writer feature types; how-
ever, this is not always possible, particularly when the reader and writer
formats are different.
In these circumstances, FME attempts to compensate for any differences
between reader and writer feature types. For example, attribute names may
be shortened to compensate for formats that do not support attribute names
over a certain number of characters.
Viewing the Schema in FME Workbench
A schema is made up of many components. Some of these relate to a data-
set as a whole; for example, feature types belonging to a dataset are
regarded as part of the overall schema and are depicted in the Workbench
canvas.
However, some parts of the schema relate specifically to a single feature
type only. Attributes are one such component. These components are shown
in the Properties dialog of a feature type. Click the Properties button on the
feature type to open the dialog.
Feature Type Properties
The Feature Type Properties dialog contains detailed information about the
feature type.
The General Tab shows the name of the feature type and permitted geo-
metry types.
Clicking displays the feature representation help topic for the applic-
able format.
Merge Feature Type is useful when you have files that contain numerous
layers, you have similar source schemas, and you want to merge all sim-
ilar feature types for further processing, based on a matching pattern.
Schema Definition
The User Attributes tab shows a list of attributes present on the feature
type. Each attribute is defined by its exposure in Workbench, name, data
type, width, number of decimal places (precision), and if it is indexed in the
dataset.
This example shows a reader feature type, therefore, the attributes are
greyed out and not editable.
Note, however, that there is an option in Workbench that allows you to edit
some reader feature type properties (suitable mainly for testing purposes).
For information, see Editing Reader Feature Type Properties in the Work-
bench help file.
The attributes on a destination dataset can be edited to create the required
output.
The Format Attributes tab exposes, or makes visible, built-in FME attrib-
utes.
This area allows you to connect other attributes to these special, format-
specific attributes.
For detailed information, look at the application chapter for the writer
being used in the FME Readers and Writers manual.
Schema Definition
The Format Parameters tab lets you set additional parameters for cre-
ating a feature type in the dataset to which you are writing. Some formats
(usually a database format) require these additional parameters be specified
before they can be created in a target system. Most formats do not have this
tab.
Editing Schema
The default schema that FME creates is suitable for a quick translation. When
you need to customize the output schema, you can use Workbench to make
the edits.
Schema editing is the process of altering the destination schema to cus-
tomize the structure of the output data. For example, you can:
n rename an attribute
n change an attribute type
n rename a feature type
n change an allowed geometry type
n move a feature type to a different dataset
Some examples are shown below.
Open the Writer Feature Type Properties dialog and click the User Attrib-
utes tab. Column names will depend on the format but in general, you can:
Rename any attribute on the writer schema. Click the attribute to be
renamed and enter the new name.
Change the attribute type on the writer schema; for example, from an
integer to a float. Use the pull-down menus in the Data Type field.
Schema Definition
Open the Writer Feature Type Properties dialog and click the General tab.
Name Parameters: You can rename any feature type on the destination
schema. Click on the field to enter the new name.
General Parameters: Choose from the list of allowed geometries; for
example, you can change the allowed geometries from lines to points. This
field is disabled if the format permits all geometry types.
If the workspace contains more than one writer, you can switch a feature
type from one destination dataset to another. Click the drop-down list in the
Writer field.
For database formats, you can enter a username to connect to the database.
Click to display format-specific technical reference information from
the FME Readers and Writers manual.
Dynamic Properties: This advanced user setting configures writers to
use Dynamic Properties. See the Workbench help topics About Dynamic
Workspaces and Adding a Reader as a Resource.
Schema Mapping
Schema Mapping
Schema mapping is the means by which you transform a dataset's structure.
In FME Workbench, one side of the workspace shows the source schema
(which already exists) and the other side shows the destination schema
(which doesnt yet exist). Schema mapping is the process of connecting the
source schema (Reader feature type) to the destination schema (Writer fea-
ture type) in a way that ensures the correct Reader feature types are sent to
the right Writer feature types and the correct source attributes are sent to
the correct destination attributes.
Feature Type and Attribute Mapping
Feature type mapping is the process of connecting Reader feature types to
Writer feature types. Attribute mapping is the process of connecting Reader
(source) attributes to Writer (destination) attributes.
In Workbench, feature type mapping connections are shown with a thick,
black line. Attribute mapping connections are shown with a thinner, gray
line.
Attribute mapping is sometimes implied rather than visualized and no con-
nection is shown. The color of the port indicates the connection status, as fol-
lows:
n Green indicates a connected attribute.
n Yellow indicates a source attribute that is not connected to a des-
tination
n Red indicates a destination attribute that is not connected to a source.
Attributes with the same name in Reader and Writer feature types are con-
nected automatically. Note that attribute names are case-sensitive, so
ROADS is not the same as Roads or roads.
Schema Mapping in FME Workbench
In most cases, FME automatically fills in basic schema mapping in a new
workspace. You can then edit the schema mapping as required.
In Workbench's intuitive interface, feature type and attribute connections
are made by pointing and clicking, or by dragging connecting lines between
these parts of the schema.
Feature Type Mapping in FME Workbench
Feature type mapping is established by clicking the output port of a reader
feature type and doing one of the following:
n Move the cursor to the input port of the writer feature type, and click
to make the connection.
1. Click the reader feature type port, then click the writer feature
type port.
2. Click the writer feature type port to connect automatically.
Quick Connect also lets you quickly connect to multiple ports by
holding down the Ctrl key and clicking the ports you want to
connect.
n Drag the arrowhead across to the input port of a writer feature type
and release the mouse button.
Schema Mapping
A connecting line from Reader to the Writer feature type is being cre-
ated by dragging the arrowhead from the reader to the writer.
Attribute Mapping in FME Workbench
Attributes with the same names in both the Reader feature type and the
Writer feature type are connected automatically.
If the attributes do not have the same name, you need to manually establish
attribute mapping.
In this example, feature type mapping has already been established and
attributes are being connected. As the connections are made, the arrow col-
ors change from yellow and red to green.
To save time in this situation, you can use the AttributeCopier transformer.
To see an example, click Help > FME Transformers. In the FME Transformers
help window, search for AttributeCopier.
Features
A feature in FME is an individual item within the translation. Typically a GIS
or cartographic feature consists of a geometric representation plus a set of
related attributes. FME is capable of restructuring either of these com-
ponents.
A feature in FME is the fundamental (that is, smallest) unit of FME data.
Features have a flexible, generic representation. In other words, they have
a basic FME definition that is unrelated to their parent format.
Using FME, you can process data during a translation to produce a des-
tination dataset that is greater than the sum of its source components.
Using Transformers
Using Transformers
Just as source and destination data are represented by objects on the Work-
bench canvas, the tools used for geometric and attribute restructuring are
depicted by objects called Transformers.
For more details on using Transformers in Workbench, see Adding Trans-
formers.
Note that not all Workbench transformers are available in FME Base Edition.
For details, see the Transformer section of our website or view the Work-
bench help.
Creating a Workspace
The previous sections covered Workbench navigation, and basic terminology
and concepts. This section shows you how to set up and run a basic work-
space.
There are several ways to create a new workspace:
n Create a blank workspace so you can add readers, writers, and trans-
formers directly on the canvas.
n Generate a workspace by entering information in a dialog box.
n Generate a workspace using a wizard to fill in the workspace ele-
ments.
n Start with a template.
For the purposes of this chapter, you can start with the Workspace dialog.
n Start Workbench.
n Select File > New, and click Generate Workspace. You can also click
Generate Workspace from the Start tab.
The Generate Workspace dialog opens:
In the Reader Format field, do one of the following to populate the field:
n Type the readers format name. As you type, the auto-search func-
tion will suggest formats based on what you are typing.
n Open the pull-down menu and select from recently used formats.
n Click the Browse button to open the Reader Gallery (which contains
only formats that FME reads). From here you can type the format
name in the Search field or scroll through the list to find and select
the format. Click OK to accept the selection and close the gallery.
Click the browse button beside the Reader Dataset field, and browse to
the location of your source data. Note: It is sometimes faster to perform
this step first, before choosing the data format. When you add the Reader
Dataset first, FME will populate the Format field based on the dataset type.
The Parameters button becomes available for certain readers. These para-
meters allow you to specify more detailed information about the source
data, but you can always accept the defaults that FME provides. You do not
have to click the button to accept the parameter defaults. For help with spe-
cific parameters, press the help button from within any Parameters box.
n The Coord. System field will usually say Same as Source or Unknown.
You can accept this default in most cases. Clicking the browse button
beside this field will display the Coordinate System Gallery, which con-
tains all the coordinate systems that FME supports. See Using the
Default Coordinate System.
In the Writer Format field, do one of the following to populate the field:
n Type the writers format name. As you type, the auto-search function
will suggest formats based on what you are typing.
n Open the pull-down menu and select from recently used formats.
n Click the Browse button to open the Writer Gallery (which contains
only formats to which FME writes). From here you can type the format
name in the Search field or scroll through the list to find and select the
format. Click OK to accept the selection and close the gallery.
n The Parameters button becomes available for certain writers. These
parameters allow you to specify more detailed information about the
destination data, but you can always accept the defaults that FME
provides. You do not have to click the button to accept the parameter
defaults. For help with specific parameters, press the help button from
within any Parameters box.
n The Coord. System field will usually say Same as Source. You can
accept this default in most cases. Clicking the browse button beside
this field will display the Coordinate System Gallery, which contains all
the coordinate systems that FME supports.See "Using the Default
Coordinate System" on page 51.
n You can also enter a name and location for the destination data,
although FME will create the workspace without this information. You
will be prompted again to enter the information before you actually
run the workspace.
Click OK to generate the new workspace.
The Translation Log shows statistics and processing information. If you
close the Log, you can see a subset of logging information in Workbenchs
status bar.
When you save your workspace, the default workspace name mirrors the
formats you are translating (for example, shape2dwg.fmw.) You may want
to use a more specific filename.
Initially, you see the Reader feature types and a representation of the
Writer feature types.
In this example, Workbench has established the connections automatically
because the feature type and attribute names are the same.
This was described in "Schema Mapping" on page 39.
Refining the Reader and Writer
Refining the Reader and Writer
After you initially set up your workspace, you can perform a number of tasks
to customize the workspace. For example, you can:
n add additional readers or writers
n import or remove feature types
n combine or fan out feature types
n rename objects in the workspace
n combine data from multiple sources
More Information
Select FME Readers and Writers from the Help menu.
Defining Writer Characteristics
When FME generates the initial workspace, it reads the feature types from
the source data.
First, you might want to rename the Writer feature type so the name more
closely reflects what you want to see in the output data. You might also
want to change the attributes, by deleting or renaming them, or by editing
their properties.
When the output from the Reader feature type is connected to the Writer
feature type, there is an implicit connection made between all attributes
that have the same name. When you rename an attribute or add a new
attribute, you must physically connect the ports to create the links you
want.
Using the Default Coordinate System
Using the Default Coordinate System
Each feature that is processed by FME is coordinate-system aware, which
helps prevent confusion when reading multiple datasets belonging to dif-
ferent coordinate systems.
Each reader and writer in FME is assigned a default coordinate system. This
coordinate system is shown in the Navigator.
For formats that know their coordinate system, the Coordinate System for
the source dataset shows Same as source and FME reads the coordinate
system from the source dataset. For most other input sources, the field
shows <not set>, which means that FME uses default values or reads the
coordinate system from the source data.
You can explicitly set the source coordinate system (which overrides any
coordinate system read from the source), but, in most cases, you do not
need to change the default parameter.
When the destination coordinate system is also marked <not set> (as shown
in the above example), FME does not reproject the data, but writes it using
the same coordinate system as the source data.
Changing Coordinate System Parameters
FMEs Coordinate System Gallery includes more than 60 projections and
thousands of predefined coordinate systems. You can also define your own
custom coordinate systems, ellipsoids, datums, and units.
When a translation is defined so that the source and the destination coordin-
ate systems differ, FME automatically restructures the data at the end of
the translation so that the output is in the correct location.
More Information
Select FME Coordinate Systems from the Workbench Help menu.
Adding Transformers
Adding Transformers
Just as readers and writers are represented by objects on the Workbench
canvas, the tools used for geometric and attribute restructuring are rep-
resented by objects called Transformers. An introduction to transformers
was given in the section Transformer Gallery.
Two basic rules for transformers are:
n You can use the output from one transformer as the input to another.
n You can send the output from one transformer to more than one des-
tination.
This section describes the different methods used to locate, add, and place
transformers. If you know which transformer you need, see Quick Add. This
is the fastest way to include transformers in your workspace.
Locating Transformers
Placing a Transformer
Transformer Ports
Locating Transformers
Finding the right transformer for the task at hand can be challenging; how-
ever, there are a number of different resources that can help you narrow
down your choices.
The Transformer Gallery is organized into different folders depending on
each transformers function category, or by transformer name, under the All
folder.
There are other folders that contain previous search results, recently used
transformers, and custom transformers that may be embedded in a work-
space. You can also create your own folders.
You can search the gallery for both transformer names and descriptions.
Enter a keyword in the Search field. The keyword can be a partial trans-
former name, or one or more keywords that describe its function (such as
rename or join), or you can search for a common element, such as 3D or
raster.
Workbench displays a Search Results folder that contains a list of trans-
formers whose name or descriptions contain the matching keyword.
Click on a transformer to see a description of its functionality. This help
text displays in the Transformer Description pane.
Placing a Transformer
When you've located a transformer in the Transformer Gallery, double-
click it to place it in the workspace canvas. You can also drag and drop a
transformer onto the workspace canvas. This gives you greater control
over where the transformer is initially positioned.
After the transformer is placed on the canvas, you can include it in the
workflow by dragging connections onto the input port(s) and by dragging
connections from the output port(s).
Adding Transformers
A LineOnAreaOverlayer transformer has been placed and connected in the
workspace.
Transformer Ports
A transformer can have multiple input ports, multiple output ports, or both.
Quick Add
After you have worked with FME and you are a little more familiar with Trans-
formers, Quick Add is the easiest and fastest way to add transformers to
your workspace. Quick Add is a search bar that is embedded in the work-
space canvas.
n On the menu bar, click Tools > FME Options, and then click the Trans-
formers icon. Make sure that Auto connect after Quick Add is
checked.
n Click on a blank area of the canvas and type any letter. For this
example, lets say you want to add an AreaBuilder transformer. Start
typing the letters "ar..". As you begin to type, the Quick Add drop-
down menu appears on your canvas. As you continue to type more let-
ters, the menu will change depending on the matches in the Trans-
former Gallery. In this example, FME finds a number of matches based
on the letters "area":
n Select the AreaBuilder, and the transformer is immediately placed on
your canvas.
Select a feature type or another transformer before you initiate the
Quick Add search and the transformer will automatically connect to
your selected object.
n Type the slash / character. Workbench will remember the last trans-
former you added, and display it in the search bar. Press Return to
add it to the canvas. You can do this as many times that you want to
add the same transformer:
Inserting a Transformer into an Existing Link
You can insert a transformer into a link by holding it over an existing con-
nection. When you release the transformer, it is set in place. FME then
makes feature and attribute connections automatically. If either object has
multiple input or output ports, you are prompted to choose which specific
ports to connect.
Make sure you turn on the Enable/Disable Drag and Insert Trans-
former feature. On the Workbench toolbar, click the tool . (If this tool
does not appear on the toolbar: Right-click and select Customize Toolbar.
Scroll to the tool and drag it onto the toolbar.)
Drag the transformer over an existing link until the connection highlights in
pink.
Adding Transformers
Release the left mouse button and the transformer is placed and connected.
Note that you may have to edit or check the transformer parameters before
you can run the workspace.
Quick Connect
Quick Connect is a fast way to connect different areas of a workspace simply
by clicking the ports. This method is ideal for complex workspaces. Make
sure to Enable Quick Connect in Tools > FME Options > Workbench.
Click any port. The port is highlighted in orange until you click outside of the
port area or on another port.
Click directly on the destination port and a link is created between the two
ports.
You can also connect one port to multiple ports. Click the first port and then
press and hold the Ctrl key to complete multiple connects.
More Information
For detailed information, see the Workbench help topic Transformers >
Quick Connect.
Smart Delete
If you delete a transformer from a workspace, FME will try to repair any
connections from the deleted transformer. For example, deleting the Joiner
transformer below repairs the connections in the workflow, and reconnects
to the Inspector on the right:
Select the transformer and press the Delete key, or right-click and
select Delete from the command menu.
The repaired connections are highlighted. Clicking anywhere in the
workspace removes the highlight.
Adding Transformers
To delete a transformer without repairing the connections, press Shift +
Delete.
Note: Workbench cannot repair connections where there is
a many-to-many relationship between incoming and out-
going connections.
Multiple Transformers
You can connect a series of Workbench Transformers so that they have a
cumulative effect on the data.
Even though the Transformer Gallery contains hundreds of transformers, a
single transformer may not meet all your requirements. In this situation,
you need to use a combination of transformers.
A string of transformers that graphically represents an overall workflow is a
key concept of FME. Another key concept in FME is the ability to split data
into separate processing streams within your workflow or to merge several
streams into one. When a workspace becomes a complex series of parallel
streams it is important that you test each stream separately, and also be
aware of how changing one component can impact other sections further on
in the workflow.
About Transformer Parameters
Every transformer contains at least one parameter: the Transformer Name.
Most transformers also have additional parameters that you can change to
suit your workspace.
Access these parameters by either clicking the Properties button to the top
right of each transformer, or by right-clicking a transformer and selecting
Properties.
Transformer Colors and Icons
Transformers are all color-coded.
l All regular transformers are blue.
l You can also create Custom Transformers, which can be green or cyan,
depending on whether they are embedded or linked. Custom trans-
formers are described in detail in the FMEWorkbench help file.
Some transformers, such as the Inspector, have their own distinctive icon.
Transformers that output new features have an icon on the left.
Transformers that consume data outside of the normal workspace flow
have an icon on the right.
Properties Button Colors
The properties button on a transformer is color-coded to reflect the status
of its parameters.
A blue properties button (or one that matches the
color of its transformer) indicates that the default
transformer parameters have been checked and
amended as required, and the transformer is ready to
use.
A yellow properties button indicates that the default
parameters have not yet been checked. You can use a
transformer that is in this state, but the workspace
results may be unpredictable.
A red properties button indicates that there is at least
one setting for which FME cannot supply a default
value. You must provide a value for the required para-
Adding Transformers
meter(s) before you can use the transformer. These
transformers are listed as Incomplete Transformers
in the Navigator.
Accessing Parameters
Click the Properties button to the top right of each transformer to open a dia-
log. This dialog contains defaults that Workbench initially sets for the trans-
former.
In many cases, you can use the transformer without changing the default val-
ues; however, sometimes you will need to perform an action before you can
use the transformer. In these cases, the transformer parameter will be high-
lighted red, as shown in the Buffer Amount parameter below:
Transformer Parameter Menu Options
Advanced transformer parameters are integrated in most transformer dia-
logs, so that the options can be easily configured with other elements in the
workspace. Click the menu button to access these parameters.
Advanced parameters can be set, changed, published or unpublished, set to
an attribute value, or linked to another parameter. Additional functions, such
as an advanced editor and an arithmetic editor, are also available in some
transformers.
Note:In many cases, you can use the default transformer parameters
without having to access the transformer parameter menu.
See Transformer Parameter Options in the FMEWorkbench help file.
Saving Defaults
See Transformer Defaults in the FMEWorkbench help file for information
on saving default values.
Custom Transformers
A Custom Transformer allows you to create a single transformer to replace
a sequence of transformers from an existing workspace. Custom trans-
formers use the same data flow as the original transformers, and can be
reused and edited just like any other transformer.
Custom transformers can be used:
n to streamline a large workspace
n to make various data flows within a workspace more understandable
and easier to document
n as a replacement for the same chain of transformers multiple times
within the same workspace
You can also export a Custom Transformer. After they are exported, cus-
tom transformers can be:
n edited independently of any workspace
n shared with other users (through e-mail or shared directories)
n embedded or linked in any number of workspaces
n stored as a separate .fmx file
More Information
For detailed help see the Workbench help topic on Custom Transformers.
For detailed information on all transformers, select Help > FME Trans-
formers.
For help with individual transformers, you can also click the Help tab, loc-
ated next to the Log tab. This tab displays help on any transformer you click
on in the Canvas, Navigator, or Transformer Gallery.
Transformers Reference Guide
You can download a printable, quick-reference guide (in Adobe
PDF format)
from http://www.safe.com/support/onlinelearning/documentation.php.
Creating a Custom Format
When you create a Custom Format, you can define your readers, your work-
flow, and the format's schema, and you can use it like a standard FME
Source Format. This is useful if you consistently use the same information
in a workspace, and when you consistently perform the same processing on
datasets.
More Information
Select Workbench Help from the Help menu, and open the Custom
Formats topic.
Organizing the Workspace
In this section:
n Using Bookmarks
n Creating Annotations
Using Bookmarks
If you have a large workspace, it can be difficult to keep it organized. Book-
marks help you define sections of a workspace. Bookmarks are particularly
useful when youre working with large or detailed workspaces and you fre-
quently refer to a certain area.
Click the bookmark tool in the toolbar or select Insert > Bookmark
from the menu bar. Selecting an area of the workspace (for example, a trans-
former) before adding the bookmark ensures that the bookmark encloses
the selected area.
When the bookmark appears in the workspace, the text field in the book-
mark is highlighted so you can enter a new name as soon as the bookmark
appears. If the characters in your name exceed the width of the bookmark,
the name is truncated.
Bookmarks are also added under the Bookmarks folder in the Navigator:
Double-click a bookmark to zoom to its location in the workspace or single-
click to center the workspace on the selected bookmark. You can change a
bookmarks properties at any time.
You can also export a bookmark to create a custom transformer.
More Information
Select FME Workbench from the Help menu, and open the Bookmarks
topic, or open the Custom Transformers topic.
Creating Annotations
Annotations are useful for documenting the purpose of a feature type, con-
nection, or transformer, especially in a large or complex workspace.
Annotation is a key method for a good workspace design. Annotation helps
other users understand the purpose and workflow of the translation, and
also helps the original workspace author remember key information.
There are a few annotation types to choose from.
Default Annotation
By default, Workbench adds three annotations to a new workspace. The
annotations are basic comments that indicate the source data, the trans-
formation, and the destination data. You can select and delete them.
To disable the default feature, select Tools > FMEOptions, and click the
Workbench icon. Under Annotation Defaults, uncheck Automatically gen-
erate header annotations.
Summary Annotation
A summary annotation is an FME-generated comment that provides inform-
ation about any object in the workspace. This item can be a reader or
writer feature type, or a transformer. Summary annotations automatically
update if its attached object is changed. Summary annotations are useful for
wizard-based transformers where checking transformer parameters can be
time-consuming.
To create summary annotation for an object, right-click it and select Show
Summary Annotation.
A summary annotation is always colored blue to distinguish it from other
annotations. It is always connected to the item to which it relates and cannot
be detached.
Custom Annotation
You can add comments anywhere in the workspace:you can attach annota-
tions to objects, or you can create stand-alone comments.
Click Insert > Annotation on the toolbar, or right-click on the canvas and
select Insert Annotation.
To attach an annotation to an object in the Workspace (feature type or trans-
former), select the object, right-click and select Attach Annotation.
Annotation Options
Right-click on any annotation and view command menu options. You can
attach or move the annotation to any object or connection in the work-
space, or detach it from its attached object.
Attaching Default Annotations to Multiple Objects and Connections
The default annotation includes the name of the object (transformer, fea-
ture type, etc.).
For connections, the default name reflects both the input and output inform-
ation. For example, if you select a transformer connection, the name will
reflect the input to the transformer, and the output from the transformer
(PenColorSetter > AttributeCreator).
1. Select multiple objects or connections.
2. Right click and select Attach Annotation.
Annotations are added to the selected objects and connections. Objects will
show the object name as default string, and connections will show
<source> to <destination> as the default string.
Right-click on an annotation and select Follow Attached Object. You can
move an object anywhere on the workspace and the annotation will
move with it. If you uncheck this option (select it again to toggle it on
and off), a leader line will stretch to follow an object, but the comment
will remain in its original location.
By default, annotations appear in front of the display and can overlay
other parts of the workspace. To move annotations to the back of the
display, right-click on an annotation and select Send to Back. This also
works for feature types and transformers.
Running the Translation
There are three options for running a translation:
Function Tool What it Does
Run (or Resume) Runs the translation from start to finish, or
resumes a translation after pausing.
Prompt and Run
Runs the translation and prompts you to
enter selected parameters (for example, you
may want to use different source data or
change a transformer parameter). For details
about this option, see Running a Workspace
with Parameters in the FME Workbench
help.
Run with inspection
Runs the translation using the Feature
Inspector, after you define an inspection
point. For details about this option, see
Feature Inspector in the FME Workbench
help.
No matter which option you choose, FME will begin the translation, and youll
see information in the Log window.
The amount of time the translation takes depends on different factors that
may include the following:
n the processing power of the FME host machine
n the size of your data
n the amount of processing that FME has to do
After you run the translation (and unless you have redirected output to an
Inspector), the output is written to the location you specified in the Writer
Dataset field.
Using the Feature Count Display
The feature count display is an optional function, but it is one of the most use-
ful testing and observation tools. It helps you analyze the results of a
workspace and provides a reference for debugging if the destination data
differs from what was expected.
By default, the feature count display is turned off. Activate it by clicking the
Display Feature Counts tool . If the tool is not shown on the toolbar,
right-click on the toolbar and select Customize Toolbar. Scroll to the tool
and drag it onto the toolbar.
When you use the Feature Count display, each connection is marked with
the number of features that passed along it, as shown here:
The feature counts above show that 26 features passed into the trans-
former, with 1 feature passing the Tester criteria, and 25 features not
passing. The translation log confirms the number of features written.
Running a Batch Translation
The FME Workbench interface supports batch execution and batch script cre-
ation. For example, you can apply an existing workspace transformation to
a large number of input files, and produce separate outputs for each.
More Information
For detailed information see Running a Batch Translation in the FME Work-
bench Help.
For More Information
For more detailed information about FME Workbench, select FME Work-
bench from the Help menu, work through the FME Desktop Tutorial, down-
load the Self-Study Modules, or register for a hands-on training course
taught by accredited professionals.
Workbench Keyboard Shortcuts
http://docs.safe.com/fme/pdf/FMEWorkbench_Keyboard_Shortcuts.pdf
Using the FME Data Inspector
The Data Inspector is cross-platform, uses the latest display technology, and
supports 3D viewing.
The FMEData Inspector allows you to view and save data in any FME-sup-
ported format. It is used primarily to preview data before translation and to
verify it after translation. It can also be used to check data at any point dur-
ing a translation.
The FMEData Inspector is the default inspection application:it includes more
functionality than the previous inspection application, the FMEUniversal
Viewer. For this release, you can still use either the Universal Viewer or the
Data Inspector to view data when working in FME Workbench or Quick Trans-
lator. To change your default viewer, choose Tools > FME Options and click
the Workbench icon. Under Inspection Application, select Use FME Universal
Viewer.
This chapter gives a high-level overview of Data Inspector functions see
the FME Data Inspector Help files for detailed information.
Starting FME Data Inspector
Starting FME Data Inspector
You can start the Data Inspector in the following ways.
To start the Data Inspector as a stand-alone application
Do one of the following:
n From the Windows Start menu select All Programs > FME Desktop >
FME Data Inspector.
n Using Windows Explorer browse to your FME installation folder and
click fmedatainspector.exe.
n Using Windows Explorer right-click a supported GIS or CAD file, and
open it using FME Data Inspector.
To start the Data Inspector from FME Workbench or FME Quick
Translator
The FMEData Inspector is the default inspection application, and it will open
when you a run a translation using FME Quick Translator.
When using FME Workbench, the Data Inspector will open when you run a
translation under any of the following conditions:
n An Inspector transformer is connected to the workflow.
n Run Translation with Inspection is specified.
n Redirect to Inspection Application (under the Writers menu) is
checked.
FME Data Inspector Viewer Interface
The following screenshot shows the different sections of the Data Inspector
interface:
1. Menu bar and toolbar - Provides commands for performing a vari-
ety of functions in the Data Inspector. For more information, see
Menu Commands, Tools and Shortcuts.
2. Display Control window - Shows a list of open datasets and their
various feature types. These components are displayed as a
hierarchy of levels that can be turned on or off, from entire datasets
down to individual feature types.
3. View window - The spatial display area. You can open multiple data-
sets at the same time, and add datasets to an existing view.
4. Feature Information window - Shows information about a feature
that is queried in the View window, including feature type, attributes
(both user and format attributes), coordinate system, and geometry
details. For more information, see Querying Features.
5. Table View window - Displays feature data in tabular format.
6. Log window - Reports information related to the reading and showing
of a dataset, which you can use to confirm that data was read cor-
rectly. It shows statistics and processing information whenever you
open a dataset.
7. Status bar - Displays general information on the status of the Data
Inspector. It shows which feature is being read when a dataset is
opened, and indicates when the Data Inspector is drawing a dataset on
screen. It also indicates the coordinate location of the mouse as you
move across a dataset displayed in the View window.
Menu Commands, Tools, and Shortcuts
File
Command
Keyboard
Shortcut
Function
Open Dataset Ctrl+O Opens a file browser so you can
pick a dataset.
Open Recent Displays a list of the most recently
viewed files.
Add Dataset Ctrl+D Opens a file browser so you can
add a dataset to the current view.
Command
Keyboard
Shortcut
Function
Close View Ctrl+F4 Closes the current view.
Save Data As Ctrl+S Saves the current view to a sep-
arate dataset. See Saving Data.
Save Selected Data As Ctrl+Alt+-
S
Saves the selected features to a
separate dataset. See Saving
Data.
Exit Ctrl+Q Shuts down the FMEData
Inspector.
View
Command
Key-
board
Shortcut
Function
Windows Provides options to show or hide
the following parts of the user
interface:
n Display Control Window
n Feature Information Win-
dow
n Log Window
n Table View Window
n Status Bar
Command
Key-
board
Shortcut
Function
n Toolbar
n Tab Bar
Table View
2D
3D
Ctrl+1
Ctrl+2
Ctrl+3
Toggle between table, two-dimen-
sional and three-dimensional
views.
Refresh F5 Reload the data from the source.
The Data Inspector will close the
dataset and re-read everything in
it from the source directory.
Any changes that have been made
to the source dataset since it was
opened in the Data Inspector will
be updated in the View Window
when the dataset is refreshed.
Note:Do not use the Refresh
button when you are viewing
data routed directly from
FMEWorkbench.
Stop Esc Cancel the current dataset being
loaded.
Camera
Command
Keyboard/
Mouse
Shortcut
Function
Pan Mode Ctrl+N
Press and
hold both the
left and right
mouse but-
tons.
Move the camera view vertically
and horizontally. Click and drag
the pointer to pan the current
dataset.
Orbit Mode Ctrl+R
Hold down
the middle
mouse but-
ton.
Rotate a 3D image in the view
window to inspect it from many
different angles.
Note that this command is not
available in 2D view mode.
Zoom In Mode Ctrl++
Hold down
the Shift
key.
Moves the view closer, by incre-
ments, or farther away, by incre-
ments.
Tip:You can zoom in and out in
the View window without activ-
ating the zoom tools by using
the scroll wheel on your mouse.
The zoom tools are location
aware, in other words, they
draw the focus of the view to
where you click or to your
Command
Keyboard/
Mouse
Shortcut
Function
mouse location when using the
scroll wheel to zoom.
Zoom Out Mode Ctrl+-
Hold down
the Ctrl key.
Zoom to Selected
Feature
Ctrl+L Concentrates the view on the
selected feature.
Zoom to Full Extent Ctrl+E Zooms the view to a distance so
that the data is visible and
centered in the window.
Tools
Command
Keyboard
Shortcut
Function
Select Ctrl+K Selects a feature, and displays
information in the Feature Inform-
ation pane.
Select All Features with
No Geometry
Ctrl+G Selects all features that have no
geometry (for example, a data-
base record may consist entirely
of features that have an fme_type
of fme_no_geom).
Filter Features Opens the Filter Features dialog
for displaying only features that
satisfy a set of filter conditions.
Command
Keyboard
Shortcut
Function
Measure Distances Ctrl+M Enables the measuring tool. Click
and drag between two points in the
View Window to measure the dis-
tance between them.
FME Options Opens the FME Options dialog for
configuring optional Data
Inspector features, such as Back-
ground Map.
Settings
Command
Key-
board
Shortcut
Function
Background Color Ctrl+B Opens a dialog for selecting a new
background color in the View Win-
dow.
Stereo Mode Off: Turns off any stereo effect,
bringing the display image back
to the original 2D default.
Anaglyphic: Gives the display
image a stereoscopic 3D effect
when viewed with glasses with a
red left lens and a cyan right lens.
The display image will consist of
two superimposed color layers off-
set with respect to each other to
produce a depth effect.
Window
Command
Keyboard
Shortcut
Function
Views If more than one view is open, this
menu switches the focus of the
tabs in the main window.
Log Window
The Log shows detailed information and statistics on the dataset.
Viewing Data
The Data Inspector allows you to view data in any FME-supported format.
Click the Open Dataset icon or select File >Open Dataset. This
opens the Select Dataset to View dialog. Specify the format of the file
you want to read by clicking the browse button , which opens a gal-
lery of reader formats. Once you have selected the desired format, you
must specify the data file to view. Click the browse button to launch
a file browser. Browse to the appropriate data file(s) and click Open.
An easier alternative is to start the FMEData Inspector and drag a file
onto the main window. The Select Dataset to View dialog opens with the
Reader format and dataset fields already filled in. Click OKto load the
data in the View window.
View Modes
The FMEData Inspector can view both 2D and 3D data.
When you select a dataset for viewing, the Data Inspector detects whether
the data is in two or three dimensions, and opens in the corresponding view
mode.
Alternatively, you can view exposed user attribute data in tabular format in
the Table View window. Tabular data can be viewed either directly in the
View Window, or in another window of the interface. The Table View sup-
ports sorting, selecting, copying and filtering data.
You can switch the current view mode by using the View menu, or by click-
ing the 2D, 3D or Table View button on the toolbar.
Adding Datasets
You can add datasets to a pre-existing viewing area, including com-
binations of vector and raster data.
Click the icon or select File >Add Dataset. For assistance in filling in
the Format and Dataset fields, see Viewing Data.
Viewing Data
Alternatively, drag and drop a dataset onto the View window.
The new dataset opens in the currently active view window and the addi-
tional dataset name and features appear in the Display Control Panel.
Merging Similar Datasets
If you have several datasets that are the same format, but are in different
locations, you can add them all at the same time, then view them as a single
merged dataset.
After selecting an initial source dataset in the Select Dataset to View dialog,
click the Advanced Browser button to show the selection dialog. After
selecting files and/or directories in the Select File dialog, click OK.
The Data Inspector merges the specified datasets and appends the added
datasets to the original.
Filtering Feature Display
In 2D or 3D view mode, you can apply a filter to a view to display only the
features you want. With the Filter Features tool, you can create expres-
sionsfrom simple to highly complexto define your filtering criteria.
To Apply Filters
1. Click the Filter Features tool on the toolbar ,or select Tools > Fil-
ter Features from the menu bar.
2. On the Filter Features dialog, check Enable Filters, and specify the
following:
n Pass Criteria - If your filter contains more than one test
clause, this value determines how the data is filtered in
the final results, based on the results of each clause. You
can specify OR, AND, or create your own expression from
a composite of AND and OR operators.
n Test Clauses - The filter criteria expressions. The Filter
Feature dialog provides a variety of operands for building
expressions, along with a set of functions you can perform
on feature attributes to further refine your expression.
3. Click OK.
For a detailed description of the fields in the Filter Features dialog, see Fil-
ter Features Dialog.
To Remove Filters
1. Click the Filter Features tool on the toolbar ,or select Tools > Fil-
ter Features from the menu bar.
2. On the Filter Features dialog, uncheck Enable Filters.
3. Click OK.
Using_the_Measuring_Tool
The measuring tool makes it easy to determine distances between two
points. One use of this tool is to determine how close things are so that you
can set and adjust tolerances during format translations.
The measuring tool is available only when viewing data in 2D mode.
Click the measuring tool or type Ctrl+M. You see a crosshair in the
View Window.
Click and hold to drag the crosshair from point A to point B.
Release the mouse button. The Log window shows the distance measured,
as well as start and end coordinates. The measured distance is also shown
in the Status Bar on the lower left:
Querying Features
Querying Features
To query a feature in 2D or 3D view mode, click the Select tool , then
click on a location in the View window. To select more than one feature, click
and hold the left mouse button, then drag the cursor around the desired
area.
Note: Selecting features in 3D mode works in a slightly dif-
ferent way: when you click on a feature, the tool selects all
the features along an imaginary line that goes straight
through the View window. In other words, it also selects all
the features located directly behind the one that you click on.
Information about the feature(s) is displayed in the Feature Information Win-
dow, including properties, attributes and geometry.
Querying Features
Click on the coordinates of a point listed in the geometry section, and the
point is marked in the ViewWindow with a red pin (or a blue dot, if in 3D
mode).
If multiple features are selected, they are all highlighted in green in the View
Window and the feature whose information is currently displayed in the
Feature Information Window will be highlighted in orange to allow it to stand
out from other selected features.
Querying Raster and Point Cloud Features
The techniques for inspecting raster and point cloud datasets are slightly dif-
ferent than those for inspecting vector datasets.
There are two ways to use the Query tool on a raster or point cloud
dataset:querying a cell or point, and querying a dataset itself.
Querying a Raster Dataset
A single click onto a raster dataset queries the cell under that click and pro-
duces output in the InformationWindow.
Selecting an area of the raster dataset with a click and drag motion queries
the dataset as a whole.
Querying a Point Cloud Dataset
Click on a point in the point cloud to show the Single Point Information. This
includes the ground location and other optional properties such as intensity,
angle, number of returns, and scan direction.
Note: You must be in 3D view mode to select point cloud
points.
Drag the cursor to select an area of a point cloud dataset to show the Point
Cloud Properties. This information includes feature type, coordinate sys-
tem, extents, number of points, attributes, and components.
Saving Data
Saving Data
You can save data that you view in Data Inspector to a separate dataset,
either in its original format, or to a different format.
Data Inspector provides the following options for saving data:
n Save Data As: Saves the current view as a separate dataset, includ-
ing all spatial and non-spatial features associated with the selected fea-
ture types in the Display Control Window.
"Save Data As" is an alternative to using the FMEQuick Translator.
n Save Selected Data As: Saves only the features you select, either in
the View Window or in the Table View, as a separate dataset.
When you save data that originates from multiple datasets, in the same
format or different formats, it is merged into a single dataset of the specified
destination format.
To Save the Current View to a Separate Dataset
1. In the Display Control Window, select the feature type(s) you want to
include in the dataset.
2. Do one of the following:
n Click the Save Data As button in the toolbar.
n Under the File menu, select Save Data As.
n In the Display Control Window, right click on the View name, and
select Save Data As.
3. In the Save Data As dialog, specify a format and location for the data-
set, and any other applicable settings.
4. Click OK. (If you decide to abort the translation while it is running,
click the Stop button on the toolbar.)
The results of the translation are displayed in the Log Window.
To Save Selected Data to a Separate Dataset
1. In the View Window or the Table View, select the features you want
to include in the dataset.
2. Do one of the following:
n Click the Save Selected Data As button in the toolbar.
n Under the File menu, select Save Selected Data As.
n In the View Window or Table View, right click and select Save
Selected Data As.
3. In the Save Selected Data As dialog, specify a format and location for
the dataset, and any other applicable settings.
4. Click OK. (If you decide to abort the translation while it is running,
click the Stop button on the toolbar.)
The results of the translation are displayed in the Log Window.
Using FME Quick Translator
Use an automated translation whenever you want to move data from a
source system to the destination system quickly and with minimal effort. In
most cases, an automated translation produces exactly the results you need.
Specifying the Reader
You can start the Quick Translator in the following ways.
To start the Translator as a stand-alone application do the following:
n From the Windows Start menu select All Programs > FME Desktop >
Utilities > FME Quick Translator.
After you start the FME Quick Translator, locate the dataset that you want
to translate. The dataset may be a directory, a file, or a group of files
depending on the format you choose.
Note: Select Tools > Browse Readers and Writers to see a
list of FME-supported formats and their file extensions.
Enter any character string (including file extensions) in the
Search field to show matching formats.
Drag the source files onto the FME Quick Translator window this is the
easiest method because the source information is already specified. FME
knows the format from the file extension.
The Set Translation Parameters dialog opens, with the reader fields pop-
ulated. Before you can run the translation, you will have to enter the writer
information.
Merging Similar Datasets
You can specify multiple datasets of the same format and with the same
schema (data model). These datasets will be merged together when you
run the translation.
1. Click the Advanced Browser in the Set Translation Parameters dialog
to display the Advanced Dataset Manager.
2. Click Add Files to browse for and select individual files.
3. Click Add Directories to browse for and select specific directories.
All files in the specified format in the directories will be included.
Specifying the Reader
Note: You can check the Subdirectories box to include all sub-
folders below that directory. For formats such as ArcInfo Cover-
ages, the dataset consists of an entire directory.
4. Check the Identical Schema box if you know that all files have the
same schema.
If you check the box, then FME will not have to perform an initial scan
of all the files to determine their schemas. Instead, FME will read the
first file as representative of the data model.
5. To remove a directory from the list, select it and then click Remove.
6. Click OK. The new datasets will append to the original dataset name.
When you run the translation, it will merge the specified datasets. The
log window will display detailed information during the translation.
Note: The batch translation radio buttons will now be enabled. You can
choose to merge files to one destination for a regular translation, or
choose separate output destinations for each file. If you choose separate
output destinations, you will be running a batch translation.
Reader Parameters
Some formats contain Reader Parameters boxes, which allow you to specify
additional parameters specific to the selected format. When you select one
of these source formats, the Parameters button becomes available.
Note that you dont have to specify any parameters when your format sup-
ports this feature FME simply uses default values. If the source format
doesnt support any special parameters, the button remains dimmed and
unavailable.
More Information
For detailed help on parameters boxes for specific formats, open a para-
meters box and press the F1 key or the Help button.
Converting Coordinate Systems
For systems that know their coordinate system (such as MapInfo and DLG),
the Coordinate System field in the dialog shows Read from Source, which
instructs FME to read the coordinate system from the source dataset. For
most other input sources, the field shows Unknown, which means that
FME uses default values. In most cases, the default value is all you
need to perform the translation.
If, however, you want to convert the coordinates of your data between a
specific source and destination Coordinate System, you can either enter the
name of the source and destination Coordinate Systems or choose them
from the Coordinate System Gallery, shown here.
Converting Coordinate Systems
Choosing from the Coordinate System Gallery
Open the Coordinate System Gallery by clicking the Browse button next to
the Coordinate System field.
Select a coordinate system from the existing list and either click the Prop-
erties button to show detailed information or click OK to tell FME to use this
coordinate system in the translation.
To filter the list and show only the coordinate systems you want, use the
menu selections at the bottom of the window.
More Information
For detailed help on coordinate systems and how to define custom coordin-
ate systems, open the Coordinate System Gallery and press the F1 key.
Viewing the Reader Dataset
To view the reader source dataset, click the Viewer button.
Note: You can also select a different reader to view, how-
ever, the reader information you specified does not change
to reflect the new filename that you select.
More Information
See Using FME Data Inspector or open the FMEData Inspector help.
Entering Writer Information
Entering Writer Information
On the Set Translation Parameters dialog, enter or select the Writer Format
and Dataset. The Writer Dataset name may be a directory or a file, and may
also be the same as the Reader Dataset name.
Note: If you enter an existing filename, the existing file
will be overwritten. Make sure you want to do this, because
FME does not prompt you before overwriting the file.
Click OKto start the translation.
Writer Parameters
Some formats contain Writer Parameters, which let you specify additional
information specific to your selected format. When you select one of these
formats, the Parameters button becomes available.
Note that you dont have to specify any parameters when your format sup-
ports this feature FME uses the default values. If the destination format
doesnt support any special parameters, then the button remains dimmed
and unavailable.
More Information
For detailed help on parameters boxes for specific formats, open a para-
meters box and press the F1 key or the Help button.
Choosing a Mapping File
Choosing a Mapping File
Mapping files control how FME converts data from the selected Source
Format to the selected Destination Format.
The Mapping Files area on the Generate Mapping File dialog shows only those
mapping files that are relevant for the source and destination information
youve entered.
Choose a mapping file from the list.
To start the translation immediately, double-click the mapping file.
If you choose an automated mapping file, FME generates the file using the
source and destination information you specified, and then deletes the file
when the translation is complete. If you want to use a customized mapping
file, then FME reads the file from the location specified in the Mapping File
Registry and uses that information to perform the translation.
Note: If there are no mapping files visible in this area, you
have to create one and add it to the Mapping File Registry.
More Information
You can read the topic Mapping File Syntax by selecting FME Quick Translator
Help, and then selecting Mapping File Syntax.
Deciding on the Next Step
Switching to FME Workbench
After you choose your mapping file, you might want to refine your trans-
lation using FME Workbench. This means that you continue the translation
using Workbenchs user interface you will get the same results but you
can set up your translation in a graphical environment.
In the Writer section of the Set Translation Parameters dialog, click the
Workbench icon:
The Generate Workspace dialog opens. The dialog is populated with the
source (Reader) and destination (Writer) information that you specified in
the Set Translation Parameters dialog.
You can change the default filename as long as you keep the .fmw exten-
sion.
More Information
See Setting up a Workspace or select Help > FME Workbench Help.
Performing a Basic Translation
If youre performing a basic translation and you dont want to add any
advanced functions, you can start the translation now following the instruc-
tions provided in Running the Translation.
Start the translation by either double-clicking the mapping file you chose in
Choosing a Mapping File, or by clicking OK in the Set Translation Parameters
dialog.
FME begins the translation and you can view the information in the Log.
The amount of time the translation takes depends on different factors that
may include the following:
n the processing power of the FME host machine
n the size of your dataset
n the amount of processing that FME has to do
In most cases, however, a successful translation takes a few minutes at
most, and the Log reads Translation was SUCCESSFUL. You can scroll back
through the log to check specific statistics.
FME Quick Translators interface supports batch execution and batch script
creation. For example, you can translate a large number of input files and
produce separate outputs for each. You can run the batch translation imme-
diately or save a batch script to be run later, potentially on another platform.
For further information, search FMEpedia for the topic Running a Batch
Translation.
Stopping a Translation
The Stop button becomes available when youre running a translation.
Click it to immediately stop the translation. The Log view states Translation
Stopped.
When you stop a translation, any output file is left incomplete and is not
usable. If you run the file again, the entire translation restarts, overwriting
any partial results from a previously interrupted translation.
Note: Sometimes stopping a translation causes FME to
create temporary files that can take up unnecessary disk
space. Its a good idea to select Tools > Purge Temporary
Files (or press Alt + C) after you stop a translation.
Saving Log Text
You may find it useful to save a text file of statistics or other processing
information from a translation run. Save the logged text by using the Save
button or by choosing Save As (Ctrl+S) from the File menu.
Enter a filename in the dialog that opens and click the Save button.
Copying and Searching Log Text Information
Note: You cannot paste text into the Quick Translator log,
however, you can paste it into another application, such as
a text editor.
To copy text and paste information to another location, select the text that
you want to copy, click the Copy button , open a text editor, and click
Paste or press Ctrl+V.
You can also copy information by doing any of the following:
n Select the Log menu and choose Copy.
n Press Ctrl+C.
n Right-click the text you want to copy and choose Copy.
To find for all instances of a search term, click the Search button . Type
your term in the dialog that appears, and click Find. To locate the next
instance of the term in the Search results, click the Find Next button .
Viewing the Output File
Viewing the Output File
View the output file with the FME Data Inspector. If the application isnt
already running, start it and open the output dataset.
More Information
See Using FME Data Inspector or the open the FMEData Inspector help.
This chapter gives a high-level overview of Quick Translator functions see
the FME Quick Translator on-line help files for more detailed information.

F Me Getting Started

Uploaded by

Copyright:

Available Formats

F Me Getting Started

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

F Me Getting Started

Uploaded by

Copyright:

Available Formats

Getting Started with FME

You might also like