All new HERE platform users should go through the Getting Started document.
To get started using pipelines, you need to be able to use the HERE platform. This means that you need to be able to use the HERE platform software and libraries. To develop new applications using the HERE platform requires a few more tools. The following things are required:
- You must have an account. Typically this involves requesting an account from your company's Admin.
- Set up your teams and permissions.
- Review the HERE platform documentation to get familiar with the design and use of the HERE platform.
- Explore the platform portal - After you log in, you will be directed to the platform portal. Explore the platform portal and become familiar with its features.
- Manage your profile - Click on your Name in the top right of the platform portal screen to access your profile. Here you can find your User-ID and the Groups that you belong to.
The HERE platform is a cloud-based platform providing several microservices and resources. Each microservice and each resource (data catalog, pipelines, schemas, etc.) are protected and require authentication and authorization to be used. Within the HERE platform, you will need credentials to access these services. Learn how to set up your teams and credentials in the Teams and Permissions User Guide.
Follow these steps:
- Get your credentials set up as mentioned above or refer to Get your Credentials.
- Configure Your Environment.
If you need information about working with pipelines through the Web Portal, see Using the Web Portal for Pipelines for more information.
There are three main tasks involved in using HERE platform pipelines.
- Designing and implementing a data processing pipeline as a JAR file.
- Deploying the pipeline JAR file to the HERE platform pipeline.
- Running and managing jobs on a Pipeline Version on the pipeline.
The first task is the most technically ambitious. It involves designing a data processing workflow and implementing it inside of a pipeline JAR file. See the Working with Pipelines article for more information.
The second and third tasks can both be accomplished in three possible ways.
You can use the platform portal and its GUI. For more details, see Using the platform portal UI for Pipelines.
You can use the CLI. For more details, see the Command Line Interface Developer Guide.
- You can use your own custom application to interact directly with the Pipeline Service REST API. For more details, see the Pipeline API Reference.
- What it means to Deploy a Pipeline
- To Deploy a Pipeline via the platform portal, see the Pipeline User Guide.
- To Deploy a Pipeline via the CLI, see Deployment and the OLP CLI User Guide.
- To Deploy a Pipeline via the API, see Deployment by API.
- To Configure a Pipeline, see Interfacing with the Pipeline Process.
For Pipeline Monitoring information, see the Metrics and Logs User Guide.
For information about Pipeline Logging Levels, see Pipeline Logging.
- To use Grafana for alerts, see Pipeline Monitoring.
- Running a Pipeline
- Constructing a HERE platform Request
- Using the Command Line Interface (CLI)
- Using the platform portal UI for Pipelines
- For how to upgrade a Running Pipeline, see the Pipeline Lifecycle or Upgrading a Pipeline by Portal
- To run a Sample Pipeline, follow the instructions for SDK for Java & Scala Developers
- Developing Pipelines: An Overview
- Maven Archetypes
- For instruction on building a New Pipeline Project, visit SDK for Java & Scala Developers-
See any of these documents:
- Data Processing Library Developer Guide
- Data Visualization Library Developer Guide
- Location Libraries Developer Guide
- Data Client Library Developer Guide
- Data Validation Library Developer Guide
- Data Developer Guide
- Data User Guide