Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Morocco Open Data Portal Connector
Overview
The Morocco Open Data Connector enables seamless integration with the Morocco Open Data Portal, providing access to catalog and dataset-related data for applications such as data analytics, visualization tools, or policy development. The connector acts as a proxy to streamline data retrieval, supporting actions for dataset enumeration, metadata queries, search operations, and activity tracking.
Integration Overview
This document outlines each integration point, its purpose, configuration, and workflow support using the Morocco Open Data Connector.
Supported Integration Action Points
- package_list: Retrieves a list of all datasets in the catalog.
- group_list: Lists all groups in the catalog.
- tag_list: Lists all tags in the catalog.
- package_show:Retrieves metadata for a specific dataset.
- group_show:Retrieves metadata for a specific group.
- tag_show: Retrieves metadata for a specific tag.
- package_search: Searches datasets based on a query.
- resource_search:Searches resources based on a query.
- recently_changed_packages_activity_list: Retrieves an activity stream of recently modified datasets.
Detailed Integration Documentation
Catalog Datasets Retrieval
Action
package_list
Purpose
Retrieves a comprehensive list of all dataset names in the catalog, serving as the primary entry point for exploring available data.
Parameters
- Required:None
- Optional:
- limit: Number of items to return (default: 1000).
- offset: Starting index for pagination (default: 0).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity to the Morocco Open Data Portal.
Output
- Successful:Returns a JSON object with success (boolean) and result (array of dataset names)
- Failure: Returns error details (e.g., API connectivity issues).
Workflow Example
1. Configure the connector for the Morocco Open Data Portal.
2. Execute the package_list action to fetch a list of datasets.
3. Process the response to identify datasets (e.g., health-statistics) for further actions.
Catalog Groups Listing
Action
group_list
Purpose
Lists all group names in the catalog, helping users identify thematic or organizational data categories.
Parameters
- Required:None
- Optional:
- all_fields: Include detailed fields (boolean, default: false).
- limit: Number of items to return (default: 1000).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful: Returns a JSON object with success (boolean) and result (array of group names or objects if all_fields=true).
- Failure: Returns error details (e.g., upstream API error).
Workflow Example
1. Execute the group_list action to retrieve available groups.
2. Review the response to select a group (e.g., education) for further queries.
3. Proceed to the group_show action for detailed group metadata.
Catalog Tags Listing
Action
tag_list
Purpose
Lists all tag names in the catalog, enabling users to explore datasets by keywords or topics.
Parameters
- Required:None
- Optional:
- query: Filter tags by partial match (e.g., “health”).
- all_fields: Include detailed fields (boolean, default: false).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful: Returns a JSON object with success (boolean) and result (array of tag names or objects if all_fields=true).
- Failure: Returns error details (e.g., invalid query).
Workflow Example
1. Execute the tag_list action to retrieve available tags.
2. Review the response to select a tag (e.g., agriculture) for dataset filtering.
3. Use the tag in the package_search action to find relevant datasets.
Dataset Metadata Retrieval
Action
package_show
Purpose
Retrieves detailed metadata for a specific dataset, including fields and resources to plan further data queries.
Parameters
- Required:id (dataset identifier, e.g., health-statistics).
- Optional:use_default_schema: Use default schema for metadata (boolean, default: false).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful:Returns a JSON object with success (boolean) and result (object containing dataset metadata, e.g., title, resources).
- Failure: Returns error details (e.g., invalid dataset ID)
Workflow Example
1. Use the package_list action to identify a dataset (e.g., health-statistics).
2. Execute the package_show action with the selected id.
3. Review metadata to plan resource queries or exports.
Group Metadata Retrieval
Action
group_show
Purpose
Retrieves detailed metadata for a specific group, providing insights into thematic data collections.
Parameters
- Required:id (group identifier, e.g., education).
- Optional:
- include_datasets: Include associated datasets (boolean, default: false).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful:Returns a JSON object with success (boolean) and result (object containing group metadata, e.g., name, description).
- Failure: Returns error details (e.g., invalid group ID).
Workflow Example
1. Use the group_list action to identify a group (e.g., education).
2. Execute the group_show action with the selected id.
2. Review group metadata to explore associated datasets.
Tag Metadata Retrieval
Action
tag_show
Purpose
Retrieves detailed metadata for a specific tag, aiding in dataset discovery by topic.
Parameters
- Required:id (tag identifier, e.g., agriculture).
- Optional:
- include_datasets: Include associated datasets (boolean, default: false).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful:Returns a JSON object with success (boolean) and result (object containing tag metadata, e.g., name, datasets).
- Failure: Returns error details (e.g., invalid tag ID).
Workflow Example
1. Use the tag_list action to identify a tag (e.g., agriculture).
2. Execute the tag_show action with the selected id.
3. Use tag metadata to find related datasets via package_search.
Dataset Search
Action
package_search
Purpose
Queries datasets based on a search term, allowing users to discover relevant data for analysis or visualization.
Parameters
- Required:None
- Optional:
- q: Search query (e.g., “health statistics”).
- fq: Filter query (e.g., tags:health).
- sort: Sort results (e.g., score desc, metadata_modified desc).
- rows: Number of results (default: 10, max: 1000).
- start: Starting index (default: 0).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful: Returns a JSON object with success (boolean) and result (object containing count, results array of datasets).
- Failure:Returns error details (e.g., invalid query).
Workflow Example
1. Execute the package_search action with q=health statistics.
2. Process the response to identify relevant datasets.
3. Use package_show to retrieve detailed metadata for selected datasets.
Resource Search
Action
resource_search
Purpose
Queries resources across datasets based on a search term, enabling access to specific files or data entries.
Parameters
- Required:query (e.g., name:Health Data).
- Optional:
- fields: Specify fields to search (e.g., name, description).
- limit: Number of results (default: 100).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful: Returns a JSON object with success (boolean) and result (object containing count, results array of resources).
- Failure: Returns error details (e.g., invalid query).
Workflow Example
1. Execute the resource_search action with query=name:Health Data.
2. Review the response to identify relevant resources.
3. Download resource files or use package_show for dataset context.
Dataset Activity Stream
Action
recently_changed_packages_activity_list
Purpose
Retrieves an activity stream of recently modified datasets, aiding in monitoring updates for timely data access.
Parameters
- Required:None
- Optional:
- limit: Number of activities to return (default: 31).
offset: Starting index for pagination (default: 0).
- limit: Number of activities to return (default: 31).
Configuration
Ensure the connector is configured with appropriate environment variables for authentication and connectivity.
Output
- Successful: Returns a JSON object with success (boolean) and result (array of activity objects, e.g., dataset updates).
- Failure:Returns error details (e.g., API connectivity issues).
Workflow Example
1. Execute the recently_changed_packages_activity_list action to fetch recent dataset changes.
2. Review activity details to identify updated datasets.
3. Use package_show to explore modified datasets.
Workflow Creation with the Connector
Example Workflow: Exploring and Analyzing Health Statistics
Retrieve Catalog Datasets
- Use the package_list action to fetch a list of available datasets.
- Identify the target dataset (e.g., health-statistics).
Refine Dataset Exploration
- Execute the package_search action with q=health to filter datasets.
- Review results to confirm the target dataset.
Query Dataset Metadata
- Use the package_show action with id=health-statistics to fetch metadata.
- Identify resources (e.g., CSV files) for analysis.
Search Resources
- Execute the resource_search action with query=name:Health Data to find specific resources.
- Download relevant resource files for processing.
Monitor Dataset Updates
- Use the recently_changed_packages_activity_list action to track updates to health-statistics.
- Trigger automated workflows (e.g., in Google Cloud Functions) for new data.
Explore Groups and Tags
- Execute group_list and tag_list to identify related groups (e.g., health) or tags (e.g., statistics).
- Use group_show or tag_show to explore associated datasets.
Pricing
iSolution logo - white - transparent 250 px