When starting to use property broker and creating WSDLs teams often come up with their own naming conventions for datatypes, property names, descriptions and captions and the same for actions. I don't really have a strong opinion as to what the right convention should be, but I think it makes sense to agree on one convention in your enterprise to make these names more readable and easier to understand. Property names, action names and datatype names show up in the wiring UI of the Composite Application Editor.
Here is an example for how such a convention could look like.
Conventions for datatypes:- Datatype names should be lowerCamelCase, e.g. "emailAddress"
- No 'Type' in the datatype name, e.g. 'emailAddressType'
- The names should express that some event happened (e.g. changed, selected, ...)
- Good sample: 'Selected person's e-mail address changed'
- Bad sample: 'FileSave'
- The programmatic names should be shorter than the display names, shouldn't use spaces and should be UpperCamelCase (not done in sample below)
- In WSDL even out put properties are represented as actions. I suggest to use as action name 'Publish [property name]'
- Input property names should describe the datatype they have
- Good sample for input property: 'Person's e-mail address'
- Bad samples for input properties: 'Selected person's e-mail address changed', 'Selected person's e-mail address'
- Action names should describe the service they provide
- Good sample for action: 'Show new memo UI using emailAddress' - Bad sample for action: 'UpdateUI'
- The programmatic names should be shorter than the display names, shouldn't use spaces and should be UpperCamelCase (not done in sample below)
