NF Object naming Standards

DB table and column naming

Developer should use all lower-case letters for DB table and column names, words should be separated by _.

For table example, employee master table can be named like “common.employee_master”. common is a schema.

For column example, employee number can be named like any one of the below.

emp_no, employee_no, employee_number

Db objects naming standards

  1. Try to name in lower case.
  2. Remove space among the words with ‘_’.
  3. Remove special characters other than ‘_’.
  4.  Try to use only letters or underscores.
  5. Avoid naming start with ‘_’.
  6. Use ‘_not_used’ at the end of name, if table/column is not used anymore.
  7. Use ‘_yyyy_mm_dd(a-Z)’ at the end, if you want to back up the table/sp.

 

Entity objects naming

Entity object is any defined object in NF Tool. Entity objects as below

  • Entities
  • Methods
  • Tables
  • Fields
  • Table Views
  • Table Filters
  • DLL Methods
  • Field Lookups
  • Field Validators

 

Entity object must be PascalCase, Entity object should not contains any spaces or underscores, or any of these chars ~!@#$%^&*() .Refer below URLs for PascalCase

http://wiki.c2.com/?PascalCase,   https://techterms.com/definition/pascalcase

 

 

Entities

Examples: Account, AccountLedger, AgentType,EmployeeDetails.

 

Methods

For operation: R(Read) - AccountRead, EmployeeRead, DepartmentRead, CircuitOrderRead.

For operation: CUD(CreateUpdateDelete) – AccountCreateUpdateDelete, EmployeeCreateUpdateDelete, DepartmentCreateUpdateDelete, CircuitOrderCreateUpdateDelete.

For operation: C(Create) - AccountCreate, EmployeeCreate, DepartmentCreate,CircuitOrderCreate.

For operation: U(Update) - AccountUpdate, EmployeeUpdate, DepartmentUpdate, CircuitOrderUpdate.

For operation: D(Delete) - AccountDelete, EmployeeDelete, DepartmentDelete, CircuitOrderDelete.

For operation: E(Execute) - GenerateCustomerInvoice,

TerminateAccount, CopyCampaign, ProcessCdr.

 

Tables

There are two types of tables, Request and Response.

Request Table - AccountRequest, EmployeeRequest, DepartmentRequest, CircuitOrderRequest.

Response Table - Account, Employee, Department, CircuitOrder.

 

Fields

AccountNo, AccountName, EmployeeName, DepartmentId, CircuitOrderNo, QuoteName.

 

Table Views

AccountAddress, AccountLevel, EmployeeAddress, CircuitEngineering, EmployeePersonalInformation.

 

Table Filters

AddressType, CityGroup, KeyCampaignRates, ParameterGroup, LcrChainType, StatusType.

 

Field Lookups

Lookup name should contain a suffix word ‘Lookup’.

Example: AccountLookup, AddressTypeLookup, AssemblyMemberLookup, CityCodeLookup.

 

Field Validators

Example: CreditCard, Email, PhoneFax, Zip, Url, AlphaNumericValidator, AddressValidator, AadharNumber, GSTNumberValidator.