Manage Projects

A project is a container for the HERE platform resources you use to build an app, service, or other work product. It can contain resources such as catalogs, pipelines, schemas, and services. The project controls which users, apps, and groups can access the resources in the project. We recommend that you use projects to manage all your platform resources.

• Why use projects
• Create a project
• Manage access to a project
• Manage resources in a project
• Delete a project
• Project limits
• Projects and the CLI

Why use projects?

Some benefits of using projects include:

• Collaboration: Work only in the context of the resources that matter to your team, and help other teams by sharing useful resources with them in a controlled manner (bidirectional trust).
• Workflow management: Accommodate different access requirements for dev, test, and production environments.
• Access management: Control access to individual resources by assigning permissions to users, groups, or apps.
• Cost tracking: Track resource usage by project in the platform Usage report so you know how much an app or use case is costing.

Note

When you work with projects you will notice the project context is displayed in the portal. For example:

You may change the project context to another project, opt to view all projects or simply remove the project context filter altogether depending on what resources you’re interested in.

Create a project

To create a project, follow these steps:

1. Sign in to the HERE platform.
2. Open the Projects Manager from the launcher.
3. Click Create new project.
4. Enter a name for the project (project names don't have to be unique).
5. Enter a project ID. Project IDs must be unique with an org and cannot be changed for the lifetime of the org. Project IDs must be between 4 and 16 characters in length.
6. Enter an optional description.
7. Click Save.

After a new project has been created, you can find all your projects here. On this page, you can also find a newly created HRN identifier. A HERE Resource Name (HRN) is a unique identifier of catalog, schema and pipeline resources as well as of platform projects and apps. The HRN is generated automatically by the HERE platform when a resource, project and app is created and cannot be modified. You can use the HRN to specify the project scope for requests to the HERE platform (this is recommended to enable better usage tracking). For additional information, see Create a signature and Billing tags for projects.

You have admin rights to the project you created. You can grant admin rights to other users and apps.

Manage access to a project

Grant access to a project

1. Sign in to the HERE platform.
2. In the Projects Manager, click the project to which you want to give a user, group or an app access. Select the Access and permissions tab to view a list of users, groups and apps with access to the project.
3. Click Grant access.
4. Select if you want to search by existing groups or existing users and apps.
5. Enter the name in the search field to find the desired user, group or app by name.
6. Select the desired name and click Grant access. The name is now listed.
7. Alternatively, you can use the links on the Grant access to a project window to create new users, groups, or apps in the Access Manager. When creating an app this way, the default project for the app will automatically be set to the project you were working in and optionally set to only allow access in the default project.

Remove access to a project

1. Sign in to the HERE platform.
2. In the Projects Manager, click the project from which you want to remove access for a user, group or an app. Select the Access and permissions tab to view a list of users, groups and apps with access to the project.
3. Click the three dots menu to remove the user, group or app access to the project. A Remove from project button appears.
4. On the popup dialog, click Remove to confirm.

Set a default project for an app

App managers can specify a default project for the app during or after the creation of the app. This means that requests from this app will be scoped to the specified project by default, allowing you to track usage by this app on a project level.

When creating an app from a project in the Projects Manager, the system will automatically set the default project to the project you are working in. When creating an app from the Access Manager, you can optionally select a project in the "DEFAULT ACCESS TO A PROJECT" field.

To set the default project for the app after it's been created, go to the app details page in the Access Manager, select the Edit app menu option, and select a project in the "DEFAULT ACCESS TO A PROJECT" field. Select the "None" option if you have multiple apps.

You can also set the app to only request resources in the scope of the default project by selecting the "Allow access in only default project" checkbox during or after app creation. This setting is recommended for apps using API keys because it helps secure the use of your API keys. It also allows you to track usage by project for an app using an API key.

If you need to use an app across multiple projects, for example to orchestrate CI/CD processes, we recommend you use OAuth tokens and set the project scope as needed when requesting the token.

Grant or revoke project admin permissions

Only org and project admins can change a user's project permissions. Org admins can change user permissions on any project. Project admins can change user permissions only on those projects for which they have admin permissions.

1. Sign in to the HERE platform.
2. Click on the Access and Permissions tab of your project to view a list of users, apps and groups with access to the project.
3. Click the three dots menu to change project admin permissions for a user or an app. A Make project admin button appears if the user or app is not already an admin. A Revoke project admin button appears if the user or app is an admin. Clicking the appropriate button will immediately change the project admin permissions for the user or app.

Manage resources in a project

From within a platform project you can create, delete, link, and share resources in a controlled manner. This is the recommended way to manage access to resources. The following sections provide instructions on how to manage project resources by resource type.

Catalogs

Add a catalog to a project

There are multiple ways to add a catalog to a project. You can create a new catalog in a project, link to an existing HERE catalog from a project, or link to a catalog that's been created in another project in your org and made available to link, designated as "shared," to your project.

1. Sign in to the HERE platform.
2. In the Projects Manager, click the project to which you want to add a catalog and select the Resources tab.
3. Click Add catalog and choose one of the following options:
   • Link a catalog: Choose this option to add an existing catalog to the project. You are presented with a list of catalogs provided by HERE, as well as catalogs from other project(s) within your organization. Click the Link button for the desired catalog. If a choice is available, select the permissions for the catalog, for example "read" and "write". The catalog will appear in your list of project catalogs with a link icon next to the catalog name and the linked permissions.
   • Create a new catalog: Choose this option to create a new catalog and add it to the project. For more information on creating catalogs, see the Data API. Ensure that you leave the Create catalog in a project option selected and validate the Home Project field matches the name of the project you want the catalog to be created in. When you are done, click Save.

Remove a catalog from a project

1. Sign in to the HERE platform.
2. In the Projects Manager, click the project from which you want to remove a catalog and select the Resources tab.
3. Click on the three dots and select Unlink.

Share a catalog

Sharing a catalog makes it available to link to other projects in your organization. You may choose to make the catalog available to all or specified projects within your organization with permissions that you set ("read" and/or "write").

1. Sign in to the HERE platform
2. In the Projects Manager, click the project that contains the catalog you want to share with one or more projects in your organization.
3. Click the three dots next to the catalog you would like to share and select Set catalog availability.
4. Specify the project to which you want to share the catalog or choose Make available to all projects in your organization.
5. Specify the permissions to the catalog you want to share: read and/or write.
6. Click Set.

The steps above describe this functionality in the context of Projects Manager. This functionality is also accessible to users with manage access to a catalog from the catalog detail page in the Data section of the portal. In addition, users with manage access to a catalog can unlink that catalog from a project from the Availability tab of the catalog detail page in the Data section of the portal. The steps for all of these actions are described in the Data User Guide.

Disable sharing for a catalog

To make a catalog unavailable to link to projects, follow these steps:

1. Sign in to the HERE platform
2. In the Projects Manager, click the project that contains the catalog you want to modify.
3. Click the three dots next to the catalog and select Set catalog availability.
4. De-select Make available to all projects in your organization.
5. Click Set.

Change permissions to a shared catalog

To change the available permissions to a catalog after you have shared it, follow these steps:

1. Sign in to the HERE platform
2. In the Projects Manager, click the project that contains the catalog you want to modify.
3. Click the three dots next to the catalog and select Set catalog availability.
4. Change the permissions by selecting the desired checkboxes.
5. Click Set.

Note

Changing a catalog's permissions in a project will not change the permissions to the catalog for any project that has already linked to the catalog.

Schemas

Add a schema to a project

There are multiple ways to add a schema to a project. You can create a new schema in a project, link to an existing HERE schema from a project, or link to a schema that's been created in another project in your org and made available to link, designated as "shared," to your project. Linking schemas, whether user or HERE created, is currently only supported via the CLI.

To create a new schema in a project, you must associate the schema with the project when you create the schema's Maven project using the HERE Data SDK for Java and Scala. To associate the schema with a project, specify the project's HERE resource number (HRN) in the here.token.scope property in your local ~/.here/credentials.properties file before you deploy the Maven project. Then, when you deploy the Maven project containing the schema, the schema deployment plugins will create the schema in the specified HERE platform project. For more information, see Create and Extend Schemas.

After you deploy the schema, it is listed in the project on the Resources tab, in the Schemas section.

To link a schema that's been shared to a project, see the CLI documentation here.

Share a schema (CLI-only functionality)

Sharing a schema makes it available to link to other projects in your organization. You may choose to make the schema available to all or specified projects within your organization with "read" permissions. For more information, see the CLI documentation here.

Once you share a schema, an app in the project to which it has been shared can link to the schema. For more information, see the CLI documentation here.

Pipelines

Add a pipeline to a project

To add a pipeline to a project, you must create the pipeline in a project. You cannot link an existing pipeline to a project.

To create a new pipeline and add it to a project, follow these steps:

1. Sign in to the HERE platform.
2. In the Projects Manager, click the project to which you want to add a pipeline.
3. On the Resources tab, click Pipelines.
4. Click Create new pipeline.
5. Complete all of the required fields. Ensure that you leave the Create pipeline in a project option selected and validate the Home Project field matches the name of the project you want the pipeline to be created in. For more information, see Using the Web Portal for Pipelines in the Pipeline Developer Guide.
6. Click Save Version.

Services

Add a service to a project

To add a HERE service, such as HERE Routing or HERE Search - Forward Geocoder, link it to your project by following these steps:

1. Sign in to the HERE platform
2. In the Projects Manager, click the project to which you want to add a service.
3. On the Resources tab, click Services.
4. Click Link a service.
5. Click the Link button for HERE service you want to add to the project. The selected service will now show up in the Services list in the Resources tab.

Remove a service from a project

To remove a HERE service, such as HERE Routing or HERE Search - Forward Geocoder, from a project, follow these steps:

1. Sign in to the HERE platform
2. In the Projects Manager, click the project you want.
3. On the Resources tab, click Services.
4. Click the three dots to the right of the service you want to remove and select Unlink.

Delete a project

To delete a project, you first must delete any resources created in the project. Deleting resources in a project could have an impact on all the users, apps, and groups that are members of the project, as well as members of other projects that have linked to resources in your project, so please proceed with caution. Once you've deleted the project resources, delete your project by following these steps:

1. Sign in to the HERE platform
2. In the Projects Manager, click the project you want.
3. Click the More button, then select Delete project.

Notes

To delete a project, verify that your role is either ProjectAdmin or OrgAdmin. Other roles do not have permission to delete a project.

Once you delete a project, the Project ID of the deleted project cannot be reused for a new project.

Project limits

Projects and the CLI

The information in this section describes how to use projects in the platform portal. You can also use the CLI to work with projects. For more information, see Project Workflows in the Command Line Interface User Guide.