Find Places by Address Node in Pathways

From FojiSoft Docs
Revision as of 23:32, 5 March 2025 by Mitchell.Hirsche (talk | contribs) (Find Places by address)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Overview

The Find Places by Address node in Foji Pathways is used to look up information about a place or multiple places based on a given address. This is particularly useful for workflows that involve location-based queries, such as verifying business addresses, retrieving geographical data, or integrating mapping services.


Node Properties

1. Name

  • Description: A unique identifier for the node operation.
  • Usage: Assign a clear, descriptive name that reflects the purpose of the query (e.g., "Find Nearby Clinics" or "Retrieve Business Location").

2. Address

  • Description: Defines the input address used to search for places.
  • Options for Expression Type:
    1. JavaScript Statement: A direct JavaScript expression for defining the address.
    2. JavaScript Function: A function for generating the address dynamically.
    3. Handlebars Template: A dynamic template to inject real-time address values.
  • Example Expressions:
    • JavaScript Statement: "1600 Amphitheatre Parkway, Mountain View, CA"
    • JavaScript Function: function getAddress() {   return "1600 Amphitheatre Parkway, Mountain View, CA"; }
    • Handlebars Template: user_input_address
  • Status: Required (A valid address must be provided for the query to execute).

3. Result Type

  • Description: Determines whether the search should return a single place or multiple places.
  • Options:
    • Single Place: Returns the best match for the given address.
    • Multiple Places (Array): Returns a list of all matching places for the given address.
  • Example Use Cases:
    • Single Place: Used when searching for a specific business or landmark.
    • Multiple Places (Array): Used when looking for all businesses in a given area.

4. Variable Name

  • Description: The name of the output variable where the retrieved place(s) data will be stored.
  • Status: Required (Must be defined for further use in the workflow).
  • Usage: Choose a meaningful variable name (e.g., business_location, nearby_places).

How It Works

  1. Define the Address: Specify an address manually, through JavaScript, or via Handlebars Template.
  2. Choose the Result Type: Decide whether to return a single place or multiple places.
  3. Store Output in a Variable: The retrieved place data is saved under the specified variable name.

Example Use Cases

1. Finding a Specific Business Location

  • Address: "1 Infinite Loop, Cupertino, CA"
  • Result Type: Single Place
  • Variable Name: apple_hq
  • Outcome: Retrieves the location details of Apple Headquarters.

2. Listing Nearby Restaurants

  • Address: "Times Square, New York, NY"
  • Result Type: Multiple Places (Array)
  • Variable Name: restaurants_list
  • Outcome: Retrieves a list of restaurants in the Times Square area.

Best Practices

  • Use Dynamic Address Inputs: Utilize Handlebars Templates to fetch user-provided addresses.
  • Choose the Right Result Type: Select Single Place for exact location queries, and Multiple Places for broader searches.
  • Store Data in a Well-Named Variable: Helps in maintaining workflow clarity and ease of debugging.

The Find Places by Address node is essential for workflows that require location-based data retrieval, enhancing automation for location-aware applications.