This topic describes how to change the display name for a project used by client applications.
By default, the directory name of each project is displayed in client applications as the project name. Sometimes you may want to override this default name with a more descriptive name. There are two ways to override the project name:
- Define an alternative name in the project file using the
displayNameelement – this provides an alternative name that will be used in all dashboards that include the project.
- Override the project name in a specific dashboard using a
@projectLayoutdirective in the dashboard Configuration file – this provides an alternative name that will be used only in the dashboard edited.
It is recommended that you choose one of these approaches rather than trying to use both for the same project.
Define an alternative name in the project file
This is the easiest method for changing the name of a project on a global basis. It ensures that the project is displayed with the new name in all dashboards that do not explicitly rename the project.
You can edit the project file using your preferred text editor.
When dashboards that include this project are rebuilt, the project will be displayed with the new name of
Overriding the display name in a dashboard
This method allows you to override the name of a project in a specific dashboard.
You can edit the dashboard
Configuration file using your preferred text editor.
When this dashboard is rebuilt, the project will be displayed with the new name of
"Application One". In all other dashboards, the default name of
"AppOne" will still be displayed.