Naming Conventions
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 names should consist of:
Environments
IWU-OnPrem-Prod
Name will consist of:
- The letters IWU followed by a dash
- The agent location (Cloud or OnPrem) followed by a dash
- The name of the environment (Dev or Test or Prod)
Projects
Name
MAR eClinicalWorks HL7 ADT-in interface
Name will consist of:
- Prefix of MAR, N&G, SEM, MIX or IT followed by a space
- 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:
- Short purpose of the project
- Department
- Technical contact info
- Business contact info
- 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:
- Verb
- Optionally one or more descriptives
- Noun
- 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:
- The letters iwu followed by a period
- The data type of the variable followed by a period
- A label for the variable
- 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:
- Verb correlating to the source as shown below
- Optionally one or more descriptives
- 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:
- Verb
- Optionally one or more descriptives
- Noun