Naming Standards and Location of Objects

Aggregations

The following table describes the standard naming conventions and storage locations that SAS IT Resource Management uses when creating and saving the various objects that are associated with aggregations.
Object
Naming Convention
Location
Notes
aggregation job
<domain category> Aggregation (Example: Disk Aggregation)
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectDomain Categoriesthen select<domain category>.
Aggregation transformation
The naming standard for aggregation transformations can vary slightly. However, the typical structure is <adapter identifier> <domain category>.(Example: NTSMF Disk)
An active Aggregation transformation is in the aggregation job. A template to create your own Aggregation transformation is in the Transformations tree in ITRM Transformations.
Transformation names cannot contain double quotation marks.
column labels (aggregation table)
<corresponding staged table column name> <statistic>
In an aggregation table.
Column names use the following guidelines:
  • Mixed case and no spaces.
  • Abbreviate when necessary or standardized (such as Geometric Mean to GMean or Range to Rng).
column label (ranked)
In the Adapter Setup wizard: <measurement>Rank (Example: CacheReadHitPctWMeanAscRank)
In the aggregation wizards: <measurement>Rank<number (optional)> (Examples: CacheReadHitPctWMeanDescRank, CacheReadHitPctWMeanDescRank01)
In a table.
In the Adapter Setup wizard:
  • Mixed case.
  • Appended with a number.
In the aggregation wizards:
  • Mixed case.
  • Appended with a number if necessary. The numbering starts with the second instance of a label with a similar name. For example, CRHTPCTRank1 has a label of CacheReadHitPctWMeanDescRank with no appended number. But CRHTPCTRank2 has a label of CacheReadHitPctWMeanDescRank01 where the appended number is 01.
column name (ranked)
In the Adapter Setup wizard: <measurement><rank><number> (Examples: DAYDATERANK01, CRHTPCTRANK01)
In the Aggregation wizards: <measurement>Rank<order(optional)> (Examples: DAYDATEDescRank, CRHTPCTRank)
In a table.
In the Adapter Setup wizard:
  • Uppercase.
  • Appended with a number.
In the aggregation wizards:
  • Mixed case.
  • Not always appended with a number.
library (aggregation)
<domain category> <unique number> (Example: Disk 5455)
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectDomain Categoriesthen select<domain category>.
libref (in an aggregation library)
AGG <same unique number as the library> (Example: AGG 5455)
simple aggregation table
Detail<measurement category> (Example: DetailDisk)
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectDomain Categoriesthen select<domain category>.
Mixed case with no spaces.
summarized aggregation table
<time period><measurement category> (Example: MonthShiftDisk)
In the IT Data Marts tree: <IT data mart name>then select<adapter type + number>then selectDomain Categoriesthen select<domain category>.
Mixed case with no spaces.
summarized aggregation table (key metrics)
KeyMetrics<measurement category> (Example: KeyMetricsDisk)
In the same folder as its aggregation tables and aggregation job. In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectDomain Categoriesthen select<domain category>.

Information Maps

The following table describes the standard naming conventions and storage locations that SAS IT Resource Management uses when creating and saving the various objects that are associated with information maps.
Object
Naming Convention
Location
Notes
information map
An information map has the same name as its corresponding source table. (Example: MonthShiftDisk)
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectDomain Categoriesthen select<domain category>.
information map filter (date type)
Includes descriptive words that show the performance area first, then a verb, the type of metric, and a statistic. (Examples: MemoryUsagePctWMean, PagesFreedRateMax)
In the Information Map transformation that is part of the information map job. Information map filters are available on the Information Map Parameters tab of the Information Map transformation properties.
Mixed case with no spaces.
information map filter (statistic type)
Includes descriptive words and components that are based on the following guidelines:
  • The first two characters (if the filter is based on a rank column from a joined table) show which level the column comes from (such as D_ for Day level table, W_ for Week level table, M_ for Month level table, or nothing when it is not from a joined table).
  • The text string Top or Bot corresponds to ascending or descending order.
  • The label name on which the column is based, when appropriate, is included.
  • The text string DescRank or AscRank is included to show the rank order when appropriate.
(Examples: BotMemoryAvailableMB, TopCpuBusyPct)
In the Information Map transformation that is part of the information map job. Information map filters are available on the Information Map Parameters tab of the Information Map transformation properties.
Mixed case with no spaces.
information map job
<domain category> Information Map (Example: Disk Information Map)
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectDomain Categoriesthen select<domain category>.
Information Map transformation
<time period><measurement category> (Example: MonthShiftDisk
An active Information Map transformation is in the information map job. A template to create your own Information Map transformation is in the Transformations tree in ITRM Transformations.
  • The same name as the aggregation table that it uses.
  • Cannot contain double quotation marks.

Reporting

The following table describes the standard naming conventions and storage locations that SAS IT Resource Management uses when creating and saving the various objects that are associated with reporting.
Object
Naming Convention
Location
Notes
domain category
Includes descriptive words for the resource that is being measured.
In the Folders tree: Productsthen selectSAS IT Resource Managementthen selectAdaptersthen select<adapter type>then selectIT Template Tables.
Gallery transformation
<domain category> <time period> (Example: Disk Monthly)
An active Gallery transformation is in the reporting job. A template to create your own Gallery transformation is in the Transformations tree in ITRM Transformations.
Transformation names cannot contain double quotation marks.
report definition
Includes descriptive words that indicate the measures that are reported, the filters that are used, and the time period that is reported. (Example: DiskBusyHighUsageHoursForTheDay)
In the Folders tree: Shared Datathen selectSAS IT Resource Managementthen select3.2 IT Report Definitionsthen select<adapter type>then select<domain category or performance area>then selectSuppliedthen select<time period>.
Save the report definitions that you create in the Folders tree at Shared Datathen selectSAS IT Resource Managementthen selectIT Report Definitionsthen select<adapter type>then select<domain category or performance area>then selectUser Definedthen select<time period>.
reporting job
<domain category> <time period> Reporting (Example: Disk Monthly Reporting)
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectDomain Categoriesthen select<domain category>.

Staging

The following table describes the standard naming conventions and storage locations that SAS IT Resource Management uses when creating and saving the various objects that are associated with staging.
Object
Naming Convention
Location
Notes
column labels (staged table)
<performance area or object> <verb (if needed)> <interpretation> (Examples: MemoryUsagePct, MemoryActivePages, PagesFreedRate)
In a staged table.
Column names use the following guidelines:
  • Mixed case and no spaces.
  • Limit of 40 characters.
  • Abbreviate when necessary or standardized (such as Average to Avg, Minimum to Min, or Percent to Pct).
library (staging)
<adapter type> Staging <unique number> (Example: SAR Staging 1115)
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectStaging.
Mixed case with no spaces.
libref (in a staging library)
STG <same unique number as the library> (Example: STG 1115)
staging job
<adapter type> Staging (Example: SAR Staging
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectStaging.
staged table
A staged table has the same name as the template table on which it is based.
In the IT Data Marts tree: <IT data mart name>then select<adapter type><number>then selectStaging.
staging transformation
<adapter type> (Example: SAR)
An active staging transformation is in the staging job. A template to create your own staging transformation for an adapter is in the Transformations tree in ITRM Transformations.
Transformation names cannot contain double quotation marks.
Copyright © SAS Institute Inc. All rights reserved.