Concept: Level, Dimension, and Attribute Codes for Display Names

Adaptive Planning

Workday Adaptive Planning Documentation
Modeling
Managing the Model
Level, Dimension, and Attribute Codes for Display Names

Last Updated: 2023-06-23

Enabling display names in Workday Adaptive Planning allows using the same label for multiple levels, custom dimension values, or attribute values. This capability:

Simplifies loading structures from Workday Financials, Workday Human Capital Management, or other external systems.

Removes the need for concatenating labels and Reference IDs from Workday or other imports to make labels unique in Adaptive Planning.

Provides a simplified metadata loading process when labels match.

Enabling Display Names

Each level, custom dimension value, and attribute value receives a unique code.

The code functions as a key.

For formulas that included level, dimension value, or attribute value,

code

replaces

name

to prevent ambiguity. Your integration loaders will work as-is and automatically use code for column mappings.

Enabling display names resets anomaly detection thresholds to 40%.

Metadata Codes

Names within a level, custom dimension, or attribute required uniqueness before the introduction of display names.

For a pre-existing instance, we automatically generate codes for you by reusing the names you already created.

Codes always display in Workday Adaptive Planning within brackets, making them easy to identify. Example: [westeu01].

Display Name and Display Name Format

Display names introduce the read-only

Display Name

field for levels, dimension values, and attribute values. The display name functions as the label users see for metadata elements (previously the name field) throughout Workday Adaptive Planning. Anywhere someone picks, selects, or views a metadata element, the display name displays.

For pre-existing Workday Adaptive Planing instances,

Name

automatically populates as the display name format. You can select any of these display name formats in the level, dimension, and attribute admin pages:

Name

Code

Name [Code]

[Code] Name

You can configure the Display Name Format at the dimension root, for each dimension. The code displays for each value.

Display Name and Code can each contain 2048 characters, or 4096 characters when combined.

Any changes to the components of a display name could alter the sort order of elements in the Dimension Admin or Attribute Admin when

Keep Sorted

is enabled.

Display Names in Structure Imports

Importing structures of levels, custom dimensions, and attributes support code by requiring Display Name Format, Value Code, and Value Name columns in import templates. The Name column gets replaced by Value Code and Value Name columns.

Always download new import templates and follow the instructions on the first sheet. The introduction of display names changes the required columns and column names in templates. Don't reuse old templates or templates from instances that without display names.

Don't use imports to change names or codes of levels. You must make these changes manually in the application.

For hierarchies, you indicate parent values by referencing the parent Code.

Structure imports require these columns to support display names:

Level Import

Level Display Name Format

Level Code

Attribute Value Code

Attribute Value Name

Dimension Import

Dimension Display Name Format

Dimension Value Code

Dimension Value Name

Attribute Value Code

Attribute Value Name

Attribute Import

Attribute Display Name Format

Attribute Value Code

Attribute Value Name

Account Import

Attribute Value Code

Attribute Value Name

Printable views of levels, dimensions, and attributes all contain columns for Display Name, Value Code, and Value Name.

Display Name Elements in Integration

The introduction of metadata codes in Workday Adaptive Planning integrations assist with:

Mapping, by helping users make associations between external metadata elements and the elements internal to Workday Adaptive Planning.

Displaying information, by helping integration users differentiate between duplicate labels.

Searching, by helping users find specific elements based on metadata code.

Mapping, displaying, and searching take place during the creation and maintenance of data sources, data loaders, and metadata loaders.

Display Name Elements in the Planning Data Source

When you create shared parameters in a Planning data source, you can:

See the display name and code for levels, dimension values, and attribute values.

Search shared parameters by either display name or code.

Include Codes for Managed Sources

With the introduction of display names for an existing instance, you can click

Manage Sources

, and select

Include Codes

for these sources which can contain or filter by levels, dimensions, and attributes:

Custom.

Cube Sheet.

Model Sheet.

Once you select

Include Codes

, you can't disable it.

New managed sources you create after the introduction of display names automatically select

Include Codes

by default.

Display Name Elements in Integration Loaders

With the introduction of display names, the dimension, attribute, and level loaders automatically map to Code for Column Mappings. When you need to automap columns, you can select to automap by code or name.

Planning Data Loader Column Mapping

When you submit data, it loads by code instead of name. When you map columns with the

Column Mapping

tab, map the Source Id Column to Code. Map the Source Display Name column to Name.

Planning Data Loader Data Mapping

When you click the

Data Mapping

tab, you can automap all or selected columns by:

Source ID column.

Source display name column.

When you download mappings from the

Data Mapping

tab, the template uses code in the Source Id column. When you upload mappings, the template expects code in the Source Id column.

Planning Data Loader Data Source Settings

The Data Source Settings tab for the Planning Data Loader contains an automapping section. This section lets you optionally automap any new accounts, levels, or dimension values automatically, at loader runtime. Automap Levels and Automap Dimensions support code with options to:

Automap Source ID to Code.

Automap Source Display Name to Code.

Display Name Elements in APIs

With the introduction of display names, your APIs can support metadata

code

if:

You use API v30 or higher in your call.

You include the

displayNameEnabled=1

parameter in the

dimensions

element,

attributes

element, and

levels

element.

Including

displayNameEnabled=0

for an element disables display names for that element, preventing the use of

code

and uses

name

instead.

These bulk APIs support

code

when you enable display names, but all use ID as a key:

updateAttributes

updateDimensions

updateLevels

importDimensionMapping

These data APIs support

code

with the introduction of display names:

eraseData

exportConfigurableModelData

exportData

importConfigurableModeleData

importStandardData

importCubeData

importTransactions

For more details on the use of display name elements in requests and responses, see each API documentation page.

Bulk Metadata API Attribute Tagging in API v32 and v33

These bulk APIs support

valueCode

and

valueName

for API v32 and API v33 with the introduction of display names and use

displayNameEnabled=1

updateLevels

supports

valueCode

and

valueName

in the

dimension

and

attribute

elements.

updateAccounts

supports

valueCode

and

valueName

in the

attribute

element.

updateDimensions

supports

valueCode

and

valueName

in the

attribute

element.

exportLevels

supports

valueCode

and

valueName

in the

dimension

and

attribute

elements.

exportAccounts

supports

valueCode

and

valueName

in the

attribute

element.

exportDimensions

supports

valueCode

and

valueName

in the

attribute

element.

Once you enable display names and use API v32 or API v33, those APIs no longer support

name

in the attribute element.

Single Metadata APIs

These single metadata APIs don't support display names:

updateDimension

updateDimensionValue

updateLevel

createDimension

createDimensionValue

createLevel

Display Name Elements in Formulas

With the introduction of display names, you must use code when referencing a level, custom dimension value, or attribute value in a formula. Anywhere in the formula assistant you previously saw name, display name appears.

The formula assistant element picker generates search results based on both display name and code. Only the code of an element becomes part of the formula.

Display Name Elements and Formula Dot Notation for Properties

The introduction of display names triggers the use of

code

in formula dot notation for properties. When you construct formulas using dot notation for properties, you can reference levels, custom dimension values, and attribute values by

code

For dot notation, you must manually change any existing

.name

references to

.code

with the introduction of display names.

You can't use display name in dot notation because it can't ensure uniqueness during calculation.

If you change the display name format after using formulas for custom calculations in reports, revisit those formulas to ensure correctness.

Display Name Elements in Sheets

With the introduction of display names, you have 2 options to download modeled sheet data:

Download
: Exports the codes for levels, dimension values, and attribute values on the sheet. Use this option if you plan to import the data back into the modeled sheet.

Printable View
: Exports the configured display name of levels, dimension values, and attribute values. Use this option if you want the spreadsheet to match your current

Display Options

. You can't import this version of the spreadsheet.

To select 1 of these options:

When you open modeled sheets from the Sheets Overview, click the arrow next to the

Download

button.

When you open modeled sheets from a dashboard, click the

icon.

For standard and cube sheets, the

Download

option continues to export the display names of levels, dimension values, and attribute values. It also continues to match the

Display Options

you defined in the sheet.

Display Name Elements in Reports

Report builders present metadata elements by display name using your selected display name format in:

Matrix Reports.

Model Reports.

When you view reports, elements load using their display name. When you build reports by dragging elements into a builder, only the display name appears.

The matrix report formula assistant displays elements in the picker by display name. Formulas in custom calculations always use the code for elements that you select.

Model report filters use display name.

Display Name Elements in Linked-Level Refreshes

With the introduction of display names for parent and child instances in a multi-instance environment, linked-level refreshes replace names with display names.

Display Names in OfficeConnect

For all OfficeConnect report elements, we provide the Display Name label type value in label definitions. This label type value supports duplicate metadata names in Adaptive Planning.

Import Templates

Import template formats and instructions within

Integration

Import Data

indicate the need for codes as unique identifiers in imports for:

Standard Data Import

Modeled Sheet Data Import

Cube Sheet Data Import

Transaction Data Import

Any dimension columns split into 2 columns:

Dimension Code

Dimension Name

The Dimension Name column is optional. If this column doesn't exist, Dimension Code becomes the Dimension Name. Duplicate Dimension Name values can exist if the Dimension Codes vary.

Levels column headers indicate:

Level Code

Accounts column headers support either of these as the label:

Account Code

Account

You can select

Import without Code and Name columns for display names

to import templates without columns for Code and Name fields. This option also allows importing from older templates created before the introduction of display names. When you turn on

Enable Single Column Data Import/Export for Display Name

General Setup

, we apply

Import without Code and Name columns for display names

across the application and hide the option in the Import page.

Import Metadata Using Name and Code

Model Overview

Was this helpful?

What needs our attention? Accurate Answers my question Easy to find Easy to understand Helps me complete my task Complete with details

What needs our attention? Not accurate Doesn't answer my question Not easy to find Not easy to understand Doesn't help me complete my task Incomplete or lacks detail

Please tell us about the task you're doing or share additional details.

Full Name

Workday will use your name and email to provide you responses to your feedback. Your information will be handled in accordance with our Privacy Statement.

Thank you for your feedback