Change the Display Name, Description, or Explanation of a Visier Object

Learn how to add or modify an object's display name, description, or explanation.

Overview

Objects in Visier contain basic information that identifies and describes the object, including its display name, description, and explanation. Administrators may add or modify an object's basic information in Studio. In this article, you will learn:

  • What an object's Basic Information contains.
  • Why you might add a description or explanation to an object.
  • Where descriptions and explanations are visible to end users in Visier.
  • How to change an object's basic information.
  • How to add basic information in other languages.

Caution: If you change the display name, short display name, description, or explanation, and then Visier changes one of those fields, you will not receive the Blueprint update. This includes changing a field in one locale and then Visier changing the same field in a different locale. For more information, see Granular Blueprint Inheritance.

Basic Information

In Studio, each object contains a Basic Information tab. The Basic Information tab contains the object's metadata. The metadata in the Basic Information tab describes the object. Some objects contain different metadata options, but you will generally see the following fields in Basic Information.

Field Description Customizable?
Object name The unique identifier associated with the object. This is assigned after the object is first created. No
Locale The language in which the object is authored. You can author objects in any of Visier's supported languages. For more information, see Supported Languages. Yes
Display name The user-friendly name for the object. If the object is visible in the solution experience, this is the display name that your end users see. This field is required. We recommend that display names do not exceed 50 characters to avoid truncation in the solution experience. Yes
Short display name A shortened version of the display name. If the object is visible in the solution experience, this name is displayed in visualization titles. This field is optional. Yes
Description A short description of the object. Descriptions provide in-context help for your users while working in Visier. If a description is present, it is displayed to end users who hover over the Help button . For more information, see Help content. This field is optional. Yes
Explanation A longer description of the object that typically includes a definition, calculation details, and other guidance about how to use the object. Explanations provide detailed in-context help, such as long-form content and images, for your users while working in Visier. If an explanation is present, it is displayed to end users who hover over the Help button and click More info. For more information, see Help content. This field is optional. Yes
Designer notes An admin-only description of the object. This field is optional and not visible to end users. Yes
Visible in Analytics Whether or not the object is visible to end users in the solution experience. If enabled, users can search for and find the object in the solution experience. Yes
Tags The tags assigned to the object. For more information, see Create and Assign Tags to Content. Yes
Modules The modules that the object belongs to. Objects in Visier's Blueprint are often assigned to modules; for example, Organization Core or Visier Benchmark for Organization. If your organization is subscribed to a module, you have access to all objects that belong to the module. No

Change a display name

You can change an object's display name in a project.

  1. In a project, on the navigation bar, click Model.
  2. In Model, select the appropriate object type; for example, Analyses, Concepts, or Metrics.
  3. In the list, select the object you want to change; for example, in Analytic Objects, select Employee.
  4. Click Basic Information.
  5. Optional: To write content in a different language, in the Locale field, select or add a new locale. You can author in any Visier-supported language. For more information, see Supported Languages.
  6. In the Display name field, type a user-friendly display name. We recommend that display names do not exceed 50 characters to avoid truncation in the solution experience.
  7. To preview your changes, on the navigation bar, click Preview Solution.
  8. After reviewing your changes, publish your project to put the changes into production. For more information, see Publish Project Changes.

Add or change a description

You can change an object's description in a project. Because descriptions are visible when users hover over the Help button , we recommend that they do not exceed two sentences. However, there is no character limit and you can write a long description if necessary.

  1. In a project, on the navigation bar, click Model.
  2. In Model, select the appropriate object type; for example, Analyses, Concepts, or Metrics.
  3. In the list, select the object you want to change; for example, in Analytic Objects, select Employee.
  4. Click Basic Information.
  5. Optional: To write content in a different language, in the Locale field, select or add a new locale. You can author in any Visier-supported language. For more information, see Supported Languages.
  6. In the Description field, type a one or two-sentence description of the object.
  7. To preview your changes, on the navigation bar, click Preview Solution.
  8. Find the object in the solution experience and hover over the Help button . The description is visible in the dialog box.
  9. After reviewing your changes, publish your project to put the changes into production. For more information, see Publish Project Changes.

Add or change an explanation

You can change an object's explanation in a project.

  1. In a project, on the navigation bar, click Model.
  2. In Model, select the appropriate object type; for example, Analyses, Concepts, or Metrics.
  3. In the list, select the object you want to change; for example, in Analytic Objects, select Employee.
  4. Click Basic Information.
  5. Optional: To write content in a different language, in the Locale field, select or add a new locale. You can author in any Visier-supported language. For more information, see Supported Languages.
  6. Click the Explanation field to open the Explanation editor.
  7. In the Explanation editor, add your explanation content.
  8. To preview your changes, on the navigation bar, click Preview Solution.
  9. Find the object in the solution experience and hover over the Help button and then click More info. The explanation is visible in the dialog box.
  10. After reviewing your changes, publish your project to put the changes into production. For more information, see Publish Project Changes.

Note: Images in explanations

  • Supported formats: JPEG, GIF, PNG, SVG.
  • Only users with the Translation additional capability can add SVG images to explanations.