5.5

Action Coding Guidelines
To optimize the performance of workflows and to maximize the potential to reuse actions, you should
follow some basic coding guidelines when creating actions.
Basic Action Guidelines
When you create an action, you must use basic guidelines.
n
Every action must include a description of its role and function.
n
Write short, elementary actions and combine them in a workflow.
n
Avoid writing actions that perform multiple functions, because this limits the potential for reusing the
action.
n
Avoid actions that run for long periods of time. Instead, create a loop in the workflow and include a
Waiting Event or Waiting Timer element after the action element.
n
Do not write check points in actions. Workflows set a check point at the start and end of each element's
run.
n
Avoid writing loops in an action. Create loops in the workflow instead. If the server restarts, a running
workflow resumes at its last check point, at the start of an element. If you write a loop inside an action
and the server restarts while the workflow is running that action, the workflow resumes at the check
point at the beginning of that action, and the loop starts again from the beginning.
Action Naming Guidelines
Use basic guidelines when you name actions.
n
Write action names in English.
n
Start action names with a lowercase letter. Use an uppercase letter at the beginning of each conjoined
word in the name. For example, myAction.
n
Make action names as explicit as possible, so that the function of the action is clear. For example,
backupAllVMsInPool.
n
Make module names as explicit as possible.
n
Make module names unique.
n
Use the inverse Internet address format for module names. For example,
com.vmware.myactions.myAction.
Action Parameter Guidelines
Use basic guidelines when you write action parameter definitions.
n
Write parameter names in English.
n
Start parameter names with a lowercase letter.
n
Make parameter names as explicit as possible.
n
Preferably limit parameter names to a single word. If a name must contain more than one word, use an
uppercase letter at the beginning of each conjoined word in the name. For example, myParameter.
n
Use the plural form for parameters that represent an array of objects.
n
Make variable names unambiguous, for example, displayName.
n
Include a description for each parameter to describe its purpose.
Developing with VMware vCenter Orchestrator
142 VMware, Inc.