Automating an Instance of the CA7 Server for AAI

Automating the start up and shutdown of the CA7 Server for AAI is a best practice for most situations as it is generally a more practical approach to these tasks. This topic provides instructions and guidelines for automating start up and shutdown, and it describes the console messages generated by the CA7 Server for AAI during these events. For information about manual start up and shutdown, see Manually Managing an Instance of the CA7 Server for AAI.

Understanding Console Messages for the CA7 Server for AAI

All console messages related to the CA7 Server for AAI have the following format:

+AI7.ZZZZZ:YYYX <message text>, where:

• +AI = the standard prefix for all AAI messages

• 7 = the indicator that this is an CA7 scheduler type

• zzzzz = the 5-character message ID number

• yyyx = the unique instance code

• <message text> = the message content

All console messages are issued using the TSO SEND command.

Automating Start Up of the CA7 Server for AAI

To automatically start the CA7 Server for AAI, use the primary STC based on yourHLQ.CUSTLIB member AI7Syyyx, where yyyx is the unique code for the instance.

It is recommended to automatically start the CA7 Server for AAI primary STC at IPL time. The STC should remain active at all times to maintain status synchronicity between CA7 and AAI.

Console Messages on Start Up

When the CA7 Server for AAI primary STC starts successfully, the following console message is displayed to confirm it:

+AI7.SCN1I: YYYX CA 7 Server for AAI now active on DD MMM YYYY at HH:MM:SS

If errors occur during the initialization or configuration settings during start up, the CA7 Server for AAI terminates with the following console message:

+AI7.SCN7S: YYYX CA 7 Server for AAI has failed on DD MMM YYYY at HH:MM:SS

Automating Shutdown of the CA7 Server for AAI

You use the yourHLQ.CUSTLIB member AI7Kyyyx for automating the shutdown of a CA7 Server for AAI instance. Automating shutdown can be more practical than shutting down manually from the ISPF interface. Please note that you must customize AI7Kyyyx before it can be used.

Preparation: Customizing the AI7Kyyyx

Before you can use the AI7Kyyyx member for the first time, modify the JCL in two places as follows:

• On the WAIT step, ensure that the sleep time is adequate to allow CA7 Server for AAI to shut down gracefully. It is recommended to set the sleep time to AI7CYCL plus 90 seconds.

• On the RMLOCK step, make sure that the USS path name and the server lock file name are correct.

Using automatic shut down

To automatically shutdown the CA7 Server for AAI, use the secondary STC based on yourHLQ.CUSTLIB member AI7Kyyyx, where yyyx is the unique code for the instance.

Console Messages on Shutdown

When the CA7 Server for AAI primary STC is shut down, either automatically or manually, the following console message is displayed to confirm it:

+AI7.SCN6I: YYYX CA 7 Server for AAI terminated on DD MMM YYYY at HH:MM:SS

Additional Steps for Instances Prior to Version 24.2.0

If you have upgraded to version 24.2.0 or later and have instances defined in a prior version, the AI7Kyyyx member, which you need to automate the shutdown, will not exist. You need to create an AI7Kyyyx member for the existing instances. To do this, use the following steps:

1. For the instance for which you want to generate an AI7Kyyyx member go to the CUSTLIB library.

2. To protect existing JCL members from being overridden in a later step, rename the following JCL members, and make sure to note the original and renamed names.

   • AI7Lyyyx

   • AI7Myyyx

   • AI7Pyyyx

   • AI7Ryyyx

   • AI7Syyyx

   • AI7Tyyyx

3. Open the IMS SPIF panels (ex AITCPRIM) and type 'U' (for update) next to the instance and press enter.

4. Select G - GENERATE Instance JCL and press enter.

5. Exit all the way out of IMS ISPF panels.

6. Go back into the CUSTLIB library, where you should see the AI7Kyyyx member for your instance.

   You will also see the newly generated members with same names as the list in Step 2.

7. Delete the newly generated members and then change the renamed members in Step 2 back to their original names.

Server Errors

The CA7 Server for AAI is extremely robust and will not generally fail unless in case of catastrophic errors. However, it traps certain error conditions and attempts to work around them to continue processing while trying to recover data that has not been delivered. The CA7 Server for AAI traps the following errors:

• Various FTP/SFTP connection failures when trying to deliver data

• Failure during event data report creation

• Failure to start the separate child processes

• Failure to deliver a report

In all cases, it makes various retry attempts. If these attempts do not solve the problem, it will still attempt to continue.

To make you aware that such errors are happening, the CA7 Server for AAI issues console messages that can be captured by your automation processes. You can then set up the appropriate actions to alert on the failures.

+AI7.SCN2E: YYYX CA 7 Server for AAI Event Data Delivery failed - Continuing

+AI7.SCN3E: YYYX CA 7 Event Data generation failed RC=nnnn - Continuing

+AI7.SCN4E: YYYX CA 7 Server for AAI Definition Data Spawn failure - errno=nnnnnn

+AI7.ACN1E: YYYX Definition Data Delivery failed on DD MMM YYYY at HH:MM:SS

+AI7.SCN5E: YYYX ???? Definition Data Delivery Request failure - Review LOGS

The ???? in the last console message specifies the type of definition data request that has failed. This could have any of the following values:

• ADEF - ALL Definition Data Delivery Request

• DDEF - LDSN Definition Data Delivery Request

• JDEF - LJOB Definition Data Delivery Request

• SDEF - SCAL Definition Data Delivery Request

See also:

• Implementing an Instance of the CA7 Server for AAI

• Configuring an Instance of the CA7 Server for AAI

• Manually Managing an Instance of the CA7 Server for AAI