Consistency Guidelines
      Back to home
      1. Weatherford Knowledge Base
      2. Getting Started
      3. Consistency Guidelines

      Naming Conventions

      Signals

      • all lower case
      • use well known abbreviations only
      • no pascal or camel casing
      • don't use numbers to abbreviate (e.g. 2 instead of to)
      • use a single space between words
      Examples:

      bad: my BCO score

      good: my bco score

       

      bad: importantSignal

      good: important signal

      Scripts and Workflows

      • capitalized descriptive names
      • don't use pascal or camel casing
      • don't use underscores
      • use a single space between words
      • don't use numbers to abbreviate (e.g. 2 instead of to)
      • don't use verbs in names
      Examples:

      bad: CalculateEUR

      good: Estimated Ultimate Recovery

      Schedules

      • capitalized descriptive names
      • don't use pascal or camel casing
      • don't use underscores
      • use a single space between words
      • don't use numbers to abbreviate (e.g. 2 instead of two)
      • use a combination of the package name, scope increment and the word 'Scope' (if applicable)
      Examples:

      bad: Daily

      good: Basic Daily Scope
      good: Economics Daily Scope

       Workspace Values

      • use pascal casing
      • don't use numbers to abbreviate (e.g. 2 instead of to)
      Examples:

      bad: My workspaceValue

      good: MyWorkspaceValue

      Placeholder

      • capitalized descriptive names
      • don't use pascal or camel casing
      • don't use underscores
      • use a single space between words
      • don't use numbers to abbreviate (e.g. 2 instead of to)
      • don't use brackets to indicate the unit a value should be put in, use "signal notation" instead

      Examples:

      bad: RateThreshold [m3]

      good: Rate Threshold in m3

      Hierarchies, Entity Sets, Scopes, Contexts, Columns, Tag Groups, Labels, etc.

      • capitalized descriptive names
      • don't use pascal or camel casing
      • don't use underscores
      • use a single space between words
      • don't use numbers to abbreviate (e.g. 2 instead of to)
      Examples:

      bad: WellHierarchy

      good: Well Hierarchy

      bad: FromStart2End

      good: From Start To End

      bad: my first column

      good: My First Column