TLM VOLGROUP Derivation Routine (VOLGPRTE)

The VOLGPRTE Derivation Routine is used to assign values to data element Volume Group (VOLGROUP).
micsrm140cd
The assigned values represent user-defined groups for tape volumes (real or virtual) that have similar characteristics.
The VOLGROUP data element is included as a summarization key in both the Tape Volume (TMCTMV) and Tape Data Set (TMCTMD) files. Assigning meaningful group names to ranges of tape volume serial numbers (VOLSER) can improve the usability of both files at higher timespans because each summarized record will contain metrics for each unique value of VOLGROUP. VOLGROUP can be assigned any character value up to sixteen bytes in length.
VOLGPRTE is found in prefix.MICS.PARMS. If the TLM component is installed in multiple units, a VOLGPRTE routine must be coded for each unit.
Blanks are initially assigned to data element VOLGROUP. After this initial assignment, the VOLGPRTE routine is invoked.

Coding Tips

  • If no user code is added to VOLGPRTE, all tape data sets and volumes in the
    MICS database
    will have a blank value in the VOLGROUP data element.
  • If user code is added to VOLGPRTE but any observations still contain blanks in the VOLGROUP data element, the logic and assignment statements in VOLGPRTE did not override the initial value.
  • The VOLGPRTE routine is entered once per tape data file. For tape volumes containing multiple data sets, the VOLGPRTE routine is invoked multiple times.
  • The best practice is to assign the VOLGROUP data element value based on tape volume level information. Tape volume level metrics are the data elements found in the Tape Volume (TMCTMV) file, and might also exist in the Tape Data set (TMCTMD) file.
    Follow this best practice to be certain that all data sets on a tape volume are assigned to the same VOLGROUP. There are cases where the corresponding volume level data element is not yet assigned from the TMD data element, so the TMD data element must be used in the logic to assign VOLGROUP.
    If data set level metrics are used to assign the value of VOLGROUP, the potential exists to assign different VOLGROUP values to each data set on tape volumes containing multiple data sets. Tape data set level metrics are the data elements found in the Tape Data Set (TMCTMD) file. If TMCTMD file data elements are used to determine the VOLGROUP data element value, the VOLGROUP data element value on the volume level observation (TMCTMV file) will be derived from the last data set on the volume.
  • The following are some suggested elements that can be used to derive VOLGROUP:
    ALL
    • STORMGTC - SMS Management Class
    • TMDUSER - User Data
    • TMVACTVL - Actual Volser of Tape
    • ACTUAL - Actual Volser In Use Indicator (TMVACTUL)
    • TMVVENDR - Media Vendor
    • VOLSER - Volume Serial Number
    • TMVWORM - WORM Volume Count
    • TMDDEN - Recording Density
    • TMDTRTCH - Data Set Recording Technique
    CA 1
    • TMVSRVIN - Service Status
    • TMDCPUID - Creation System ID
    • TMDVOWNR - Volume Owner/EDM ID
    • TMVROBTY - Robot Device Type
    • TMVROBID - Robot Device Number
    • TMVAGENT - Tape Agent
    • TMDOUTLO - Location Id
    TLMS
    • TMVSRVIN - Service Status
    • STORSTGC - SMS Storage Class
    • STORDATC - SMS Data Class
    • TMDOUTLO - Location Id
    RMM
    • TMVCLOC - Current Location Name
    • TMVMEDTY - Volume Media Type
    • STORNAME - SMS Storage Group
    • STORSTGC - SMS Storage Class
    • STORDATC - SMS Data Class
    • TMVLUDEV - Last Used Drive
    • TMVMEDIN - Media Information
  • The flag variables CA1, TLMS, and RMM, are available to allow you to provide unique code for each tape management system processed. Here is an example:
    IF CA1 OR TLMS THEN DO; VOLGROUP = TMDOUTLO; /* OUT LOCATION */ END; ELSE IF RMM THEN DO; VOLGROUP = TMVCLOC; /* CURRENT LOCATION */ END;

VOLGPRTE Coding Example

This example demonstrates the benefit of using VOLGPRTE.
IF VOLSER eq: 'E' then VOLGROUP='EXTERNAL' ; ELSE IF 000001 LE VOLSER LE 018000 THEN VOLGROUP='SILO' ; ELSE IF VOLSER GE '018001' THEN VOLGROUP='VIRTUAL' ; ELSE VOLGROUP='OTHER';
This code specifies the following:
  • All tape volumes with volume serial numbers beginning with "E" belong to the EXTERNAL group.
  • Volume serial numbers not starting with "E" that are less than 018001 belong to the SILO group.
  • Volume serial numbers greater than 018001 are for virtual tape volumes and are assigned to the VIRTUAL group.
  • Volume serial numbers not meeting the above criteria are assigned to the OTHER group.
With this update to VOLGPRTE, the VOLGROUP summarization key will ensure that external, SILO, and virtual volumes are separated in the database files at summarized timespans.