The task is used to define an SMP/E Version definition.
The following table describes the task specific attributes for the task:
| Task Specific Attributes | ||
| Attribute | Description | Required |
| baseFmid | The name of the base, or primary, FMID for the version. An FMID definition with the same name must exist. The name of the primary FMID typically begins with an "H" rather than a "J" which is used for secondary functions. | Yes |
| baseFunction | The base function identifies the primary function for the version. A base function is optional. If not specified, the base function is set to the function of the first FMID in the FMID list with the base attribute set to true. If specified, a function definition with the same name must exist. | No |
| changeTeam | Identifies the primary change team that supports this version. A change team is optional. | No |
| componentId | Defines the unique 9-character, alphanumeric SMP/E component ID for the version. A component ID has the following format: | Yes |
| copyright | Specifies the default copyright text included in the ++FUNCTION statement generated for each FMID for the version. The copyright information here will be formatted prior to insertion into the SMP/E statement, each line will be indented two spaces and the entire text will be surrounded by the comment characters "/*" and "*/". The copyright specified here will be used as the default copyright for all FMIDs unless specific copyright information is defined for the FMID. | No |
| defaultFunction | Identifies the default function for the version. The default function is optional. If not specified, the default function is set to the the function of the first FMID in the FMID list. If specified, a function definition with the same name must exist. All parts that are not assigned to a specific function will be assigned to the default function and its FMID. | No |
| description | A free-form textual description of the SMP/E Version. The description may be used to specify detailed information about the version and its packaging configuration definition. | No |
| extendedService |
Specify true if this version is in "extended service" mode. Valid values are true and false. The default is false.
Note: Only one of extendedService, generallyAvailable, and outOfService may be set to |
No |
| generallyAvailable |
Specify true if this version is in "generally available" service mode. Valid values are true and false. The default is false.
Note: Only one of extendedService, generallyAvailable, and outOfService may be set to |
No |
| id | A unique identifier for the version. Any 1-4 character alphanumeric may be specified. This value is used as a short-hand reference for the version in various SMP/E Ant tasks and macros. | Yes |
| levelCreatedBy | The userid of the user that created this version. | No |
| levelStatus | The zService level status value for the version. The default is "CREATED". See zService documentation for valid values. | No |
| levelSupFile |
The fully-qualified path on the build system to the file which contains the level supersede information. The level supersede file should contain a list of blank-separated SYSMODs which should be superseded when this version is installed. This information is placed in the ++VER MCS statement SUP() operand.
Note: Both levelSupFile and levelSupList may be specified. |
No |
| levelSupList |
Specifies a blank-separated list of which SYSMODs should be superseded when this version is installed. This information is placed in the ++VER MCS statement SUP() operand.
Note: Both levelSupFile and levelSupList may be specified. |
No |
| levelType | The zService level type value for the version. The default is "RAW". See zService documentation for valid values. | No |
| name | A unique name for the version system definition item. | Yes |
| neverSup |
Specifies whether or not this version should never be superseded. Valid values are true and false. The default is false.
|
No |
| nonImpacting |
Specifies that changes to this system definition do not force Enterprise Extensions dependency build request processing to use full analysis instead of change set analysis. Valid values are true and false. The default is false.
|
No |
| outOfService |
Specify true if this version is in "out of service" service mode. Valid values are true and false. The default is false.
Note: Only one of extendedService, generallyAvailable, and outOfService may be set to |
No |
| releaseId | Defines a unique zService identifier for the version. Any 1-8 character alphanumeric may be coded. The value is used to identify the version in zService and may be used as a data set name qualifier. | Yes |
| singleFunction |
Specify true to indicate that this version has a single function and that only one FMID is allowed. Valid values are true and false. The default is false.
|
No |
| systemRelease | Defines the unique 4-character system release name to be placed in the ++VER record of all SYSMODs generated for the version. For example: Z038. | Yes |
| usermodPrefix | Defines a unique 2-character prefix that will be used to prefix internally generated USERMODs. These are typically used by products that provide new function and fixes to their test teams using SMP/E. | No |
The FMID element is specified within the element. The FMID Element is used to define a function modification identifier for the version. At least one FMID element is required. Specify a unique FMID Element for each function defined to the version. The following table describes the valid FMID Element attributes:
| FMID Element Attributes | ||
| Attribute | Description | Required |
| alias | Specifies a 7-character FMID alias. The alias can be used when testing the SMP/E packaging process to avoid updates to the actual SMP/E data for a product. | No |
| base |
Specifies whether or not this FMID is the base function. Valid values are true and false. The default is false.
|
No |
| description | A free-form textual description of the SMP/E FMID. The description may be used to specify detailed information about the FMID and its packaging configuration definition. | No |
| fesn | A unique 7-character Field Engineering Service Number for the FMID. This value is optional. | No |
| function | The function name for the FMID. The value is copied from the function definition for the FMID. This value is used as the FMID description in the MCS data. | Yes |
| ignore |
Specifies whether or not this FMID should be ignored during packaging. Valid values are true and false. The default is false. When true the ignore attribute indicates that the FMID is inactive and should not be considered when packaging the version.
|
No |
| initialRevision | The initial revision number for parts in this FMID. The default is 1.0. | No |
| jclinCallibs |
Specifies whether or not the SMP/E CALLIBS parameter should be generated. Valid values are true and false. The default is false. When true the JCLIN CALLLIBS attribute indicates that the CALLLIBS keyword should be added to the JCLIN element statement.
|
No |
| name | The unique 7-character name for the FMID. | Yes |
| nonImpacting |
Specifies that changes to this system definition do not force Enterprise Extensions dependency build request processing to use full analysis instead of change set analysis. Valid values are true and false. The default is false.
|
No |
| osPlatform |
The platform this FMID applies to. Valid values are: ZOS, VSE, and VM. Default is: ZOS.
|
No |
| scp |
The SCP flag indicates that the FMID is for a z/OS SCP-dependent product. This setting is used to determine the product code to use in SHIPPTF and EDC files. For functions that are part of z/OS SCP-dependent products, it is AS2. Otherwise, it is characters 2-4 of the FMID. Valid values are true and false. The default is false.
|
No |
The JCLIN element is specified within the FMID element. The JCLIN Element is a required element used to define JCLIN information for the FMID. A single JCLIN element is allowed. The following table describes the valid JCLIN Element attributes:
| JCLIN Element Attributes | ||
| Attribute | Description | Required |
| distlib | The distribution library data set. A data set definition of the same name must exist. | Yes |
| id | The name of the member in the JCLIN location library which contain the JCLIN. Must be 1-8 alphanumeric characters. | Yes |
| inSource |
The JCLIN inSource attribute indicates that the JCLIN member for this FMID is stored in source control and that the JCLIN distlib, id, and location attributes do not need to be specified. Valid values are true and false. The default is false.
|
No |
| location | The JCLIN location library data set which contains the JCLIN member. A data set definition of the same name must exist. | Yes |
The MCSCPYRT element is specified within the FMID element. The MCSCPYRT Element is an optional element used to define copyright information for the FMID. A single MCSCPYRT element is allowed and is required if no copyright information is defined with the <version> copyright attribute. The following table describes the valid MCSCPYRT Element attributes:
| MCSCPYRT Element Attributes | ||
| Attribute | Description | Required |
| id |
The name of the member in the MCSCPYRT location library which contain the copyright text. Must be 1-8 alphanumeric characters.
*Not required if text is specified. |
Yes* |
| location |
The MCSCPYRT location library data set which contains the MCSCPYRT member. A data set definition of the same name must exist.
*Not required if text is specified. |
Yes* |
| text |
The copyright text.
*Not required if id and location are specified. |
Yes* |
The MCSDEL element is specified within the FMID element. The MCSDEL Element is an optional element used to define MCS ++VER DELETE information for the FMID. A single MCSDEL element is allowed. The contents of the file or the text should be a list of FMIDs from past versions. Each FMID in the list may be separated with a comma or a blank. FMIDs may also be specified on separate lines.
The following table describes the valid MCSDEL Element attributes:
| MCSDEL Element Attributes | ||
| Attribute | Description | Required |
| file | The fully-qualified path on the build system to the file containing SMP/E DELETE SYSMOD information for the ++VER MCS for this function. | No |
| text | The text containing SMP/E DELETE SYSMOD information for the ++VER MCS for this function. | No |
The MCSNPR element is specified within the FMID element. The MCSNPR Element is an optional element used to define MCS ++VER NPRE information for the FMID. A single MCSNPR element is allowed. The contents of the file or the text should be a list of FMIDs from past versions. Each FMID in the list may be separated with a comma or a blank. FMIDs may also be specified on separate lines.
The following table describes the valid MCSNPR Element attributes:
| MCSNPR Element Attributes | ||
| Attribute | Description | Required |
| file | The fully-qualified path on the build system to the file containing SMP/E NPRE SYSMOD information for the ++VER MCS for this function. | No |
| text | The text containing SMP/E NPRE SYSMOD information for the ++VER MCS for this function. | No |
The MCSPRE element is specified within the FMID element. The MCSPRE Element is an optional element used to define MCS ++VER PRE information for the FMID. A single MCSPRE element is allowed. The contents of the file or the text should be a list of FMIDs from past versions. Each FMID in the list may be separated with a comma or a blank. FMIDs may also be specified on separate lines.
The following table describes the valid MCSPRE Element attributes:
| MCSPRE Element Attributes | ||
| Attribute | Description | Required |
| file | The fully-qualified path on the build system to the file containing SMP/E PRE SYSMOD information for the ++VER MCS for this function. | No |
| text | The text containing SMP/E PRE SYSMOD information for the ++VER MCS for this function. | No |
The MCSREQ element is specified within the FMID element. The MCSREQ Element is an optional element used to define MCS ++VER REQ information for the FMID. A single MCSREQ element is allowed. The contents of the file or the text should be a list of FMIDs from past versions. Each FMID in the list may be separated with a comma or a blank. FMIDs may also be specified on separate lines.
The following table describes the valid MCSREQ Element attributes:
| MCSREQ Element Attributes | ||
| Attribute | Description | Required |
| file | The fully-qualified path on the build system to the file containing SMP/E REQ SYSMOD information for the ++VER MCS for this function. | No |
| text | The text containing SMP/E REQ SYSMOD information for the ++VER MCS for this function. | No |
The MCSREQ element is specified within the FMID element. The MCSSUP Element is an optional element used to define MCS ++VER SUP information for the FMID. A single MCSSUP element is allowed. The contents of the file or the text should be a list of FMIDs from past versions. Each FMID in the list may be separated with a comma or a blank. FMIDs may also be specified on separate lines.
The following table describes the valid MCSSUP Element attributes:
| MCSSUP Element Attributes | ||
| Attribute | Description | Required |
| file | The fully-qualified path on the build system to the file containing SMP/E SUP SYSMOD information for the ++VER MCS for this function. | No |
| text | The text containing SMP/E SUP SYSMOD information for the ++VER MCS for this function. | No |
The MCSVER element is specified within the FMID element. The MCSVER Element is an optional element used to define MCS ++VER VERSION information for the FMID. A single MCSVER element is allowed. The contents of the file or the text should be a list of FMIDs from past versions. Each FMID in the list may be separated with a comma or a blank. FMIDs may also be specified on separate lines.
The following table describes the valid MCSVER Element attributes:
| MCSVER Element Attributes | ||
| Attribute | Description | Required |
| file | The fully-qualified path on the build system to the file containing SMP/E VERSION SYSMOD information for the ++VER MCS for this function. | No |
| text | The text containing SMP/E VERSION SYSMOD information for the ++VER MCS for this function. | No |
The RELFILE element is specified within the FMID element. The RELFILE Element is a required element used to define a RELFILE for the FMID. Specify a unique RELFILE Element for each RELFILE needed by the FMID. The order of the RELFILE elements determines the order of the resulting RELFILES (1 to n). The following table describes the valid RELFILE Element attributes:
| RELFILE Element Attributes | ||
| Attribute | Description | Required |
| dsdef | The data set definition name. A data set definition of the same name must exist. | Yes |
The Scoped Property Element element is specified within the element. The Scoped Property Element is an optional element used to define scoped build properties for the version. Specify a unique Scoped Property Element for each scoped build property defined to the version. The following table describes the valid Scoped Property Element attributes:
| Scoped Property Element Attributes | ||
| Attribute | Description | Required |
| condition | The Ant condition string, written in escaped XML, that must evaluate to true for the property to be available at runtime. | No |
| name | The name of the property. | Yes |
| value | The value of the property value. | No |
Create version definition:
<target description="Create version definitions" name="versdefs">
<sd:version name="IMSV14"
description="IMS Version 14"
nonImpacting="true"
baseFmid="HMK1400"
baseFunction="IMS System Services"
componentId="5635A0500"
copyright="${version_copyright}"
defaultFunction="IMS Database Manager"
id="141"
releaseId="HMK1400P"
systemRelease="P115"
usermodPrefix="IM"
extendedService="false"
generallyAvailable="true"
outOfService="false"
singleFunction="false">
<sd:fmid name="HMK1400" alias="DVK1400"
description="HMK1400 FMID for IMS Version 14"
nonImpacting="true"
function="IMS System Services"
base="true"
ignore="false"
initialRevision="1.0"
osPlatform="ZOS"
rfdsnpfx="IBM">
<sd:jclin id="hmk1400" distlib="zdatasetDlib.JCLIN" location="zfolder.JCLIN"/>
<sd:mcscpyrt text="${fmid_copyright}"/>
<sd:mcsdel file="delFile.hmk1400.txt" text="text"/>
<sd:mcsnpr file="nprFile.hmk1400.txt" text="text"/>
<sd:mcspre file="preFile.hmk1400.txt" text="text"/>
<sd:mcsreq file="reqFile.hmk1400.txt" text="text"/>
<sd:mcssup file="supFile.hmk1400.txt" text="text"/>
<sd:mcsver file="verFile.hmk1400.txt" text="text"/>
<sd:relfile dsdef="zdatasetDlib.JCLIN"/>
<sd:relfile dsdef="zdatasetDlib.ADFSLOAD"/>
<sd:relfile dsdef="zdatasetDlib.ADFSMAC"/>
<sd:relfile dsdef="zdatasetDlib.ADFSSRC"/>
</sd:fmid>
...
<sd:scopedProperty name="unconditional" value="value1"/>
<sd:scopedProperty name="conditional" value="value2" condition="<isset property="cond"/>"/>
</sd:version>
</target>
EWM version definitions: