Skip to main content

Control procedure guidelines

These guidelines provide directions for naming and structuring control procedures and templates.

Control procedures​

A Control procedure ID should:

  • Describe the purpose of its templates
  • Not just contain the name of a table, view, or task
    • Correct: validate_sales_order_discount, generate_country_layout, check_project_budget
    • Incorrect: default_sales_order, layout_country, trigger_project
  • Not contain any meta information, like the code group name or abbreviation
    • Correct: assign_user_roles, calculate_order_total, revoke_user_access
    • Incorrect: default, task, table

Templates​

A Template ID should:

  • Describe the specific purpose of the template
  • Not contain any meta information
    • Correct: calculate_discount_amount, send_order_confirmation, archive_old_tasks
    • Incorrect: default, task, template1
  • Match the Control procedure ID if the control procedure contains only one template
  • Differ from the Control procedure ID if it contains multiple templates
  • Be atomic: it should implement exactly one piece of functionality
  • Not depend on any other template

Was this article helpful?