Skip to main content
Indiana Wesleyan University Support Knowledge Base

Naming Conventions

Describes the naming conventions that should be used in Jitterbit Harmony and Cloud Studio.

Details

These Naming Conventions are guidelines for naming objects within Jitterbit Harmony and Cloud Studio.  You should follow them as closely as possible, but there may be exceptions.

API's

API naming conventions TBD

Environments

IWU-OnPrem-Prod

Name will consist of:

  1. The letters IWU followed by a dash
  2. The agent location (Cloud or OnPrem) followed by a dash
  3. The name of the environment (Dev or Test or Prod)

Projects

Name

MAR eClinicalWorks HL7 ADT-in interface

Name will consist of:

  1. Prefix of MAR, N&G, SEM, MIX or IT followed by a space
  2. Descriptive name of the contents of the project

Description

Synchronizes library patron data.
Technical:  Stephen Swan
Business:  Marian the Librarian
Vendor:  Library Account Systems Ltd. 1-800-READ-BKS

Description should contain as many of the following as possible:

  1. Short purpose of the project
  2. Department
  3. Technical contact info
  4. Business contact info
  5. 3rd party vendor contact info

Operations

Get charge files from TOL

Operations are the large boxes in Cloud Studio that contain smaller boxes linked together in a workflow, called Activities.  Their names will consist of:

  1. Verb
  2. Optionally one or more descriptives
  3. Noun
  4. Optionally, the word from and a source name

Files (Schemas)

TOL customer file CSV layout

Name files/schemas whatever makes the most sense, but include the file format (.eg. JSON, XML, CSV).

Variables

iwu.type.label.sublabel

Variable names are lowercase and will consist of:

  1. The letters iwu followed by a period
  2. The data type of the variable followed by a period
  3. A label for the variable
  4. Optionally, a period followed by a sub-label for the variable

Other examples:

iwu.int.record.count
iwu.date.fa2021.start
iwu.string.rave.login
iwu.string.rave.password

Schedules

Weekdays at 6am and 11pm

Name should be descriptive of when and how often the schedule runs.

Emails

Notify of successful file send

Emails should be descriptive of the reason for the email message.

Activities

Activities are the individual steps defined within a larger Operation box.  There are three main types of Activities: Endpoints, Transformations, and Scripts.

Endpoints

Connection

Endpoint Connection names should be descriptive of the source (e.g. SQL Database, CSV file, API)

Query

Select customer data

Endpoint Query names should consist of:

  1. Verb correlating to the source as shown below 
  2. Optionally one or more descriptives
  3. Noun
Source Data creation Data read Data update Data delete
Database Insert Select Update or Merge Delete
HTTP/API Put Get Post Delete
File Write Read Append or Modify Delete

Examples:

Transformations

JSON to CSV

Transformation names should fit the general format X to Y.  If this doesn't make sense in a particular application, fall back on the operation name and/or other descriptive text.

Scripts

Convert datetimes to UTC

Script names should consist of:

  1. Verb
  2. Optionally one or more descriptives
  3. Noun
  • Was this article helpful?