JSONExtractor
Extracts portions of JSON (JavaScript Object Notation) formatted text into feature attributes.
Parameters
Source
Allows for selecting between one of two options for JSON input: JSON Document or File/URL
If selected, The JSON document can come from any string expression, including attribute values and workspace parameters.
If selected, the JSON source can be read from a local file at a specified file path, or from the internet at a specified URL.
Extract Queries
This parameter identifies the feature attribute into which the result of the JSON query should be put.
This parameter is the JSON query whose value will be stored in the target attribute.
Each cell in the JSON Query column contains a button that opens a dialog containing the structure of the JSON dataset in a tree form. If the JSONExtractor is set to read from a file or URL, then selecting a value from the tree will populate the parameter with the appropriate query string to turn the selected values into features.
A JSON query is primarily used to refer to values in some JSON text. They can also be used to extract some metadata about the JSON text, such as the type (object, array, string, etc.) of JSON value or the number of elements in an array. The outermost JSON value, which must be an object or an array, is always referred to by the term "json". Contained values can be referred to using JavaScript-like square bracket index operators.
A value in an array can be referred to using its zero-based position in the array (for example, json[2] for the third element).
A value in an object can be referred to using its object key name
json["key"]
All of the values in an array or object can be collectively referred to using a wildcard index
json[*]
The query used by this transformer can have multiple expressions, which are separated by a '+' operator, as well as string literal values. This allows more complex attribute values to be easily created from the JSON text. For example:
json["name"]["first"] + " " + json["name"]["last"]
The JSONFragmenter transformer contains more information on JSON queries.
If the JSON query cannot be fully evaluated, a message will be logged, and the feature will be output without setting the target attribute.
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.