Guidelines for Naming Conventions

Establishing good naming conventions for the objects in AAI is key to the ongoing success of your workload automation practices across your organization. This topic is most important for the business area coordinator who decides on the standards for the objects and structures in AAI during the business implementation of the product. Here you find why naming conventions are important and some guidelines for defining them.

Which Objects Require Naming Conventions?

As the business area coordinator you need to establish naming conventions for the following objects:

  • Business areas
  • Jobstreams
  • Filters
  • Dashboards
  • Reports

Business areas and jobstreams are named centrally when they are created by the business area coordinator or jobstream administrator, who have the required privileges. A default set of filters and dashboards are also created centrally but users can further create their own filters and dashboards, in which case they name them as they like. Reports are often defined not by the consumer of the data on the report, but by someone who understands both the needs of the report consumers and the AAI data structures.

What Are Good Naming Conventions?

Base your naming conventions on self-explanatory names and terminology that is familiar to the people who will work with AAI. Names can be anything helpful to communicate the purpose or significance of the object. For example, for certain jobstreams you might find the most helpful name is one that includes the parts of the process that would be impacted by an outage.  

Important !

The jobstream name must be unique. Some schedulers, such as AutoSys and Automic can have process names that are not unique in the themselves but are unique in context of their hierarchy or group. For these schedulers, make sure that your jobstream name includes an indication of its parentage, for example, Daily_Billing_North_America and Daily_Billing_South_America.