Label Patterns

Menu or Menu Item

menuname or menuitemname

modulePrefix.menuname or modulePrefix.menuitemname

MyMenuItem=My Item

ZBKS.MyMenuItem=My Item

Menu items are referenced directly by their WebAction or WebActionGroup name. They are not qualified with any standard prefix.

Form Field, Table Column Header

meta.field.fieldname

meta.field.modelleveltype.fieldname

meta.field.custommodelname.modelleveltype.fieldname

meta.field.Title=The Title

meta.field.ZBKS.Book.Title=The Title

meta.field.CustomOrderRequest.OrderHeader.ShiptoSiteId=Consignee

The field pattern is used for both form fields and table column headers.

Form Field Tooltip

meta.field-tooltip.fieldname

meta.field-tooltip.modelleveltype.fieldname

meta.field-tooltip.Title=The Title

meta.field-tooltip.ZBKS.Book.Title=The Title

This pattern is used to display a tooltip when the user hovers over the field label, for form fields in Model Form pages and in Reports, in the Filters section.

Model Action

meta.actions.actionname

meta.actions.modeltype.actionname

meta.actions.ZBKS.Publish=Publish the Book

meta.actions.ZBKS.Book.ZBKS.Publish=Publish the Book

Any time you see a model action, such as in the pop-up Actions menu on a list screen, this will drive the label shown for those actions.

Role Type

meta.roleType.roletypename

meta.roleType.ZBKS.Supplier=Book Supplier

This label will configure how the role type is displayed, for example in the Switch Role menu.

Issue Name

meta.field.ISSUE_NAME.issuename

meta.field.ISSUE_NAME.ZBKS.NotInGoodCondition=Poor Condition

Alert Summary, Subscription and Inbox pages will use these labels to display issues.

Issue Filters

meta.issueFilter.custommodelname.issuename.filtername

meta.issueFilter.Standard ZBKS.Book.ZBKS.NotInGoodCondition.PriceThreshold

Alert Subscription will use these labels to display issue filter names. Please note - filter name fallback to "meta.field.filtername" in case above label pattern is not used.

TimelineView Data Measure

tlvname.dmname.label

ZBKS.MyTLV.NumberOfBooksSold.label=Books Sold

Governs the name shown for a data measure row in a Timeline View.

Templates

meta.tpl.name.templatename

meta.tpl.desc.templatename

meta.tpl.name.OrgTemplate=Org Template

meta.tpl.desc.OrgTemplate=This is an org-level template.

These labels control a template's name and description, respectively.

Enumeration Values

meta.enum.enumname.value

meta.enum.leveltype.fieldname.value (for enumerations defined in a report CustomFilterField)

meta.enum.ZBKS.Genre.Fiction=Fictional

meta.enum.Undefined.Priority.High=High (where report contains STRING_ENUMERATION custom filter field "Priority" with level "Undefined")

You can provide an entry for each value in your module-defined enumerations to customize their labels.

Enumeration Documentation - Displayed Values

meta.enum.enumname.display

meta.enum.QuantityUOM.display=EACH, CASE, PALLET, ...

These values will be shown in the header of a CSV file, for example "Quantity UOM (EACH, CASE, PALLET, ...)"

Enumeration Documentation - Sample Value

meta.enum.enumname.sampleValue

meta.enum.QuantityUOM.sampleValue=EACH

This value will be provided as the default value for the given enumeration type in a generated sample CSV.

State Values

meta.field.State.statename

meta.field.State.modelleveltype.statename

meta.field.State.Open=Open for Changes

meta.field.State.ZBKS.Book.Open=Open for Changes

You can customize the values shown in model state summaries, the options shown in State filters, and the state values shown in Model Forms.

Model Level Type

meta.level.modelleveltype

meta.level.ItemSubstitution=Item Substitution

This label will configure how the model level type is displayed, for example in the Integration Subscription Create page

Model Level Type in Plural Form

meta.plural.level.modelleveltype

meta.plural.level.ZBKS.BookPage=Book Pages

This label will configure how the model level type is displayed in plural form, for example in the Model Crud Page's child model grid's title

Custom Model Definition

meta.customModel.custommodelname

meta.customModel.Standard\ Shipment=Shipment

This label will configure how the custom model name is displayed, for example in the Enterprise Role Types UI (Actions Tab).

Custom Model Definition Description

meta.customModel.custommodelname.desc

meta.customModel.Standard\ Shipment.desc=Shipment is used to represent the transfer of goods from one party to another

This label will configure how the custom model description is displayed, for example in the Enterprise Role Types UI (Actions Tab).

TimelineView Column Hierarchy Name

meta.tlv.field.columnname

meta.tlv.field.TEST_DESCRIMINATOR=Descriminator

This label will configure how the column name for a column hierarchy is displayed in a Timeline View.

Interface Group Name

meta.interfaceGroup.interfacegroupname

meta.interfaceGroup.ZBKS.BookGroup1=Book Group 1

This label will configure how the interface group name is displayed, for example in the Integration Subscription Create page

Outbound Interface Name

meta.interface.outbound.interfacename

meta.interface.outbound.ZBKS.BookUpload=Book Upload

This label will configure how the outbound interface name is displayed, for example in the Integration Subscription Create page

Inbound Interface Name

meta.interface.inbound.interfacename

meta.interface.inbound.ZBKS.BookSend=Book Send

This label will configure how the inbound interface name is displayed

Inbound Interface Conditionally Required Fields Description

ConditionallyRequiredField.interfaceName.interfaceVersion.level.field

ConditionallyRequiredField.ZBKS.BookSend.1.0.ZBKS.Book.Title

This label will configure how the conditional description is going to be displayed in the error response.

Dashboard Portlet Category

portlet.category.categoryname

portlet.category.BookPortletCategory=Books Category

This label will configure how the portlet category is displayed, for example in the Dashboard's Add Portlet pop up menu.

Dashboard Portlet Name

portlet.class.name

portlet.ZBKS.Portlet.BooksPortletReport.name=Books Report

This label will configure how the portlet name is displayed, for example in the Dashboard's Add Portlet pop up menu. This will work only for PortletDef. For PortletRef, localize the name in the getPortletInfo() method.

Dashboard Portlet Description

portlet.class.description

portlet.ZBKS.Portlet.BooksPortletReport.description=Portlet based on Books Report

This label will configure how the portlet description is displayed, for example in the Dashboard's Add Portlet pop up menu. This will work only for PortletDef. For PortletRef, localize the description in the getPortletInfo() method.

Global Screen Element

meta.screen.globalscreenelement

meta.screen.ZBKS.Cost-Details=Cost Details

This label will configure how the global screen element is displayed, for example in the Ent Role Types UI (Info tab)

Composite Field

CompositeFieldType.name.viewPattern

CompositeFieldType.PriceRange.viewPattern={0} - {1}

CompositeFieldType.RatioWithUOM.viewPattern={0}/{1} {2}

This label will configure how the components of complex field types are layed out. Use {0..n}, for example {0}, {1}, {2} etc to represent each component. All other characters are interpreted literally.

Report

meta.report.reportname.ExportFileName

meta.report.ZBKS.BooksByTitle.ExportFileName=BooksByTitleReport If export format is CSV then default file name would be BooksByTitleReport.csv

This label will configure default base name(i.e. part without extension) for generated file while exporting the report.

Preference Identifier

meta.report.reportname (for report)

meta.view.valuechainname.viewname (for view)

meta.report.ZBKS.BooksByTitle=Books By Title Report

meta.view.BookstoreValueChain.BooksByTitleView=Books By Title View

This label will configure how the preference identifier is displayed, for example in the Create Report Preferences UI

Preference Key

meta.report.preferences.preferenceKey.preferenceidentifier.prefkey

meta.report.preferences.preferenceKey.BooksByTitle.Title=Title

This label will configure how the preference key is displayed, for example in the Create Report Preferences UI

Label variation by Role Type

RT>RoleTypeName.ExistingKey

RT>ZBKS.Supplier.meta.field.Title=Supplier Title

This pattern allows variation of existing labels by role type. The ExistingKey can be any valid label pattern mentioned above in the table. The label specified for such pattern will only be applied for the role type mentioned in the key. The label value will not be inherited by derived role types.

Pivot report title

meta.pivot.name.PivotName

meta.pivot.name.InventorySummaryPivot=Inventory Summary Pivot

This label pattern defines tab title to be displayed for a pivot report

Issue Computation Display Fields

meta.issuesubscription.displayfield.DisplayName

meta.issuesubscription.displayfield.DisplayField1=Display Field 1

Label pattern to set localized value for Display Fields defined in personalized issue computation.

NeoAnalytics Fact Name

neodwfact.FactName.label

neodwfact.DAWH.ShipmentFact.label=Shipment Fact

Label pattern to set localized value for NeoAnalytics Fact name.

NeoAnalytics Fact Description

neodwfact.FactName.description

neodwfact.DAWH.ShipmentFact.description=Shipment Fact Description

Label pattern to set localized value for NeoAnalytics Fact description.

NeoAnalytics Fact Category

neodwfact.CategoryName.category

neodwfact.Shipment.category=Shipment Category

Label pattern to set localized value for NeoAnalytics Fact Category.

NeoAnalytics Fact DWField Name

neodwfact.FactName.field.DWFieldName.label

neodwfact.DAWH.ShipmentFact.field.Ship\ From\ Organization.label=Shipment From Organization

Label pattern to set localized value for NeoAnalytics Fact DWField name.

NeoAnalytics Fact DWField Description

neodwfact.FactName.field.DWFieldName.description

neodwfact.DAWH.ShipmentFact.field.Ship\ From\ Organization.description=Shipment From Organization Description

Label pattern to set localized value for NeoAnalytics Fact DWField description.

NeoAnalytics Dimension Name

neodwdim.DimensionName.label

neodwdim.DAWH.Organization.label=Organization Dimension

Label pattern to set localized value for NeoAnalytics Dimension name.

NeoAnalytics Dimension Description

neodwdim.DimensionName.description

neodwdim.DAWH.Organization.description=Organization Dimension Description

Label pattern to set localized value for NeoAnalytics Dimension description.

NeoAnalytics Dimension Attribute Name

neodwdim.DimensionName.field.AttributeName.label

neodwdim.DAWH.Organization.field.Ent\ Name.label=Enterprise Name

Label pattern to set localized value for NeoAnalytics Dimension Attribute name.

NeoAnalytics Dimension Attribute Description

neodwdim.DimensionName.field.AttributeName.description

neodwdim.DAWH.Organization.field.Ent\ Name.description=Enterprise Description

Label pattern to set localized value for NeoAnalytics Dimension Attribute description.

Neo Dashboard Name

meta.field.NeoPortalDefName

TMS.CarrierNeoDashboard=Carrier Neo Dashboard
TMS.ClientNeoDashboard=Client Neo Dashboard

Label pattern to set the localized value for Neo Dashboard Name

EntityGroupType Name

meta.EntityGroupType.Name.NameValue

meta.EntityGroupType.Name.CustomerNo=Customer Number

Label pattern to set the localized value for the EntityGroupType name value

DocumentType Name

meta.doctype.<doctypecategory>.<doctypename>

meta.doctype.Attachments.OverrideTestForAttachedDocument=XXXOverrideTestForAttachedDocument

meta.doctype.Attachments.TestDocumentType=XXXTestDocumentType

meta.doctype.Attachments.Car\ Document=XXXCar Document

Pattern is added to internationalize the document type values

Problem Type Name

meta.problem.name.<ProblemTypeName>

meta.problem.name.ZBKS.ZeroCost=Zero Cost

Pattern to set the localized value for the problem type name