• All Files

WhiteStarLeaseBuilder

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

ClosedRequest Description Attribute

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.

ClosedResulting Geometry Type

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.

ClosedResult Description Attribute

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

ClosedResult Transaction ID Attribute

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

ClosedAttribute to hold ERROR feature message

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

Connection Parameters

ClosedNumber of times to retry deferred results

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.

ClosedNumber of seconds to wait between tries

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

ClosedWeb Service Host

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 Workbench menu, select Tools > FME Options > Network. For more information, see "Network" in the FME Workbench Help.

HTTP Authentication Parameters

ClosedHTTP Authentication Username, HTTP Authentication Password

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.

Transformer Categories

Integrations

Technical History

Associated FME function or factory: @Http

Search FME Community

Search for samples and information about this transformer on the FME Community.