WhiteStarLeaseBuilder

Categories

Integrations

Posts a query to a WhiteStar Legal2Map™ WebServices (WS3) server to obtain points or polygons matching a list of legal land descriptions.

A feature is emitted for each point or polygon returned from the query.

Parameters

Request Parameters

The list attribute on the input feature that provides the set of textual property descriptions which form the request query.

If the list attribute contains a single element, and that element is an integer, it will be assumed to be the transaction ID of a previous query. In this case, a request will be performed to retrieve the results of the query corresponding to the given transaction ID.

If Point is specified, the submitted query will result in a set of points representing corresponding well locations. If Polygon is specified, the query will result in a set of polygons representing the area described by the request.

Name of the attribute that contains the legal property description for the output feature.

Name of the attribute that contains a unique numeric identifier for the completed transaction.

Name of the attribute that contains any error messages for the completed transaction.

Connection Parameters

Number of times to resend the query if results are not returned after the time specified by Number of seconds to wait between tries.

Note: Queries involving deferred results are not currently supported, and may result in an error.

Time, in seconds, to wait before resending a query if results are not returned from the previous query.

The web service host name to send the query to. The query is sent to the web wervice host using basic authentication over an HTTPS connection.

Note: For access outside of your network using a proxy server, use the Network tools in FME Options. From the FME Workbench menu, select Tools > FME Options > Network. For more information, see "Network" in the FME Workbench Help.

HTTP Authentication Parameters

The username and password for authenticating the connection to the web service host.

Example

The query for well locations described by the queries "6 25S 21E 1 SE SE SE NW" and "6 10S 16W 2 C SE NE SW" is formed as follows:

  1. The input feature contains the attribute request{0} and request{1} with the values:

request{0} = "6 25S 21E 1 SE SE SE NW"

request{1} = "6 10S 16W 2 C SE NE SW"

  1. "Request Description Attribute" is set to "request{}"
  2. "Result Description Attribute" is set to "_description"
  3. "Transaction ID attribute" is set to "_trans_id"
  4. "Resulting Geometry Type" is set to "Point".
  5. Web service host, username, and password are entered for the target server.

Execution of this query results in the following two features:

==================================================

IFMEPoint (-95.052404999999993,37.900077000000003)

_description -> `6 25S 21E 1 SESESENW'

_trans_id -> `871'

fme_geometry -> `fme_point'

fme_type -> `fme_point'

==================================================

IFMEPoint (-99.076954999999998,39.209764999999997)

_description -> `6 10S 16W 2 CSENESW'

_trans_id -> `871'

fme_geometry -> `fme_point'

fme_type -> `fme_point'

==================================================

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.

Text Editor

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.

Arithmetic Editor

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.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

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:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

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 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 all results about the WhiteStarLeaseBuilder on the FME Community.