Extending : Naming convention extension
  
Naming convention extension
When you create an element by using UNICOM® Digital Transformation Toolkit (UDTT™) tooling, the name or ID of the element begins with a default prefix; for example, the ID of a newly created label widget in the XUI editor is "label" by default. Technical developers can customize the default UDTT naming conventions to comply with their project naming specification, such as operations start with op, formatters start with fmt, and so on. Naming validators can also be customized to validate whether the created elements comply with the naming conventions.
Customized naming conventions can be applied to the following UDTT elements:
Note The related convention properties can be find in file com.ibm.btt.tools.common\src\com\ibm\btt\tools\common\naming\impl\naming_convention.properties, BTTToolsZeroCodeEditor\src\com\ibm\btt\tools\xui\editor2\crossfield\ui\nameing\cross_field_name.properties.
Transaction editor
 
Item
Rule Definition
Suffix of an operation transacftion
OPERATION_FILE_POSTFIX=Op.transaction
Suffix of a processor transaction
FLOW_FILE_POSTFIX=Flow.transaction
The transaction xml file generated from ws service
TRANSACTION_XML=ws{model_port_name}_{model_oper_name}.xml
The common service xml file generated from ws service.
COMMON_TRANSACTION_XML=common_service_{model_port_name}.xml
The name of new generated processor
Processor={file_name}
The name of new generated operation
operation={tran_mark}Op{oper_count}
ID of the operation name generated from WebService wizard
wsOperation={sdo_prefix}{SEI}_{operationId}
ID of an operation step
opStep={impl_class}OpStep{op_step_count}
ID of a context
context={tran_mark}Ctx{ctx_count}
ID of data elements
data={tran_mark}Data{item_count}
ID of fileld elements
field={tran_mark}Field{item_count}
ID of iColl elements
iColl={tran_mark}List{item_count}
ID of kColl elements
kColl={tran_mark}Record{item_count}
ID of bColl elements
bColl={tran_mark}BColl{item_count}
ID of treeModel elements
treeModel={tran_mark}TreeModel{item_count}
ID of a formatter
fmtDef={tran_mark}Fmt{fmt_count}
ID of a service
service={service_name}Srv{service_count}
ID of transition formatter
FORMATTER_ID_FOR_TRANSITION={transition_id}_{fmt_type_suffix}{fmt_count}
ID of common condition
ConditionDic=commonCon{con_count}
ID of condition variable
ConditionVar=variable{var_count}
Name of new generated condition state
ConditionState.name=condition{con_state_count}
Default event name of new condition state
ConditionState.DefaultEvent=default
Event name generated from condition state
ConditionState.event=condEvt{con_event_count}
Exit event name of final state
FinalState.ExitEvent=[OK,NotOk]
Event name of initial state
InitialState.event=start{state_event_count}
Event name of operation state
OperationState.event=opEvt{state_event_count}
Event name of subflow state
SubFlowState.event=flowEvt{state_event_count}
Event name of page state
PageState.event=viewEvt{state_event_count}
Event name of popup page state
PopupPageState.event=viewEvt{state_event_count}
Event name of extended state
State.event=evt{state_event_count}
XUI editor
 
Item
Rule Definition
Name of a .xui file
FILE_XUI=newXuiFile{file_count}.xui
ID of a widget
ELEMENT_WIDGET={widget_type}{widget_count}
ID of an ECA rule
ELEMENT_ECA_RULE=ecaRule{rule_count}
Name of action group
ELEMENT_CA_NAME=actionGroup{action_count}
ID of CrossField Validation rule
com.ibm.btt.tools.xui.editor2.crossfield.CorssFieldValidation=xValidation{cross_field_count}
Customized naming conventions can be applied at the following two levels:
Project level: The naming conventions are applied to specific project.
System level: The naming conventions are applied to all projects in workspace.
To customize a UDTT naming convention, you can use either of the two methods.
Extending naming conventions by registering a new naming convention rule
UDTT provides a naming convention rule that enables technical developers to customize simple naming conventions without coding.
For more information, see Extending naming conventions by registering a new naming convention rule.
Extending naming conventions by registering a new naming manager class
By extending naming conventions by registering a new naming manager class, technical developers can have full capability of naming UDTT elements when those elements are created. On the other hand, when extending naming conventions by registering a new naming manager class, technical developers have to implement the naming convention from scratch and cannot leverage existing UDTT naming implementations.
For more information, see Extending naming conventions by registering a new naming manager class.
Extension sample for the generated web service operation
Extension developers can extend their own naming rule for the generated web service operation.
For more information, see Extension sample for the generated web service operation.