Nuxeo Online Services

Naming Conventions

Updated: March 14, 2019 Page Information Edit on GitHub

This page provides naming conventions for Studio items configuration to make usage, maintenance and support easier.

Using Naming Conventions enables you to debug more efficiently. By investigating server.log, you can instantly identify which type of configuration caused an error. It also ensures better investigation of your issues by the Support Team.

quick switcher
By using prefixes, you can find elements of your configuration more easily. You can jump between any Studio feature or menu in a snap by typing its name. This action can be triggered by clicking the Jump To option on the bottom left of your Studio project or using the Ctrl + K / ⌘ + K shortcut.

We strongly encourage you to follow these, especially if you are a beginner.

General Rules

  • Use pascal case naming convention (initial uppercase letter).
    • Example: PascalCase
  • Use underscore _, instead of hyphens -. Automation scripting doesn't work with items containing hyphens.

Nuxeo Studio Modeler

Content Model

Item Rules Example
Document types Pascal case naming convention ContractLibrary
Schemas Lower case, separated by underscore only if readability is affected contract_library
Properties Camel case, not separated contractNumber
Lifecycles Pascal case naming convention ContractLifecycle
Lifecycle states Camel case, not separated ingestionInProgress
Lifecycle transitions to_ followed by the lifecycle state name to_ingestionInProgress
Structure templates Pascal case naming convention ContractLibraryStructure

Workflow

Item Rules Example
Workflow templates WF_ followed by the workflow template name WF_Contract
Workflow tasks TK_ followed by the workflow task name and the associated workflow template TK_ContractReview_WF_Contract

Page Providers

Item Rules Example
Page Providers PP_ followed by the document type name (if searching for a specific document type), and the search name PP_Obsolete_Contracts

Automation

Item Rules Example
Automation chains AC_ followed by the associated document type (if specific to a particular document type) and the automation name. AC_Contract_UpdateLifecycle
Automation scripting AS_ followed by the associated document type (if specific to a particular document type) and the automation name. AS_Contract_CreationPrefill
Event handlers EH_ followed by the associated automation chain/scripting name EH_AS_Contract_CreationPrefill

Templates

Item Rules Example
Document templates DT_ followed by the document template name DT_ContractReport
Mail templates MT_ followed by the mail template name. If relevant, add the corresponding workflow task triggering the mail template, an event, a button etc. MT_TK_ContractReview_WF_Contract

Roles and Permissions

Item Rules Example
Permissions Pascal case naming convention ReadWithoutDownload

Vocabularies

Item Rules Example
Vocabularies VOC_ followed by the property name (if relevant), and the vocabulary name VOC_ContractProvider

Advanced Settings

Item Rules Example
XML Extensions XML_ followed by the extension point type (actions, notifications, providers, doctype...) and the configuration name. If relevant, add the associated document type, automation chain, workflow task triggering the mail template, an event, a button etc. XML_notification_Contract_OnCreation

Nuxeo Studio Designer

UI

Item Rules Example
Layout elements All elements from the Layout are auto-generated by Nuxeo Studio Designer. nuxeo-contract-create-layout
Document tabs TAB_ followed by the associated document type (if relevant), and the page name TAB_Contract_Attachments
Drawer items DI_ followed by the associated document type (if relevant), and the page name DI_Contracts
Drawer menus DM_ followed by the associated document type (if relevant), and the page name DM_Contracts
Actions Button_ followed by the associated automation chain or automation scripting Button_AC_Contract_UpdateLifecycle
Themes Theme_ followed by the associated project Theme_ContractManagement
a month ago manonlumeau Rename drawer options
a month ago manonlumeau NXDOC-1871: update Nuxeo sources retrieval
3 years ago Karin Touchie 25
4 years ago Solen Guitter 24 | Fix format and TOC
4 years ago Vincent Dutat 23
6 years ago Solen Guitter 22 | Updated operation link to use Explorer
7 years ago Solen Guitter 20 | Added TOC
7 years ago Solen Guitter 21 | Migrated to Confluence 4.0
7 years ago Frédéric Vadon 19
7 years ago Frédéric Vadon 18 | typo
7 years ago Frédéric Vadon 17
7 years ago Frédéric Vadon 16
7 years ago Frédéric Vadon 15
7 years ago Frédéric Vadon 14
7 years ago Frédéric Vadon 13
7 years ago Frédéric Vadon 12
7 years ago Frédéric Vadon 11
7 years ago Frédéric Vadon 10
7 years ago Frédéric Vadon 9
7 years ago Frédéric Vadon 8
7 years ago Alain Escaffre 7
7 years ago Frédéric Vadon 6
7 years ago Frédéric Vadon 5
7 years ago Frédéric Vadon 4
7 years ago Frédéric Vadon 2
7 years ago Frédéric Vadon 3
7 years ago Frédéric Vadon 1
History: Created by Frédéric Vadon

We'd love to hear your thoughts!

All fields required