TransporterSender
Sends features to another FME workspace running in a different process, which may be located on the same machine or on a different machine.
To transport features from one FME process to another: use the TransporterSender transformer in the source FME workspace to send features to a TransporterReceiver transformer in the receiving FME workspace.
Note: Used in conjunction with TransporterReceiver.
Input Ports
This transformer accepts any feature.
Output Ports
This transformer has no output ports.
Parameters
Specify how you want to transfer data. The transfer mode must be the same for both the TransporterSender and the TransporterReceiver.
- Stream: Feature data is transferred over the network connection as raw binary data.
- TCP/IP: All feature data will be transferred over the network connection.
- TCP/IP (Attribute): Only the value of a selected attribute is streamed.
- File: The feature data will be saved to disk and the location of the file will be sent over the TCP/IP connection.
The Initiation Sequence specifies which Transporter endpoint is responsible for establishing the Transport stream (ESTABLISH), and which is responsible for connecting (CONNECT).
Note: The workspace that establishes the transfer mode must be running before the connecting workspace. The transfer mode must be consistent if there are multiple transport streams between two workspaces.
This parameter is only needed by the workspace with the Initiation Sequence parameter set to CONNECT, and only when the workspaces are running on different machines.
One of the primary uses for this parameter will be local to a machine in order to partition large workspaces into smaller components that each have their own address space.
Specify either a port number or a service (for example, http, ftp, telnet, imap, gopher, pop3, www, and smtp are services that are typically associated with well-known port numbers).
The default value is 8586.
This parameter is only used when Transfer Mode is set to File. It specifies the base file name to use.
Each file that is created will have a -<integer> appended to the end of the name to keep all files unique.
Example: If the File Name is features.fft, the first file created is features-0.fft, the second file created is features-1.fft, and so on. The full path of the file will be passed to the receiver and the receiver must be able to access the file from the same path (drive letter included).
This parameter is only used when Transfer Mode is set to File. It specifies how many features to write to a file before sending the location of the file to the receiver.
This parameter specifies the name of the output attribute. It is required only when the Transfer Mode is set to TCP/IP (Attribute).
Usage Notes
- One workspace is the designated "establisher" of the transport stream. If there are multiple transport streams between workspaces, one workspace must be the establisher of all the streams, and the other will connect to those transport streams. This is regardless of whether the individual transporters are sending or receiving data.
- The establishing workspace must be started before the workspace that is connecting. A transporter cannot successfully connect to a transport stream that is not already established.
- For each transport channel, there must be a different port that is used for each server machine.
- You can use an arbitrary number of transporters within a workspace.
- Supports IPv6.
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
These functions manipulate and format strings. | |
Special Characters |
A set of control characters is available in the Text Editor. |
Math functions are available in both editors. | |
Date/Time Functions | Date and time functions are available in the Text Editor. |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
FME and workspace-specific parameters may be used. | |
Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
FME Licensing Level
FME Professional edition and above
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for samples and information about this transformer on the FME Community.