Adhering to naming standards makes it easier to maintain and understand
an orchestration workflow.
Best practices for orchestration workflow step names follow:
- Use camel case (CamelCase) to name steps. Do not use all uppercase
or all lowercase letters.
- Name the steps to describe what they are doing:
Calculate step assigns a value to
something. It has two parts: the
Target and the
Expression. Name the step to describe what is being set in
Target. For example, use
SetTitleField instead of
While steps to describe what they are
processing. For example, use
ForEachConfigurationRecord instead of
Service steps to describe what the Web
service operation is doing. For example, use
CreateAddress instead of
Service steps using a prefix for the Web
services. For example, use
SBM_GetTestCases for the
sbmappservices72 "GetItems" operation to
distinguish it from non-SBM
- Do not use a numeric suffix to indicate a different invocation of
the same Web service. For example, do not use
SBM_GetItemsByQuery1. Instead, use
- Name each
Decision step as a question and name each
branch from the step as the answer. For example, use
ValidName for the step name and
No for the branch name.
Note: In newer versions of
spaces are allowed in branch names. However, in earlier versions spaces are not
allowed, so those branches use camel case.
Working Data Element Names
You use working data elements (variables) to hold intermediate data
and other data needed by orchestration workflow steps. It is important to name
these data elements in a way that makes it clear what role they play and how
they are used.
Best practices for working data element names follow:
- Use camel case (CamelCase) to name the data elements. Do not use
all uppercase or all lowercase letters.
- Use a name that makes it clear what kind of data is being stored.
For example, do not use
Temp. Use descriptive names such as
- Use plurals or
List to name working data array elements. For
Copyright © 2007–2018 Serena Software, Inc., a Micro Focus company. All rights reserved.