Names, labels & descriptions Best Practices for App Creation

Ensure that module, RPC, or custom IML function names do not conflict with JavaScript reserved words. Consult the list of reserved words in JavaScript for reference.

Module Labels Each module must have a label that accurately represents its function. A standard naming convention exists for different module types but may vary based on the module's functionality. Form the label using a verb indicating the intended action (e.g., Create, Update, Watch) and the entity being processed (e.g., Customer, Invoice, Table).

Module names adhere to the English format with Title Case capitalization. In this style, all words are capitalized except articles, prepositions, and conjunctions. Some examples are:

Triggers and Instant Triggers (Webhooks) These modules monitor new data in a given service and return it. Construct the label following the pattern: Monitor <monitored node>. Examples include:

• Monitor Events
• Monitor Photos
• Monitor Deleted Files

Actions Action modules insert data into a service, alter data within the service, or fetch a single result. Form the label using basic verbs like Create, Get, Update, and Delete, along with the modified or created node. Follow the naming convention of the service you're implementing. Examples include:

• Compose a Note
• Edit a File
• Retrieve a User
• Remove a Task

Searches Search modules extract data from a service, enabling the retrieval of single or multiple results. Create the label using simple verbs like Search or Display. Adhere to the naming convention of the service you're implementing. Examples include:

• Find Files
• Show Tasks

Module Descriptions Briefly outline the module's functionality using a third-person perspective. Capitalize only the first letter of the first word in the description, as per standard sentence structure. For instance, the description for the "Modify a Time Entry" module should be: "Adjusts a time entry for a specific user."

For triggers, use the phrase "Activates when..." in the descriptions. For example, the "Monitor New Users" module description should read: "Activates when a new user is created."

Input and Output Parameter Names and Labels For labels, aim to maintain consistency with the integrated service's names and conventions to minimize confusion for users. 

For variable names, employ the same names used in the service API, which aids in debugging for advanced users and support agents. Ideally, the module's output should match the API response. For example:

Output Paramaters:

[
{
"name": "id",
"label": "ID",
"type": "text"
},
{
"name": "note",
"label": "Note",
"type": "text"
},
{
"name": "firstName",
"label": "First Name",
"type": "text"
},
{
"name": "shortUrl",
"label": "Short URL",
"type": "url"
}
]

Api Response:

{
    "id": "59b1396a4a22a7a3bfc78e22",
    "note": "Hey",
    "firstName": "John",
    "shortUrl": "https://trello.com/c/LdcrM4wa"
}

Abbreviations Ensure proper capitalization for abbreviated terms, such as ID, URLs, GPS, VAT, and so on.