For many customer environments Projects are an important part of every day use. It is therefore essential that people can easily find the project they need, both in daily use, and for salary calculations, integrations and via our API. This article details the various ways a project can be identified, and where.
Names are the most human friendly way to identify a project, and can be used when browsing the project hierarchy, or when searching for a project in the customer environment. The project name is visible in all areas of the platform.
A project code is a quick method of identifying a project, generally shorter than the name, and often unique. Especially useful in customer environments where many of the same type of project are used in different areas.
For example, a "Cleaning" project could easily appear under many city projects. With codes, each of these can easily be identified despite having the same name
- Helsinki > Cleaning, could have a code of "HEL/Clean"
- London > Cleaning, could have a code of "LON/Clean"
The project code can be used to search projects in customer environments, and to identify projects in integrations and the API. It is visible in the project information and project hierarchy views.
The external identifier works in a similar manner to the project code, but it is specifically intended for identifying projects integrated between Nepton and another system in the following situations:
- The external system's identifier is not know to the end users
- The external system's identifier is not friendly enough for end users
- The project code cannot be used to uniquely identify integrated projects
The external identifier is used via the API, and can be viewed from the project information page.
Please note that the external identifier has to be unique when it is set.