Skip to main content
OnCommand Workflow Automation 5.0
A newer release of this product is available.

Guidelines for WFA dictionary entries

Contributors

You must be aware of the guidelines for creating dictionary entries in OnCommand Workflow Automation (WFA).

Guidelines Example

Dictionary entry names must contain only alphanumeric characters and underscores.

Cluster_License

Switch_23

Dictionary entry names must start with an uppercase character.

Begin every word in the name with an uppercase character and separate each word with an underscore (_).

Volume

Array_License

Dictionary entry attribute names should not include the name of the dictionary entry.

None

Attributes and references in a dictionary entry must be in lowercase characters.

aggregate, size_mb

Separate words with an underscore. Spaces are not allowed.

resource_pool

Dictionary entries cannot include references that are from a different scheme.

When a dictionary entry requires cross-reference to an object in a different scheme, ensure that all the natural keys of the object being referred to are present in the dictionary entry.

Array_Performance dictionary entry requires all the natural keys of the Array dictionary entry as direct attributes in it.

Use appropriate data types for attributes.

None

Use Long data type for size or space-related attributes.

size_mb and available_size_mb in storage.Volume dictionary entry

Use Enum when an attribute has a fixed set of values.

raid_type in storage.Volume dictionary entry

Set “To be Cached” as true for an attribute or reference when a data source provides value for that attribute or reference.

For OnCommand Unified Manager data source, add cacheable attributes if the data source can provide the value to it.

None

Set “Can be Null” as true if the data source providing the value for this attribute or reference can return NULL.

None

Provide a meaningful description to each attribute and reference.

The description is displayed in command details when designing a workflow.

None

Do not use “id” as the name of an attribute in dictionary entries.

It is reserved for internal WFA usage.

None