Skip to Content

Naming methodology in Jitterbit App Builder

Jitterbit has a methodology that defines naming conventions to follow when developing and maintaining App Builder apps. It is important to follow these naming conventions for consistency and simplicity purposes, and so that any App Builder app can be quickly and easily understood by different App Builder developers.

This document will describe naming conventions as well as provide examples to help illustrate.

Business logic layer

Business rules

The following general guidelines should be used when naming Business Rules in {{nm.ab}}. Different Business Rule types are enumerated, along with example(s) of each.

Event Enabled Business Objects:

  • Target ({{Business Object Descriptor}})

Everything Else:

  • Target ({{Purpose or Subtype}}) {{Descriptor}} – {{Optional Filter}}

Business object with events (MRP/SRP/Board)

  • {{Target}} ({{Descriptor}})
  • Examples:
    • Customer (Details)
    • Order (Details)

Business object with subtype reporting Chart/Calendar/Pivot/Map/Network Graph/Gantt/Report

  • {{Target}} ({{Edge Case Subtype}}) {{Descriptor}}
  • Examples:
    • Customer (Calendar) Active Visits
    • Customer (Gantt) Project Timeline
    • Customer (Chart) Sales Trend by Month - Approved Orders

List

  • {{Target}} (List) {{Optional Descriptor}}
  • Examples:
    • Customer (List)
    • Customer (List) Who

Subquery

  • {{Target}} (Subquery) {{Descriptor}}
  • Example:
    • Customer (Subquery) Concatenate Search Term

CRUD/migration - Subtype Insert/Update/Cram/Delete

Insert
  • {{Target}} ({{Subtype}}) {{Descriptor|Source}}
  • Example:
    • Customer (Insert) Salesforce
Cram
  • {{Target}} ({{Subtype}}) {{Descriptor|Source}}
  • Example:
    • Customer (Cram) Salesforce
Update
  • {{Target}} ({{Subtype}}) {{Descriptor|Field Names}}
  • Example:
    • Customer (Update) Standing ID - Positive
Delete
  • {{Target}} ({{Subtype}}) {{Descriptor}}
  • Example:
    • Customer (Delete) No Activity

Default

  • {{Target}} (Default) {{FieldNames}} – {{SourceTable}}
  • Examples:
    • Customer (Default) AccountStatusID
    • Customer (Default) Country, LeadSource - Param

Performance SQL functions - Group By, Union, Pivot, Stuff

  • {{Target}} {{SQL Function}} {{Descriptor}}
  • Examples:
    • Customer (Group By) Country, State - Active
    • Customer (Pivot) Standing
    • Customer (Union) Customer, Prospect, Contacts
    • Customer (Stuff) Contact Names

Validation

  • {{Target}} (Validation) {{Descriptor}}
  • Example:
    • Customer (Validation) Name too short

Visibility

  • {{Target}} (Visibility) {{Descriptor|Source Table}}
  • Example:
    • Customer (Visibility) CustomerType

Bridge

  • {{Target}} (Bridge) {{Description}}
  • Example:
    • Order (Bridge) Failed

Reach

  • {{Target}} (Reach) {{Descriptor|Source Table}}
  • Example:
    • Customer (Reach) CustomerType

Webhook

  • {{Target}} (Webhook) {{Descriptor}}
  • Example:
    • Customer (Webhook) External