Naming conventions for objects and items
Naming conventions in TOM are important in assisting automation specialists and operators in recognizing the purpose and use of each item. Using naming conventions makes future changes and additions to the configuration much easier and faster. It also helps new staff members to learn quickly about your automation environment.
Although we recommend the following naming conventions, you can establish and follow your own meaningful naming conventions:
Items | Recommended naming conventions | ||
|---|---|---|---|
Definition Bases | Name Definition Bases based on their purpose and location (for example, PLEXA-PROD, or PLEXA-PROD-DR). | ||
Objects and sets | Although objects and sets can have a 64-character name, minimize the length as much as possible. Shorter names ensure that the entire name is visible in views and messages. | ||
Non-movable objects | Add the system name in the object name of non-movable objects that use only one system in the Valid Systems List (VSL). Name the object in the format system-name.UNIQUE, with the system name at the beginning, so that TOM displays groups of objects in views. For example, name a TSO-started task that runs on SYS1 SYS1.TSO. | ||
Movable objects | Add the sysplex name in the object name for movable objects (multiple systems or entries in the Valid Systems List). Name the object in the format sysplex-name.UNIQUE, with the sysplex name at the beginning, so that TOM displays groups of objects in views. For example, name a movable CA7 object that can run on SYS1 or SYS2 in sysplex PLEXA PLEXA.CA7. | ||
Layer objects | Name layer objects in the format of Io.UNIQUE. For example, the layer object for a non-movable TSO-started task would be Io.TSO, and its pattern attribute for naming the object would be &SYSNAME.TSO. The layer object for a movable CA7-started task would be Io.CA7 and its pattern attribute would be &SYSPLEX.CA7. | ||
Model objects | Name model objects in the format of model.useOfModel. The string should start with the word model and indicate the use of the model, such as common STC attributes. | ||
Layer objects | If the model is generated from a layer object, use the format model.Io.useOfModel. For example, use model.Io.STC, or model.Io.STC.TRANS for a transient object that was started by TOM at IPL and then ends normally. | ||
Non-layer objects | If the model is a non-layer object, use the format model.useOfModel. For example, use model.STC, or model.STC.TRANS for a transient object that was started by TOM at IPL and then ends normally. | ||
Sets | Layer sets | Name layer sets in the format Is.UNIQUE so it contains a unique description of the layer. For example, ls.CICSPROD with a pattern attribute of &SYSPLEX.CICSPROD, &SYSNAME.CICSPROD, or set.CICSPROD. | |
Non-layer sets | Name non-layer sets in the format sysplex.UNIQUE, system.UNIQUE, or set.UNIQUE. For example, PLEXA.CICSPROD, SYS1.CICSPROD, or set.CICSPROD. | ||
Layer-related items | Layer sysplex (Sysplex Matrix) | You must give the layer sysplex the same name as the sysplex that it represents. This is because the sysplex name determines and assigns the &SYSPLEX layer variable value when objects and sets are generated. | |
Sysplex layers | Name sysplex layers in the format pl.PLEXNAME. You can also use a variation of the sysplex name or some other descriptive string (for example, pl.PLEXA, pl.PLEXA-DR or pl.PROD). | ||
System layers | System layers contain layer objects and layer sets. Name system layers in the format sl.UNIQUE. The name should contain a descriptive text (for example, sl.STANDARD-STC, sl.BASE-STC, sl.OLT, or sl.DATABSE1). | ||
System pools (for movable objects) | TOM uses system pools for generating moveable objects and the system pool name is specified as the single entry in a movable object's VSL. It contains all the sysplexes and systems on which TOM manages the generated object. Name system pools in the format Ip.UNIQUE. The name should contain a descriptive text (for example, lp.ALLSYS, or lp.MOVEABLES). | ||