OutSystems standards and guidelines at Synobsys

Logo

Standards, best practices and how-tos for developing OutSystems applications

Entities and attributes naming conventions

How to name Entities?

If you’re naming entities that represent real-world facts, you should use nouns. These are entities like Employee, Customer, City, and Country. If possible, use a single word that exactly describes what is in the table. On the example of our 4 Entities, it’s more than clear what data can be found in these Entities.

For relations between two entities, it’s good to use these two entities’ names and maybe add a verb between these names to describe what that action is.

Imagine that we have entities User and Role. We want to add a many-to-many relation telling us that a user had a certain role. We could use names UserHasRole, or if we want to be shorter – UserRole.

We could always make exceptions if they are logical. If we have entities Product and Invoice, and we want to specify which products were on which invoice, we could name that table InvoiceProduct or InvoiceContainsProduct. Still, using the name InvoiceItem is much closer to the real world. Still, that decision is completely up to you.

Attribute naming