Skip to main content

Notifications

Microsoft Dynamics AX (Archived)

Modern label naming guideline

Posted on by 3,542

For reference; the standard convention: https://docs.microsoft.com/en-us/dynamicsax-2012/developer/naming-conventions-name-structure

However there remains a lot of additional naming. Does someone have a decent (in their opinion) label ID policy that builds on the above mentioned standard?

If you'd be interested in my own guideline:

Using the extremely creative example of a plants add-in (lets call the module PLA). My guideline would look something like this

For a possible table PLATree

Label: @PLA:TreeCollection

Singular Label: @PLA:Tree

Developer Documentation: @PLA:TreeDevDoc

For the PLATreeName EDT (also in the table)

Label: @PLA:Tree *same as the table's singular label

HelpText: @PLA:TreeHelp

Collection label: @PLA:TreeCollection *same as the table's label

For the PLATreeRecId EDT (extends RefRecId and reference table set to PLATree)

Label: @PLA:Tree

HelpText: @PLA:TreeHelp

Collection label: @PLA:TreeCollection (not sure if it's necessary)

For an enum PLAPlantType with elements Bush and Flower

Enum label: @PLA:PlantType

HelpText: @PLA:PlantTypeHelp

PLAPlantType::Bush label: @PLA:PlantTypeBush

PLAPlantType::Flower label: @PLA:PlantTypeFlower 

Following the mentioned guideline keeps things quite organised, but it still becomes unorganised as the module grows.

 

 

 

I guess the easiest solution is to just create a new label whenever the project manager or boss or whoever decides on something else. But the perfectionist part of me wants to keep the thing organised (I hope I'm not the only one). And I guess it will prevent inconsistencies. For example: A request comes in to relabel some form's fast tab, in which the quick solution to create a new label would not change the label on some other similar form with a similar fast tab.

I hope this will not be seen as unnecessary (or even spam :D ). I guess it is a simple thing, but still a very large part of the average developer's day. And definitely bugs me a lot.

Kind regards

Thanks for reading

*This post is locked for comments

  • Pete Alberts Profile Picture
    Pete Alberts 3,542 on at
    RE: Modern label naming guideline

    So just to put it flat - you suggest to not use the modern label method and stick with the old classic method?

    My opinion, for what it counts, is moving in the same direction.

  • Pete Alberts Profile Picture
    Pete Alberts 3,542 on at
    RE: Modern label naming guideline

    Thanks Crispin, much appreciated!

    I was referring to a company's own model/development. Not existing stuff. Very interesting story though :)

    "Labels have to be clearly decided .. before developing". I assume you are referring to the label text. I am asking about the label IDs.

    "Editing labels ... not best practice" I am referring to a feature in development. I am sure that however big and organised a company is, there will be changes (including labels) during the course of the development project.

    One of my seniors (I'd say my mentor), often talks about some or other big company he worked at where everything was organised and planned and all that.

    Which brings me to the point - we are a small company. There is no designated project manager and decades of planning. My boss has an idea; I buy into it; and then we develop and change as we go along.

    And maybe it's not even about the company size. I'll blame it on the third world country (this is Africa). :D I get the idea that other bigger companies here in SA go about the same method. It's not as organised as I would imagine in the EU or the land of the free. (I am just guessing - I have very little experience to say the least.)

    But all that doesn't really matter. If I understand correctly, you mean that labels should be decided on before development start. I am very sure that does not include deciding on label IDs. Only in a perfect world would a project exist where someone is assigned to think out 2000+ label ID's. (Correct me if I am wrong - I'd be surprised.)

    So then it all comes back to the question I put in the OP. As the developer will be defining the label ID's, do you have a sensible naming guideline?

    Kind regards

    Thanks once again for replying to my numerous posts Crispin.

Under review

Thank you for your reply! To ensure a great experience for everyone, your content is awaiting approval by our Community Managers. Please check back later.

Helpful resources

Quick Links

December Spotlight Star - Muhammad Affan

Congratulations to a top community star!

Top 10 leaders for November!

Congratulations to our November super stars!

Tips for Writing Effective Suggested Answers

Best practices for providing successful forum answers ✍️

Leaderboard

#1
André Arnaud de Calavon Profile Picture

André Arnaud de Cal... 291,253 Super User 2024 Season 2

#2
Martin Dráb Profile Picture

Martin Dráb 230,188 Most Valuable Professional

#3
nmaenpaa Profile Picture

nmaenpaa 101,156

Leaderboard

Featured topics

Product updates

Dynamics 365 release plans