ISPW - Documentation Naming Conventions

Knowledge Article

ISPW - Documentation Naming Conventions
There are key elements that are very helpful and useful to Support when it comes to giving documentation files a name, before uploading them to a case.
BMC Compuware ISPW Base System
BMC Compuware ISPW Base System
All end users and / or ISPW Administrators that are trying to collect logs, outputs, inputs, etc... to try and diagnose or solve an ISPW Base issue.
BMC Compuware ISPW Base System
BMC Compuware ISPW Base System
All end users and / or ISPW Administrators that are trying to collect logs, outputs, inputs, etc... to try and diagnose or solve an ISPW Base issue.
Which ISPW - Documentation Naming Conventions should be used to assist in collecting ISPW Documentation files, in an efficient and accurate way? 

ISPW - Documentation Naming Conventions


There are key elements that are very helpful and useful to Support when it comes to giving documentation files a name, before uploading them to a case. 
  1. The ISPW relevant ‘name’ of the file, i.e. “CM Log”, “CT Log”, “SX Log” or an ISPW dataset – “ISPW PROD Site Library for CLISTs”.  Examples for incorporating these into your naming convention, are as follows:
CMLog
CTLog
SXLog
yourhlq.ISPW.SITE.PROD.CLIST
 
  1. A date and/or timestamp for when the file was collected, i.e. Dmmdd, or Dmmddyy or D.mmddyy.Thhmm.  When including time, using Military time format is best. 
yourhlq.CMLOG.D122122.T1402. …  
yourhlq.CTLOG.D1202.T0158. …
 
  1. Capture type, i.e. *.TRS for TERSE, or *.XMIT, or *.txt
yourhlq.SXLOG.D012422.TRS
yourhlq.RXLOG.D1015.T1631.XMIT
 
  1. Explain the scenario, i.e. “working example” or “not-working example”, or “test version” or “prod version”. 
CILOG.WORKING.D040722.TRS
CTLOG.TEST.BROKEN.D0821.T2002.XMIT

Since ISPW is a z/OS product and documentation may be copied to a z/OS environment for analysis, it is also good to make sure each qualifier is less than 8 characters, so that it follows z/OS naming rules. Be sure to have an ALPHA as the starting character for each qualifier as well. 

All of this helps support to immediately identify what type of documentation has been provided. It also helps to keep the files well organized, as they may be repeatedly referenced and reviewed during deeper analysis of the problem.  As well, sometimes multiple captures will be requested, and this is extremely helpful to keep track of different versions. 
 
BMC Compuware ISPW Base System
BMC Compuware ISPW Base System
All end users and / or ISPW Administrators that are trying to collect logs, outputs, inputs, etc... to try and diagnose or solve an ISPW Base issue.
Attachment(s):