Skip to content

Files

Latest commit

StephenOTTStephenOTT
Update patterns.md
Aug 16, 2017
4b70601 · Aug 16, 2017

History

History
15 lines (13 loc) · 1.56 KB

patterns.md

File metadata and controls

15 lines (13 loc) · 1.56 KB

General Patterns

The following is a list of patterns that should be followed:

  1. Files names and paths should not contain spaces or any non-URL friendly character.
  2. Camunda deployment-name and deployment-source should not contain any spaces or non-URL friendly character.
  3. BPMN, DMN, and CMMN process files should be separated into their respective root folders.
  4. The contents of the BPMN, DMN, and CMMN folders can be structured however the developer thinks fits the structure of the project.
  5. Reusable scripts should be stored in the resources/scripts folder.
  6. The README.md file should be maintained with the latest project information at all times.
  7. The deploy.json file in the deployment object supports all fields in the Camunda /deployment/create API
  8. The config.json file is used to store common configurations used by one or many process files. The structure of this JSON file is up to the developer.
  9. The /resources folder should contain all files that are used by process files. Examples could be: FreeMarker templates, images, PDFs, text files, json files, etc.
  10. The /resources/forms folder is generally used to store the Camunda Embedded Angular Form's .html files which are used in Camunda Tasklist. This folder can be omitted or repurposed as required.
  11. When using Exclusive Gateways for a Yes/No pathway, use a "default flow" parameter on one of the sequence flows. The other sequence flow should return a true or false depending on the function's return. Do not build opposite logic that is located in both sequence flows.