Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Big data, Analytics, DevOps
QNAS
Overview
The QNAS Connector enables seamless integration with Qatar’s National Address system, providing access to accurate location data for zones, streets, and buildings. This connector supports functionalities such as retrieving zone lists, street details, building information, and geolocation coordinates.
Integration Overview
This document provides a comprehensive guide for each integration point, detailing its purpose, configuration, and workflow support using the QNAS custom connector.
Supported Integration Points
- Zone List Integration: Retrieves a list of all zones in Qatar.
- Zone Polygon Integration: Fetches polygon boundary coordinates for a specific zone.
- Street List Integration: Retrieves a list of streets within a specific zone.
- Street Polygon Integration: Fetches polygon boundary coordinates for a specific street.
- Building List Integration: Retrieves a list of buildings on a specific street.
- Geolocation Integration: Provides geolocation coordinates for a specific building.
Detailed Integration Documentation
Zone List Integration
Purpose
Retrieves a list of all zones in Qatar, serving as the entry point for location data queries.
Input Details
Required Fields: None, as this integration fetches all available zones.
Configuration
Ensure the connector is configured to access the QNAS system securely.
Output
- Successful: Returns a list of zone names or identifiers.
- Failure: Indicates connectivity issues or configuration errors.
Workflow Example:
1. Configure the connector to access the QNAS system.
2. Use the Zone List integration point to retrieve the list of zones.
3. Store the zone list for subsequent integrations.
Zone Polygon Integration
Purpose
Fetches polygon boundary coordinates for a specific zone, useful for mapping applications.
Input Details
Required Fields:
- Zone Name or Identifier (e.g., “Zone1”).
Configuration
Ensure the zone name matches the format returned by the Zone List integration.
Output
- Successful: Returns polygon coordinates for the specified zone.
- Failure: Indicates invalid zone name or missing parameters.
Workflow Example:
1. Retrieve the list of zones using the Zone List integration point.
2. Select a specific zone and use the Zone Polygon integration to fetch its coordinates.
3. Use the coordinates for mapping or visualization purposes.
Street List Integration
Purpose
Retrieves a list of streets within a specific zone, enabling further location data queries.
Input Details
Required Fields:
- Zone Name or Identifier (e.g., “Zone1”).
Configuration
Verify that the zone name is valid and obtained from the Zone List integration.
Output
- Successful: Returns a list of street names or identifiers.
- Failure: Indicates invalid zone or connectivity issues.
Workflow Example
1. Use the Zone List integration to select a zone.
2. Use the Street List integration to retrieve the list of streets in that zone.
3. Store the street list for further queries.
Building List Integration
Purpose
Retrieves a list of buildings on a specific street within a zone, facilitating address-specific queries.
Input Details
Required Fields:
- Zone Name or Identifier.
- Street Name or Identifier.
Configuration
Confirm that zone and street names are accurate and sourced from prior integrations.
Output
- Successful: Returns a list of building names or identifiers.
- Failure: Indicates invalid zone or street parameters.
Workflow Example
1. Navigate through zones and streets using the Zone List and Street List integrations.
2. Use the Building List integration to retrieve buildings on the selected street.
3. Store the building list for further use.
Geolocation Integration
Purpose
Provides geolocation coordinates (latitude and longitude) for a specific building, essential for location-based services.
Input Details
Required Fields:
- Zone Name or Identifier.
- Street Name or Identifier.
- Building Name or Identifier (e.g., “BuildingX”).
Configuration
Ensure all parameters are valid and obtained from prior integration points.
Output
- Successful: Returns latitude and longitude coordinates for the specified building.
- Failure: Indicates invalid zone, street, or building parameters.
Workflow Example
1. Use the Zone List, Street List, and Building List integrations to identify a specific building.
2. Use the Geolocation integration to fetch the building’s coordinates.
3. Apply the coordinates in location-based applications.
Workflow Creation with the Connector
Example Workflow: Retrieving Geolocation of a Building
Prepare Query
Configure the connector to access the QNAS system.
Retrieve Zone List:
- Use the Zone List integration point to fetch all zones.
- Select a specific zone (e.g., “Zone1”).
Retrieve Street List
- Use the Street List integration point to fetch streets in the selected zone.
- Choose a specific street (e.g., “StreetA”).
Retrieve Building List
- Use the Building List integration point to fetch buildings on the selected street.
- Select a specific building (e.g., “BuildingX”).
Fetch Geolocation
- Use the Geolocation integration point to retrieve the building’s coordinates.
- Store the latitude and longitude for application use.
Monitor Integration
Use monitoring tools (e.g., Google Cloud Monitoring or Logging) to track integration activities and resolve any errors promptly.
Additional Notes
- Each integration requires proper configuration to ensure secure communication with the QNAS system.
- Verify that all input parameters (zone, street, building names) match the exact format returned by prior integrations to avoid errors.
- Use cloud-based tools like Google Cloud Run, Functions, or Storage to automate and scale integration workflows effectively.
- Implement caching mechanisms to manage rate limits and optimize performance.
Pricing
iSolution logo - white - transparent 250 px