Implementation Checklists (IWSz Server for AAI)

You implement an instance of the IWSz Server for AAI through the IMS. Use the ADD New Instance and CONFIGURE Instance Entry functions from the Main Instance Menu. Each function comprises several steps.

Note:

When you start the IMS to add the first instance of the IWSz Server for AAI, the IMS Functions Menu is bypassed and the ADD New Instance Entry function starts directly.

The following tables describe the ADD and CONFIGURE settings for implementing an instance. Fill in these check lists for each instance before starting its implementation.

ADD New Instance Entry

The ADD New Instance Entry function comprises the following steps:

Creating an instance.
Defining the scheduling system and AAI server that the instance will operate for.
Defining the menu number, description and color.
Allocating execution datasets for the instance. Use the values that you have obtained previously from your sizing exercise. For more information, see zFS Volume Sizing.

Creating and Instance

Task	Value
4 character Scheduler ID Use IWS/z Master Subsystem ID	Scheduler ID:
4 character LPAR ID Defaults to SMF ID value for LPAR but can be overridden to use any name. For example, SMF ID = SYS1 can be set to PROD. After multiple deployments to different LPARs, an LPAR selection screen appears.	LPAR name:
3-character AAI system name When the AAI system is installed, a 3-character ID is created. The default is AAI. The setting here can be that name or any other 3-character unique value. No check is made that this name matches the actual AAI system ID.	AAI name:
Menu Entry Settings Various values that determine which menu entry is used, the name that is displayed and what color values the entry will have.

Task

Value

4 character Scheduler ID

Use IWS/z Master Subsystem ID

Scheduler ID:

4 character LPAR ID

Defaults to SMF ID value for LPAR but can be overridden to use any name. For example, SMF ID = SYS1 can be set to PROD.

After multiple deployments to different LPARs, an LPAR selection screen appears.

LPAR name:

3-character AAI system name

When the AAI system is installed, a 3-character ID is created. The default is AAI.

The setting here can be that name or any other 3-character unique value. No check is made that this name matches the actual AAI system ID.

AAI name:

Menu Entry Settings

Various values that determine which menu entry is used, the name that is displayed and what color values the entry will have.

Allocating Execution Datasets

Task	Value
Assign the Instance Execution HLQ Default HLQ: Specifies an HLQ that will automatically have two additional levels included before each actual dataset suffix name is added: AIST yyyxlpar (where yyyx is a unique instance code and lpar is the LPAR ID) Override HLQ: This HLQ is used as is with just each actual dataset suffix name added. Ensure you use unique dataset names when creating multiple instances.	Instance Execution HLQ:
SMS Allocations: Dataset Locations Define the SMS Management Class to be used to allocate the Instance Execution datasets or leave blank for default values based on HLQ. Define the SMS Storage Class to be used to allocate the Instance Execution datasets or leave blank for default values based on HLQ. Define the SMS Data Class to be used to allocate the Instance Execution datasets or leave blank for default values based on HLQ.	SMS Management Class: SMS Storage Class: SMS Data Class:
Non-SMS allocations: Dataset Locations Define the specific Volume Serial Number to be used to create the Instance Execution datasets or leave blank for default values based on HLQ. Define the specific Unit Type to be used to create the Instance Execution datasets or leave blank for default values based on HLQ.	Volume Serial Number: Unit Type:
zFS Volume Definition The Override DSN value allows you to specify a different HLQ specifically for the zFS volume VSAM Cluster definition. If this is left blank the default name shown in yellow above the field will be used to define the VSAM Cluster, using the same Default HLQ previously specified The Primary space value sets the initial size of the zFS volume which will be created with the AGGRGROW attribute when it is formatted. This value should be set to the value calculated from the zFS Volume Sizing exercise earlier.	Primary / Secondary: Primary / Secondary: Primary / Secondary: Primary / Secondary: Primary / Secondary:

Task

Value

Assign the Instance Execution HLQ

Default HLQ:

Specifies an HLQ that will automatically have two additional levels included before each actual dataset suffix name is added:

AIST
yyyxlpar

(where yyyx is a unique instance code and lpar is the LPAR ID)

Override HLQ:

This HLQ is used as is with just each actual dataset suffix name added.

Ensure you use unique dataset names when creating multiple instances.

Instance Execution HLQ:

SMS Allocations: Dataset Locations

Define the SMS Management Class to be used to allocate the Instance Execution datasets or leave blank for default values based on HLQ.
Define the SMS Storage Class to be used to allocate the Instance Execution datasets or leave blank for default values based on HLQ.
Define the SMS Data Class to be used to allocate the Instance Execution datasets or leave blank for default values based on HLQ.

SMS Management Class:
SMS Storage Class:
SMS Data Class:

Non-SMS allocations: Dataset Locations

Define the specific Volume Serial Number to be used to create the Instance Execution datasets or leave blank for default values based on HLQ.
Define the specific Unit Type to be used to create the Instance Execution datasets or leave blank for default values based on HLQ.

Volume Serial Number:
Unit Type:

zFS Volume Definition

The Override DSN value allows you to specify a different HLQ specifically for the zFS volume VSAM Cluster definition. If this is left blank the default name shown in yellow above the field will be used to define the VSAM Cluster, using the same Default HLQ previously specified

The Primary space value sets the initial size of the zFS volume which will be created with the AGGRGROW attribute when it is formatted. This value should be set to the value calculated from the zFS Volume Sizing exercise earlier.

Primary / Secondary:
Primary / Secondary:
Primary / Secondary:
Primary / Secondary:
Primary / Secondary:

CONFIGURE IWSz Server for AAI Instance Entry

The CONFIGURE Instance Entry function comprises the following steps:

Configuring data delivery settings for the IWS Connector.
Configuring the Scheduler specifying various values that the Instance requires to generate the Data files.
Configuring the IWSz Server for AAI that defines various settings to control the execution of the Instance itself.

The CONFIGURE Instance Entry cannot be performed until the ADD New Instance Entry is completed and the execution datasets for the Instance have been allocated.

Task	Value
Configure Data Delivery: IP Adress Define the IP Address or DNS Name of the IWS Connector server.	IP Address:
Configure Data Delivery: Event and Definitions Data Path Specify the directory Path for the Events (Event, Current Plan and Track Log) files and the directory Path for the Definitions (Application/Operations and Periods/Calendars) files that have been defined on the IWS Connector Note: The AAI system allows this to be either two separate directories or a single common directory, but both values must be specified even if they are the same	Event files directory Path: Definition files directory Path:
Configure Data Delivery: User ID The User ID for the IWS Connector that will be used to make the Data Delivery connection whether using SFTP or FTP/FTPS methods.	IWS Connector User ID:
Configure Data Delivery: Delivery Method Enter one of the permitted values of SFTP, FTP, FTPS or FTPR.	Delivery Method:
Configure Data Delivery: Password and Verify For FTP type Data Delivery methods, the password for the IWS Connector User ID may need to be specified. If required, enter the value twice in the Password and Verify fields to ensure no mis-keying of the value. These fields can be left blank if no password is required	IWS Connector Password:
Configure Data Delivery: Override Port For FTP type Data Delivery methods, the default port number is 21. If you decide to change it for security reasons, enter the override port number in this field. If you leave it blank, port number 21 is used.	Port number:
Configure Data Delivery: SSL/TLS Config For FTPS/FTPR Data Delivery methods it is often necessary to reference an alternative FTP Configuration data file to the default /etc/ftp.dat file located in USS. While a specific version could be placed into the $HOME directory for use by the STC, generally an alternative file name is created at the system level in the /etc directory. When an alternative FTP Configuration file needs to be specified, use this field to define the alternative name.	FTP Configuration File Name:
Configure Scheduler: IWS Datasets These IWS dataset names are required to generate the names of the various data files needed by AAI. The Message Library is referenced by the EQQMLIB DD statement. The Checkpoint dataset is referenced by the EQQCKPT DD statement. The Parameter Library is referenced by the EQQPARM DD statement. The EQQBATCH parameter is required and it is the one referenced via the BATCHOPT DD statement. The EQQYCAIN Parameter is optional but may be used when generating the Current Plan data. If required, it is the one referenced by the EQQYPARM DD statement. The Track Log dataset is referenced by the EQQTROUT DD statement. The Job Tracking Archive dataset is referenced by the EQQJTARC DD statement.	Message Library : Checkpoint Dataset : Parameter Library : EQQBATCH Parameter Member : EQQYCAIN Parameter Member : Track Log Dataset : Job Tracking Archive Dataset :
Configure Scheduler: JTARC Logs Count Specifies the number of JTnn Job Tracking datasets that are being used by IWSz. These datasets are referenced by the EQQJTnn DD statements. This value can be between 01 and 99. It is assumed that the HLQ of the JTnn datasets is the same as the HLQ for the above JTARC dataset.	JTARC Logs Count:
Configure the IWSz Server for AAI: Automatic Delivery Determines whether the Primary STC will perform the generation of Definition Data automatically at the times specified in the following Run Time fields, or whether Definition Data generation and delivery will only occur when requested. The default is Y meaning that automatic Definition Data generation and delivery will occur at the times specified.	Automatic Delivery (Y/N)
Configure the IWSz Server for AAI: Automatic Delivery Run Times If the above Automatic Delivery is set to Y, then up to 10 different times of day can be specified in these fields. This tells the Primary STC to automatically start a Definition Data generation and delivery process. By default AAI will only process new Definition Data files once per day at 1AM server time. If Definition Data is requested more frequently in the IWSz Server for AAI, then the AAI setting must be modified to match. The generation and delivery of the Definition Data files can take some considerable time to execute. The run times specified here should account for the execution time to ensure that the process is completed before the time AAI is set to process those files.	Automatic Delivery Run Times:
Configure the IWSz Server for AAI: zFS Data Path All data files are generated directly into a USS directory before being transferred to the IWS Connector. When creating an Instance of the IWSz Server for AAI, a zFS volume was created. This defines the Data Generation path in USS that the zFS volume is mounted to The USS directory must have sufficient space to hold the largest data file that can be created, usually the track or defs files. For more information, see zFS Volume Sizing.	zFS DataPath:
Configure the IWSz Server for AAI: Create ERTA Extract Event Run Time Analysis (ERTA) can be used to provide a .csv format data file containing the execution elapsed time for each Cycle of Event Data generation.	Create ERTA Extract (Y/N)
Configure the IWSz Server for AAI: Extract Start Hour If the above ERTA Extract is selected then a .csv data file containing 24 hours’ worth of Event Data generation Cycles will be created. This 24 hour extract can start at any hour of the day as required. The default is midnight to midnight.	Extract Start Hour (HH):
Configure the IWSz Server for AAI: ERTA Delilvery Path If the above ERTA Extract is selected, then the 24 hour .csv format extract data file can be delivered automatically to a separate path on the IWS Connector server. This enables the daily generation of execution graphs based on this .csv data file	ERTA Delilvery Path:

Task

Value

Configure Data Delivery: IP Adress

Define the IP Address or DNS Name of the IWS Connector server.

IP Address:

Configure Data Delivery: Event and Definitions Data Path

Specify the directory Path for the Events (Event, Current Plan and Track Log) files and the directory Path for the Definitions (Application/Operations and Periods/Calendars) files that have been defined on the IWS Connector

Note: The AAI system allows this to be either two separate directories or a single common directory, but both values must be specified even if they are the same

Event files directory Path:

Definition files directory Path:

Configure Data Delivery: User ID

The User ID for the IWS Connector that will be used to make the Data Delivery connection whether using SFTP or FTP/FTPS methods.

IWS Connector User ID:

Configure Data Delivery: Delivery Method

Enter one of the permitted values of SFTP, FTP, FTPS or FTPR.

Delivery Method:

Configure Data Delivery: Password and Verify

For FTP type Data Delivery methods, the password for the IWS Connector User ID may need to be specified. If required, enter the value twice in the Password and Verify fields to ensure no mis-keying of the value. These fields can be left blank if no password is required

IWS Connector Password:

Configure Data Delivery: Override Port

For FTP type Data Delivery methods, the default port number is 21.

If you decide to change it for security reasons, enter the override port number in this field. If you leave it blank, port number 21 is used.

Port number:

Configure Data Delivery: SSL/TLS Config

For FTPS/FTPR Data Delivery methods it is often necessary to reference an alternative FTP Configuration data file to the default /etc/ftp.dat file located in USS.

While a specific version could be placed into the $HOME directory for use by the STC, generally an alternative file name is created at the system level in the /etc directory.

When an alternative FTP Configuration file needs to be specified, use this field to define the alternative name.

FTP Configuration File Name:

Configure Scheduler: IWS Datasets

These IWS dataset names are required to generate the names of the various data files needed by AAI.

The Message Library is referenced by the EQQMLIB DD statement.
The Checkpoint dataset is referenced by the EQQCKPT DD statement.
The Parameter Library is referenced by the EQQPARM DD statement.
The EQQBATCH parameter is required and it is the one referenced via the BATCHOPT DD statement.
The EQQYCAIN Parameter is optional but may be used when generating the Current Plan data. If required, it is the one referenced by the EQQYPARM DD statement.
The Track Log dataset is referenced by the EQQTROUT DD statement.
The Job Tracking Archive dataset is referenced by the EQQJTARC DD statement.

Message Library :

Checkpoint Dataset :

Parameter Library :

EQQBATCH Parameter Member :

EQQYCAIN Parameter Member :

Track Log Dataset :

Job Tracking Archive Dataset :

Configure Scheduler: JTARC Logs Count

Specifies the number of JTnn Job Tracking datasets that are being used by IWSz.

These datasets are referenced by the EQQJTnn DD statements.

This value can be between 01 and 99.

It is assumed that the HLQ of the JTnn datasets is the same as the HLQ for the above JTARC dataset.

JTARC Logs Count:

Configure the IWSz Server for AAI: Automatic Delivery

Determines whether the Primary STC will perform the generation of Definition Data automatically at the times specified in the following Run Time fields, or whether Definition Data generation and delivery will only occur when requested.

The default is Y meaning that automatic Definition Data generation and delivery will occur at the times specified.

Automatic Delivery (Y/N)

Configure the IWSz Server for AAI: Automatic Delivery Run Times

If the above Automatic Delivery is set to Y, then up to 10 different times of day can be specified in these fields. This tells the Primary STC to automatically start a Definition Data generation and delivery process.

By default AAI will only process new Definition Data files once per day at 1AM server time. If Definition Data is requested more frequently in the IWSz Server for AAI, then the AAI setting must be modified to match.

The generation and delivery of the Definition Data files can take some considerable time to execute. The run times specified here should account for the execution time to ensure that the process is completed before the time AAI is set to process those files.

Automatic Delivery Run Times:

Configure the IWSz Server for AAI: zFS Data Path

All data files are generated directly into a USS directory before being transferred to the IWS Connector. When creating an Instance of the IWSz Server for AAI, a zFS volume was created. This defines the Data Generation path in USS that the zFS volume is mounted to

The USS directory must have sufficient space to hold the largest data file that can be created, usually the track or defs files. For more information, see zFS Volume Sizing.

zFS DataPath:

Configure the IWSz Server for AAI: Create ERTA Extract

Event Run Time Analysis (ERTA) can be used to provide a .csv format data file containing the execution elapsed time for each Cycle of Event Data generation.

Create ERTA Extract (Y/N)

Configure the IWSz Server for AAI: Extract Start Hour

If the above ERTA Extract is selected then a .csv data file containing 24 hours’ worth of Event Data generation Cycles will be created. This 24 hour extract can start at any hour of the day as required. The default is midnight to midnight.

Extract Start Hour (HH):

Configure the IWSz Server for AAI: ERTA Delilvery Path

If the above ERTA Extract is selected, then the 24 hour .csv format extract data file can be delivered automatically to a separate path on the IWS Connector server. This enables the daily generation of execution graphs based on this .csv data file

ERTA Delilvery Path: