CA Workload Automation Agent for HP Integrity

CA Workload Automation
Agent for HP Integrity NonStop
Release Notes
r11.3.4
This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to
as the “Documentation”) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This
Documentation is proprietary information of CA and may not be copied, transferred, reproduced, disclosed, modified or
duplicated, in whole or in part, without the prior written consent of CA.
If you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make
available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with
that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.
The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable
license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to
certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY
KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE,
DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST
INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE
POSSIBILITY OF SUCH LOSS OR DAMAGE.
The use of any software product referenced in the Documentation is governed by the applicable license agreement and such
license agreement is not modified in any way by the terms of this notice.
The manufacturer of this Documentation is CA.
Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions
set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or
their successors.
Copyright © 2014 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to
their respective companies.
CA Technologies Product References
This document references the following CA Technologies products:
■
CA Network and Systems Management (CA NSM)
■
CA Universal Job Management Agent (CA UJMA)
■
CA Workload Automation Agent for HP Integrity NonStop (CA WA Agent for HP
Integrity NonStop), formerly Tandem NSK
■
CA Workload Automation AE
■
CA Workload Automation ESP Edition
■
CA Workload Automation CA 7 Edition
■
CA Workload Control Center (CA WCC)
■
CA Service Desk Manager (CA SDM)
Contact CA Technologies
Contact CA Support
For your convenience, CA Technologies provides one site where you can access the
information that you need for your Home Office, Small Business, and Enterprise CA
Technologies products. At http://ca.com/support, you can access the following
resources:
■
Online and telephone contact information for technical assistance and customer
services
■
Information about user communities and forums
■
Product and documentation downloads
■
CA Support policies and guidelines
■
Other helpful resources appropriate for your product
Providing Feedback About Product Documentation
If you have comments or questions about CA Technologies product documentation, you
can send a message to techpubs@ca.com.
To provide feedback about CA Technologies product documentation, complete our
short customer survey which is available on the CA Support website at
http://ca.com/docs.
Contents
Chapter 1: Welcome
7
Upgrading the Agent to r11.3.4 ................................................................................................................................... 7
Upgrade the Agent to r11.3.4 on NonStop ........................................................................................................... 8
Uninstall a Patch ................................................................................................................................................. 10
Chapter 2: New Features
11
ASSIGN, PARAM, and DEFINE Command Options for HP Integrity NonStop ............................................................. 11
File Monitoring ........................................................................................................................................................... 11
Logging and Tracing.................................................................................................................................................... 12
Spool Files Retrieval ................................................................................................................................................... 12
Standard Streams ....................................................................................................................................................... 12
Chapter 3: Known Issues
13
Agent Responds if Ending Double Quotes are Missing .............................................................................................. 13
Agent Sends Syntax Error When an Invalid Keyword is Entered After a Valid Keyword ............................................ 13
Agent Truncates PARAM Messages ........................................................................................................................... 13
ASSIGN Logical Filenames Limited to 31 Characters .................................................................................................. 13
Customized TCP/IP Related DEFINEs are Removed When the Agent Starts .............................................................. 14
Chapter 4: Fixed Issues
15
Agent Does Not Support Exit Codes ........................................................................................................................... 15
Job Submission Error When AUTORUN Exceeds 9999 ............................................................................................... 15
Agent Excessively Accesses a Temporary Checkpoint File ......................................................................................... 16
Agent Debug Messages Written to EMS Log.............................................................................................................. 16
Chapter 5: Supported Systems and Requirements
17
System Requirements ................................................................................................................................................ 17
Hardware Requirements ..................................................................................................................................... 17
Software Requirements ...................................................................................................................................... 17
Supported Platforms .................................................................................................................................................. 17
Chapter 6: Related Documentation
19
CAUNI.CAOPTS File ..................................................................................................................................................... 19
EVENT-CHECK-INTERVAL—Specify the Sleeping Interval for Checking Job Status Messages .................................... 21
Contents 5
Appendix A: Using the Agent to Schedule Jobs
23
Migrating from CA UJMA on CA Workload Automation AE ....................................................................................... 23
ASSIGN........................................................................................................................................................................ 24
PARAM ....................................................................................................................................................................... 27
DEFINE ........................................................................................................................................................................ 29
Multiple Commands ................................................................................................................................................... 33
6 Release Notes
Chapter 1: Welcome
Welcome to CA Workload Automation Agent for HP Integrity NonStop. This document
includes information about changes to existing features, a complete list of fixed issues,
supported platform information and system requirements, and known issues for this
release, if any. Relevant documentation may also be included for significant fixes or
changes.
For the latest version of the 11.3 agent documentation including these Release Notes,
visit the following link:
https://supportcontent.ca.com/cadocs/0/CA%20Workload%20Automation%20System%
20Agent%20r11%203-ENU/Bookshelf.html
Upgrading the Agent to r11.3.4
If you are using CA Workload Automation Agent for HP Integrity NonStop r11.3.1 or
higher, you can upgrade to r11.3.4 using a patch. To apply the r11.3.4 patch, use the
INSPATCH script. The INSPATCH script provides the same fixes and features as the full
installer.
Note: For information about installing CA Workload Automation Agent for HP Integrity
NonStop using the full installer, see the Implementation Guide.
Before running the INSPATCH script, you need the following information:
■
Volume where CA Workload Automation Agent for HP Integrity NonStop is
installed.
■
Volume that will be used as a working volume for the patch installation script.
■
PTF ID/RO number, which is usually the last five digits of the PTF file name. For
example, for PTF RO71170, the PTF ID is 71170.
■
Login ID and password of the super.super user.
You can find the latest CA Workload Automation Agent solutions and patches on CA
Support Online:
http://www.ca.com/us/support/ca-support-online/product-content/recommended-rea
ding/technical-document-index/ca-workload-automation-agent-solutions-and-patches.a
spx?
Chapter 1: Welcome 7
Upgrading the Agent to r11.3.4
Upgrade the Agent to r11.3.4 on NonStop
If you are using CA WA Agent for HP Integrity NonStop r11.3.1 or higher, you can
upgrade to r11.3.4 using a patch.
Follow these steps:
1.
Download the ROxxxxx and ROxxxxx.txt files from CA Support Online, where xxxxx is
the PTF ID/RO number.
2.
Transfer the ROxxxxx file to the NonStop system. If you are using FTP, verify that
the file is transferred using binary mode. You can use the following FTP instructions
or can use your own preferred file transfer method.
a.
Open a DOS session in the directory where the files reside.
b.
Initiate an FTP session using the following command:
ftp host_address
host_address
Specifies the IP address or host name of the NonStop server where the
agent is installed.
c.
Enter the NonStop user ID and password when prompted.
d.
Transfer the files to the NonStop server using the following commands:
cd $volume.ROxxxxx
prompt
binary
put ROxxxxx
bye
volume
Specifies the volume where you want to keep a copy of this ROxxxxx file.
Note: Do not use the volume where the agent is installed.
ROxxxxx
Specifies the PTF that you downloaded.
3.
Log in to the NonStop server where the agent is installed.
Note: Verify that you are logged on as the user that owns the agent where the PTF
is being applied.
8 Release Notes
Upgrading the Agent to r11.3.4
4.
Run the following command:
v $volume.ROxxxxx
volume
Specifies the volume where you transferred the ROxxxxx file in Step 2.
Note: Do not use the volume where the agent is installed.
ROxxxxx
Specifies the PTF that you downloaded.
5.
Verify that the file code of the ROxxxxx file is set to 1729 using the following
command:
FUP INFO ROxxxxx
Note: If the file code is not set to 1729, change the file code using the following
command:
FUP ALTER ROxxxxx,CODE 1729
6.
Unpack the PTF files using the following command:
unpak ROxxxxx, *.*.*, vol $volume
7.
List all the unpacked files using the following command:
fi $volume.ROxxxxx
The patch contains at least the following files:
8.
■
CAWAGPAK — PAK file that contains the changed binaries for G-series
■
CAWAHPAK — PAK file that contains the changed binaries for H- and J-series
■
INSPATCH — Patch installation script
■
DOCxxxxx — Text file that contains the problem description
■
LSTxxxxx — List of files that are being modified in this patch
■
OBJxxxxx — Internal file for the patch installation
■
RMExxxxx — Readme file
Run the INSPATCH script in the same location where the files are unpacked using
the following command:
> RUN INSPATCH xxxxx
xxxxx
Specifies the PTF ID/RO number. For example, to apply PTF RO71170, specify
71170.
INSPATCH is a TACL macro that applies the PTF to your Workload Automation Agent
environment as determined by the define variable =OPTFILENAME.
Note: If =OPTFILENAME is not defined for your current TACL session or it does not
specify the correct location, you can set it using the macro.
Chapter 1: Welcome 9
Upgrading the Agent to r11.3.4
9.
Choose option I (<I>nstall) to install the PTF when prompted.
The INSPATCH macro validates the patch and then replaces the appropriate
libraries/executables. The previous versions of the libraries/executables are saved
to a backup location that you can use to backout the PTF in the future. If the backup
files are not needed, you can manually remove them.
10. Review the RMExxxxx file for any required post-installation steps. If a cold start is
necessary, run the following commands:
volume $volume
purge CAAFMLOG.*
purge CAWLACFG.*
purge CATRACE.*
purge CAOPRLOG.*
purge CAUNIEXE.SPOOLMAP
purge CAOPRCFG.*
unistart all
Uninstall a Patch
If you updated the agent using the patch installer, you can manually uninstall the most
recent patch update. After you uninstall the patch, the agent reverts to the previous
version.
Follow these steps:
1.
Run the INSPATCH script in the same location where the files are unpacked using
the following command:
> RUN INSPATCH xxxxx
xxxxx
Specifies the PTF ID/RO number. For example, to uninstall PTF RO71170,
specify 71170.
2.
10 Release Notes
Choose option R (<R>emove) to uninstall the PTF when prompted.
Chapter 2: New Features
This section contains the following topics:
ASSIGN, PARAM, and DEFINE Command Options for HP Integrity NonStop (see page 11)
File Monitoring (see page 11)
Logging and Tracing (see page 12)
Spool Files Retrieval (see page 12)
Standard Streams (see page 12)
ASSIGN, PARAM, and DEFINE Command Options for HP
Integrity NonStop
The new ASSIGN, PARAM, and DEFINE command options for HP Integrity NonStop are
used to pass specific values to scripts, programs, and commands that the agent executes
on behalf of the CA Workload Automation scheduling managers. The ability to pass
these command parameters enhances the agent’s capability to reference and use
system resources within the HP Integrity NonStop environment.
The implementation of the ASSIGN, PARAM, and DEFINE command options varies
depending on the scheduling manager.
Note: For more information about using these command options, see the
documentation for your scheduling manager.
File Monitoring
You can now define a File Monitoring job to monitor file activity for HP Integrity
NonStop systems. The File Monitoring job can monitor when a file is created or
updated.
Notes:
■
The CA WA Agent for HP Integrity NonStop does not support event-level triggers
and wildcards in file triggers.
■
For more information about monitoring file activity, see the documentation for
your scheduling manager.
Chapter 2: New Features 11
Logging and Tracing
Logging and Tracing
Logging has been added to the agent to provide information about scheduled jobs. Logs
must be cleared periodically to maintain disk space availability. The agent supports log
file maintenance through an automatic log file rollover.
Function-level logging is stored in the EMS disk files. All errors and warnings are logged
in the log file’s EMS log systems.
You can record the function-level traces of process when communication between the
agent and scheduling manager has failed. The agent logs all incoming and outgoing
messages in separate disk files and supports the per-process disk file tracing.
Note: For more information about logging and tracing, see the Implementation Guide.
Spool Files Retrieval
The agent generates spool files to store workload data. Spool file retrieval extracts spool
file contents for a particular job from an agent whenever requested by a scheduling
manager.
Notes:
■
For more information about spool file retrieval, see the Implementation Guide.
■
You must set the WLA-PASSW-REQUIRED environment variable to N when working
with CA Workload Automation AE for spool file retrieval to work properly.
Standard Streams
Standard streams are pre-connected input and output channels between an application
and its environment that exchange data when the application is running.
Note: For more information about standard streams, see the Implementation Guide.
12 Release Notes
Chapter 3: Known Issues
The chapter details the known issues in CA WA Agent for HP Integrity NonStop r11.3.4.
This section contains the following topics:
Agent Responds if Ending Double Quotes are Missing (see page 13)
Agent Sends Syntax Error When an Invalid Keyword is Entered After a Valid Keyword
(see page 13)
Agent Truncates PARAM Messages (see page 13)
ASSIGN Logical Filenames Limited to 31 Characters (see page 13)
Customized TCP/IP Related DEFINEs are Removed When the Agent Starts (see page 14)
Agent Responds if Ending Double Quotes are Missing
A series of error messages are displayed when the agent responds to specific
combinations of the invalid AFM messages if ending double quotes are missing.
Agent Sends Syntax Error When an Invalid Keyword is Entered
After a Valid Keyword
When an invalid keyword is entered after a valid keyword in an AFM message, the agent
does not ignore the message and sends a syntax error.
Agent Truncates PARAM Messages
The agent truncates the PARAM messages in a job which consists of duplicate
param_name entries.
ASSIGN Logical Filenames Limited to 31 Characters
The limits of the ASSIGN logical filename is 32 characters on the HP Integrity Nonstop
system. But, the agent limits the length to 31 characters. If you send a job with a 32
characters ASSIGN logical filename, the following message is displayed:
ASSIGN logical file name is too long.
Chapter 3: Known Issues 13
Customized TCP/IP Related DEFINEs are Removed When the Agent Starts
Customized TCP/IP Related DEFINEs are Removed When the
Agent Starts
When you run the agent startup script using non-default values, a few TCP/IP-related
DEFINEs may be removed. For example, if you have a TCPIP^PROCESS^NAME defined in
$SYSTEM.SYSTEM.TACLLOCL. When you start the agent, the TCPIP^PROCESS^NAME
DEFINE is removed.
The impact is:
■
The TACL session that starts the agent is not able to run the network-related
command or program if the command or program expects customized DEFINEs. As
a workaround, close the current TACL session and log in again.
■
If a command or program that runs inside an agent job expects customized
DEFINEs, the job fails. For example, if you run a ping command in the job, the ping
job fails with Guardian error 14, “Name does not resolve to supplied parameters",
or another network-related error. As a workaround, create a TACL macro to wrap
the command or program in and run it.
The DEFINEs involved are:
14 Release Notes
■
TCPIP^HOST^FILE
■
TCPIP^PROCESS^NAME
■
TCPIP^SERVICE^FILE
■
TCPIP^RESOLVER^NAME
Chapter 4: Fixed Issues
The chapter details the issues that have been fixed in CA WA Agent for HP Integrity
NonStop r11.3.4.
This section contains the following topics:
Agent Does Not Support Exit Codes (see page 15)
Job Submission Error When AUTORUN Exceeds 9999 (see page 15)
Agent Excessively Accesses a Temporary Checkpoint File (see page 16)
Agent Debug Messages Written to EMS Log (see page 16)
Agent Does Not Support Exit Codes
Problem record: SYSAGT-171
The exit codes that are specified in the job definition do not take effect. For example, on
CA Workload Automation AE, the max_exit_success attribute specifies the maximum
exit code the job can finish with and still be considered successful. In this issue, a
maximum exit code of 5 was specified in the job definition. However, the job failed
when the exit code was 3.
This issue has been fixed. CA WA Agent for HP Integrity NonStop now supports the same
functionality as other agent platforms for exit codes.
Job Submission Error When AUTORUN Exceeds 9999
Problem record: SYSAGT-161
On CA Workload Automation AE, the AUTORUN environment variable contains the job
run number. The run number is a unique integer that is associated with every run of a
job. When the AUTORUN variable exceeds 9999, CA WA Agent for HP Integrity NonStop
refuses to process the job. A submission error is reported with the following status:
Value of AUTO_JOB_NAME or AUTORUN too long
This issue has been fixed.
Chapter 4: Fixed Issues 15
Agent Excessively Accesses a Temporary Checkpoint File
Agent Excessively Accesses a Temporary Checkpoint File
Problem record: SYSAGT-142
When checking the status of a job, the agent excessively reads a temporary checkpoint
file on the NonStop system. If you are auditing all access to files, the system can
generate excessive audit information.
To address this issue, the following environment variable was introduced in the
CAUNI.CAOPTS file:
EVENT-CHECK-INTERVAL: seconds
seconds
Specifies how often the agent checks the job status messages in seconds. Increasing
the value of this variable reduces the number of reads the agent does. However,
the bigger the value, the more latency that is added on before the agent sends job
execution messages back to the scheduling manager.
Default: 1 (every second)
Note: EVENT-CHECK-INTERVAL should only be modified under the direction of CA
Technologies Technical Support.
Agent Debug Messages Written to EMS Log
Problem record: SYSAGT-141
On NonStop systems, the Event Management Subsystem (EMS) monitors the health of
the operating system and all the subsystems that make up a NonStop server. The agent
writes debug messages to the EMS log, which can overflow the system logging facility,
causing a high rate of log file recycles.
In this fix, the agent suppresses the debug messages from the EMS log. The messages
are still visible if the CAI-CCI-DEBUG variable in the CAOPTS file is set to Y. When the
CAI-CCI-DEBUG variable is set to Y, the messages are written to the RMhhmmss log file
(where hh=hours, mm=minutes, ss=seconds). The log file is located in the subvolume
(disk) set by the CAI-TRACE-SUBVOL option in the CAOPTS file. By default, the value of
the CAI-TRACE-SUBVOL option is set to CATRACE.
Note: For more information about the CAI-CCI-DEBUG and CAI-TRACE-SUBVOL variables,
see the Implementation Guide.
16 Release Notes
Chapter 5: Supported Systems and
Requirements
This section contains the following topics:
System Requirements (see page 17)
Supported Platforms (see page 17)
System Requirements
Hardware Requirements
To run the CA WA Agent for HP Integrity NonStop on your HP Integrity NonStop server,
the following must be available:
■
Support for G-Series, H-Series, and J-Series (Itanium) systems.
■
At least 90 MB of free disk space for the agent installation.
■
A LAN controller capable of supporting TCP/IP.
Software Requirements
To run CA WA Agent for HP Integrity NonStop on an HP Integrity NonStop server, the
NonStop Kernel Version G06.29.02, H06.15, J06.13.0, or later software must be running
and correctly configured.
Note: To see if any patches are required for specific releases of the NonStop system,
check the Support matrix at
https://support.ca.com/irj/portal/anonymous/phpsupcontent?contentID=%7bD048371
8-32D2-4505-9088-8671471C9EED%7d.
Supported Platforms
For current information regarding supported platforms, visit the CA Workload
Automation Certification Information page at the following link:
http://www.ca.com/us/support/ca-support-online/product-content/status/compatibilit
y-matrix/ca-workload-automation-agent-certification-information.aspx
Chapter 5: Supported Systems and Requirements 17
Chapter 6: Related Documentation
Documentation for the agent and scheduling managers is available in HTML and PDF
format at http://ca.com/support.
Note: To view PDF files, download and install the Adobe Reader from the Adobe website
if it is not already installed on your computer.
This section contains the following topics:
CAUNI.CAOPTS File (see page 19)
EVENT-CHECK-INTERVAL—Specify the Sleeping Interval for Checking Job Status
Messages (see page 21)
CAUNI.CAOPTS File
The CAUNI.CAOPTS file is created automatically during installation and contains various
environment variables. These environment variables can be classified as either
user-configurable or expert-configurable.
The user-configurable environment variables are as follows:
■
CAISCHD0006
■
CAISCHD0008
■
CAISCHD0010
■
CAI-CCI-DEBUG
■
CAI-CONLOG
■
CAI-DATEFMT
■
CAI-LOG-SUBVOL
■
CAI-OPR-CONFIG
■
CAI-TRACE-SUBVOL
■
JOBLOG
■
JOBLOG-AUTO-CLEANUP
■
HOST-FILE-LOCATION
■
LOG-ROLLOVER-TIME
■
LOG-ROLLOVER-SIZE
■
SPOOL-AUTO-CLEANUP
Chapter 6: Related Documentation 19
CAUNI.CAOPTS File
■
SPOOL-FILE-DELETE
■
SPOOL-FILE-EXPIRY
■
SPOOL-SLEEP-TIME
■
SPOOL-VOLUME
■
TCPIP-PROCESS-NAME
■
WLA-AGENT-NAME
■
WLA-PASSW-REQUIRED
The expert-configurable environment variables are as follows:
■
CACONSOLE
■
CAOPR-EMS
■
CAOPR-EMS-NAME
■
CAIGLBL0000
■
CAIMESSAGE
■
CAISCHD0001
■
CAISCHD0002
■
CAISCHD0030
■
CA-OPERA-NODE
■
CAI-CAMSGF-OPRDIRECT
■
CAI-EXE
■
CAI-LOCAL-NODE
■
CAI-MSGREADER
■
CAI-TCPIP-HOSTNAME
■
EVENT-CHECK-INTERVAL
■
EXECUTABLES-VOLUME
■
TCPIP-HOST-FILE
Note: Do not modify the expert-configurable environment variables except under the
direction of CA Technologies Technical Support. They are described separately in the
appendix.
20 Release Notes
EVENT-CHECK-INTERVAL Specify the Sleeping Interval for Checking Job Status Messages
EVENT-CHECK-INTERVAL Specify the Sleeping Interval for
Checking Job Status Messages
The EVENT-CHECK-INTERVAL variable specifies the sleeping interval that the agent uses
to check the job status messages.
This variable has the following format:
EVENT-CHECK-INTERVAL: seconds
seconds
Specifies how often the agent checks the job status messages in seconds. Increasing
the value of this variable reduces the number of reads the agent does. However,
the bigger the value, the more latency that is added on before the agent sends job
execution messages back to the scheduling manager.
Default: 1 (every second)
Chapter 6: Related Documentation 21
Appendix A: Using the Agent to Schedule
Jobs
There are different ways of defining jobs depending on your scheduling manager. For
example, on CA Workload Automation AE, you can create a command job to run an HP
Integrity NonStop TACL program, program, or script. Some scheduling managers, such as
CA Workload Automation ESP Edition and CA Workload Automation CA 7 Edition, have
implemented the new functionality through a native job type. For information specific
to your scheduling manager, see the scheduling manager's documentation.
If your scheduling manager lets you define native jobs that accept a command, such as
command jobs in CA Workload Automation AE, you can use keywords within the
command parameter. Alternatively, for all scheduling managers, the HP Integrity
NonStop environment lets you use runtime environment variables to schedule
workload. The information in this section applies to defining a generic job or to
scheduling workload at runtime; however, the examples show how to define CA
Workload Automation AE command jobs only.
There are three new HP Integrity NonStop keywords available with this release of the
agent: ASSIGN, PARAM, and DEFINE.
Migrating from CA UJMA on CA Workload Automation AE
If you are migrating from the CA Universal Job Management Agent (CA UJMA) on CA
Workload Automation AE, update your job definitions as follows:
If there are spaces between the command and arguments, enclose the first word in
double quotes and the rest of the string in single quotes.
For example, the following command must be updated because of the space between
the first word (fup) and the rest of the string:
command: "fup dup $vol.subvol.file1, $vol.subvol1.file2,purge"
To update this command in the job definition, enclose "fup" in double quotes and the
rest of the string in single quotes as follows:
command: "fup" 'dup $vol.subvol.file1, $vol.subvol1.file2,purge'
Appendix A: Using the Agent to Schedule Jobs 23
ASSIGN
ASSIGN
HP Integrity NonStop applications running on the HP Integrity NonStop platform use
ASSIGN messages to assign logical file names to actual files. Optionally, ASSIGN
messages can also specify the characteristics of such files. In CA Workload Automation
AE, the envvars attribute is used to specify ASSIGN commands.
ASSIGN messages are sent to the agent through the scheduling manager.
This variable has the following syntax:
command: “filename”
envvars:ASN1=”asn_spec”
...
envvars:ASNn=”asn_spec”
filename
Specifies an object to run.
ASN
Indicates an ASSIGN message as follows:
logical_unit;actual_filename;PEXT=primary_extent_spec;SEXT=secondary_extent_s
pec;EXL=exclusion_spec;ACC=access_spec;CODE=file_code;REC=rec_size;BLOCK=bloc
k_size
logical_unit
Specifies the name to which a file name or file attributes are assigned.
Limits: Up to 32 characters; not case-sensitive; valid characters are
alphanumeric, hyphen (-), or circumflex (^)
actual_filename
Specifies the name of the actual physical file in the following format:
$volume.subvolume.filename
Limits: Actual physical name consists of three fields of no more than 8
characters each, separated by a period
create_open_spec
Specifies a Create or Open Specification that sets certain file attributes.
24 Release Notes
ASSIGN
Notes:
■
You can define a maximum of 63 ASSIGN messages in a single job.
■
The entire value of one ASSIGN message can be up to 160 characters.
■
ASSIGN messages should be enclosed in double-quotation marks. If an ASSIGN
message is defined with the envvars attribute, it is not completely enclosed in
double quotes, for example, Env (ASN="LOGFILE; $c35.tcsobj.phyfile") or when
defined as a separate keyword, ASN ("LOGFILE;$c35.tcsobj.phyfile").
The following table lists the optional fields of the Create or Open Specification types
with descriptions and examples:
Keyword
Create or Open Specification Type
Description
Example
PEXT
primary_extent_spec
Size of the primary file extent to be PEXT=1024
allocated to the file. It is an integer
between 1 and 65535.
SEXT
secondary_extent_spec
Size of the secondary file extent to
be allocated to the file. It is an
integer between 1 and 65535.
EXL
exclusion_spec
Specifies how processes access a
EXL=EXCLUSIVE
file, as follows:
EXL=SHARED
EXCLUSIVE—Specifies that
EXL=PROTECTED
processes can access the file while
the program has the file open.
SHARED—Specifies that processes
can read and write to the file while
the program has the file open.
PROTECTED—Specifies that
processes can read, but not write to
the file while the program has the
file open.
ACC
access_spec
Specifies the access mode of the file ACC=I-O
operations that can be performed, ACC=INPUT
as follows:
ACC=OUTPUT
I-O—Specifies that processes can
read the file and write to it.
INPUT—Specifies that processes
can only write to the file.
OUTPUT—Specifies that processes
can only read the file.
CODE
code
File code. The maximum file code is CODE=file-code
22222.
CODE=101
SEXT=512
Appendix A: Using the Agent to Schedule Jobs 25
ASSIGN
REC
BLOCK
rec
Size of the record. It is an integer
between 1 and 65535.
block
REC=record-size
REC=300
Size of data blocks used by the
BLOCK=block-size
logical unit. It is an integer between BLOCK=4096
1 and 65535.
Example: ASSIGN for Primary Extent Specification
This example defines a CA Workload Automation AE command job that executes a TACL
command on the server1 HP Integrity NonStop server. The envvars attribute is used to
specify ASSIGN commands. The job passes some specific variable values using the HP
Integrity NonStop environment variables option ASSIGN.
insert_job: nsk14
job_type: CMD
command: "$VOLUME1.NSKOBJS.GETASGN"
envvars:
ASN1="LGFILE;$VOLUME1.NSKOBJS.PHFILE;PEXT=1024;CODE=101;BLOCK=500;REC=80"
machine: server1
owner: agent.oper@server1
ASN is a keyword to recognize ASSIGN messages. $VOLUME1.NSKOBJS.GETASGN is the
sample test program to be scheduled, LGFILE is the logical file name,
$VOLUME1.NSKOBJS.PHFILE is the physical file name, PEXT=1024 is the primary space
extent specification, CODE=101 is the file type, BLOCK=500 is the block size, and REC=80
is the record size.
Example: ASSIGN for Primary Extent Specification and Secondary Extent Specification
This example defines a CA Workload Automation AE command job that executes a TACL
command on the server1 HP Integrity NonStop server. The envvars attribute is used to
specify ASSIGN commands. The job passes some specific variable values using the HP
NonStop environment variables option ASSIGN.
insert_job: nsk13
job_type: CMD
command: "$VOLUME1.NSKOBJS.GETASGN"
envvars: ASN1="ABC;$VOLUME1.NSKOBJS.OABC"
envvars: ASN2="XYZ;$VOLUME1.NSKOBJS.GETPMSG;PEXT=4096;SEXT=200"
machine: server1
owner: agent.oper@server1
ASN is a keyword to recognize ASSIGN messages. $VOLUME1.NSKOBJS.GETASGN is the
sample test program to be scheduled, ABC and XYZ are the logical file names,
$VOLUME1.NSKOBJS.OABC and $VOLUME1.NSKOBJS.GETPMSG are the physical file
names, PEXT=4096 is the primary space extent specification, and SEXT=200 is the
secondary extent specification.
26 Release Notes
PARAM
PARAM
PARAM messages are used to create a parameter and give it a value. These messages
are sent through the scheduling manager. In CA Workload Automation AE, the envvars
attribute is used to specify the PARAM commands.
This message has the following syntax:
command: “filename”
envvars:PRM1=”prm_spec”
...
envvars:PRMn=”prm_spec”
filename
Specifies an object to run.
PRM
Indicates a PARAM message as follows:
param_name=param_value
param_name
Specifies a user-defined parameter name. You cannot use duplicate
param_name entries in the same job for the PARAM message.
Limits: Up to 32 characters; not case-sensitive; valid characters are
alphanumeric, hyphen (-), or circumflex (^)
param_value
Specifies the value assigned to param_name.
Limits: The param_value can be up to 255 characters and must start with
letters.
Notes:
■
You can define a maximum of 65535 PARAM messages in a single job.
■
The entire value of one PARAM message can be up to 287 characters.
■
A sum of number of PARAM and the combined length of all PARAM should be
less than 511 characters.
■
PARAM messages should be enclosed in double-quotation marks.
Appendix A: Using the Agent to Schedule Jobs 27
PARAM
Example: PARAM with One Parameter Name and Value
This example defines a CA Workload Automation AE command job that executes a TACL
command on the server1 HP Integrity NonStop server. The envvars attribute is used to
specify the PARAM commands. The job passes some specific variable values using the
HP Integrity NonStop environment variable option PARAM. You can create a parameter
and give it a value.
insert_job: nsk11
job_type: CMD
command: "$VOLUME1.NSKOBJS.GETPMSG"
envvars: PRM1="VISH=320"
machine: server1
owner: agent.oper@server1
PRM is a keyword to recognize PARAM messages. $VOLUME1.NSKOBJS.GETPMSG is the
sample test program to be scheduled, VISH is the parameter name and the value
assigned to it is 320.
Example: PARAM with Two Parameter Names and Values
This example defines a CA Workload Automation AE command job that executes a TACL
command on the server1 HP Integrity NonStop server. The envvars attribute is used to
specify the PARAM commands. The job passes some specific variable values using the
HP Integrity NonStop environment variables option PARAM. You can create a parameter
and give it a value.
insert_job: nsk10
job_type: CMD
command: "$VOLUME1.NSKOBJS.GETPMSG"
envvars: PRM1="ABC=100"
envvars: PRM2="XYZ=800"
machine: server1
owner: agent.oper@server1
PRM is a keyword to recognize PARAM messages. $VOLUME1.NSKOBJS.GETPMSG is the
sample test program to be scheduled, ABC and XYZ are the parameter names and the
values assigned to them are 100 and 800 respectively.
Example: A Command Statement
This example defines a TACL routine ($DATA2.MONTHLY.PURGJOB1) that purges files
that reside at a specific location and are greater than 30 days old. The location and
number of days are sent to the agent.
command:"$DATA2.MONTHLY.PURGJOB1"
envvars: PRM1="PURGELOC=$DATA1.NSKDATA"
envvars: PRM2="AGE=30"
28 Release Notes
DEFINE
DEFINE
DEFINE messages are file-system elements that pass information to a process. For
example, DEFINE can be used to pass attributes to a process to provide:
■
An alternate name for accessing a file.
■
A list of subvolumes to search for a file name.
■
A simple way to set up attributes for labeled-tape processing.
■
A simple means of passing attributes to the spooler subsystem.
DEFINE messages are stored within the program file segment (PFS) of the creating
process. The programmatic approach stores DEFINE in the context of the creating
process and affects the environment of the creating process. DEFINE can be passed to
other processes when creating new processes.
DEFINE allow attributes to be grouped and named. These attributes can then be passed
to a process or retrieved by specifying the name of the DEFINE. DEFINE removes the
need to set up attributes each time a given process is invoked. Specifically, several
classes of DEFINE each pass attributes to a specific process or class of processes.
Examples of DEFINE classes are:
■
CLASS MAP DEFINE
■
CLASS SEARCH DEFINE
■
CLASS TAPE DEFINE
■
CLASS DEFAULTS DEFINE
The following is the syntax of the DEFINE variable:
command: “filename”
envvars:DEF1=”def_spec”
...
envvars:DEFn=”def_spec”
Appendix A: Using the Agent to Schedule Jobs 29
DEFINE
filename
Specifies an object to run.
job_attributes
Specifies the job attributes.
DEF
Indicates a DEFINE message as follows:
define_name;define_attribute_name=define_attribute_value
define_name
Specifies the user-defined name.
Limits: Up to 2-24 characters; case-sensitive; valid characters are
alphanumeric, hyphen (-), underscore (_), or circumflex (^)
Note: The first character of define_name must be a letter.
define_attribute_name
Specifies the attribute name of the DEFINE keyword.
define_attribute_value
Specifies the attribute value of the DEFINE keyword.
Limits: case-sensitive; valid characters are alphanumeric, hyphen (-),
underscore (_), or circumflex (^)
Notes:
■
You can define a maximum of 65535 ASSIGN messages in a single job.
■
The entire value of one DEFINE message can be up to 4094 characters
■
A sum of number of DEFINEs and combined length of all DEFINEs should be less
than 4095 characters.
■
DEFINE messages should be enclosed in double-quotation marks
The following table describes the possible attribute names and values for the DEFINE
classes and attributes:
Class Name
Attribute Name
Attribute Value
CLASS MAP
CLASS
MAP
FILE
file-name
CLASS
SEARCH
RELSUBVOLn
subvolume-name
SUBVOLn
subvolume-name
CLASS SEARCH
30 Release Notes
DEFINE
Class Name
Attribute Name
Attribute Value
CLASS SORT
CLASS
SORT
BLOCK
size
CPU
cpu-number
CPUS
cpu-number,cpu-number..|ALL }
MODE
- AUTOMATIC
- MINSPACE
- MINTIME
CLASS TAPE
NOTCPUS
cpu-number,cpu-number...
PRI
priority
PROGRAM
file-name
SCRATCH
file-name
SEGMENT
size
SUBSORTS
DEFINE-name, DEFINE-name...
SWAP
file-name
CLASS
TAPE
BLOCKLEN
block-length
DENSITY
- 800
- 1600
- 6250
RETENTION
days
SYSTEM
\node-name
TAPEMODE
- STARTSTOP
- STREAM
USE
- IN
- OUT
- EXTEND
- OPENFLAG
VERSION
num
VOLUME
vol-id | SCRATCH
DEVICE
device-name
REELS
volumes
EBCDIC
{ IN | OUT | ON | OFF }
Appendix A: Using the Agent to Schedule Jobs 31
DEFINE
Class Name
Attribute Name
Attribute Value
EXPIRATION
date
FILEID
file-name
FILESECT
volume-order
FILESEQ
file-order
GEN
gen-num
LABELS
- ANSI
- IBM
- OMITTED
- BYPASS
- BACKUP
- IBMBACKUP
MOUNTMSG
" text"
OWNER
owner-id
RECFORM
-F
-U
RECLEN
record-length
Example: Job Definition Using DEFINE Environment Variable
This example defines a CA Workload Automation AE command job that executes a TACL
command on the server1 HP Integrity NonStop server. The envvars attribute is used to
specify DEFINE commands. The job passes some specific variable values using the HP
Integrity NonStop environment variables option DEFINE.
insert_job: nsk15
job_type: CMD
command: "$VOLUME1.NSKOBJS.GETDEF"
envvars: DEF1="DABC;CLASS=MAP;FILE="$VOLUME1.NSKOBJS.GETDEF"
machine: server1
owner: agent.oper@server1
DEF is a keyword to recognize DEFINE messages. $VOLUME1.NSKOBJS.GETDEF is the
sample test program to be scheduled and DABC is the DEFINE name.
32 Release Notes
Multiple Commands
Multiple Commands
You can also code multiple ASSIGN, PARAM, or DEFINE commands in a job. The
following is the syntax for multiple variables:
command: “filename”
envvars: ASN1=”asn_spec”
envvars: PRM1=”prm_spec”
envvars: DEF1=”def_spec”
Example: A Command Statement Using the ASSIGN and PARAM Keywords
This example defines a program ($DATA1.SERVOBJ.ROUTER) that communicates with a
running process named $VOLUME1.NSKOBJS.GETPMSG. The ASSIGN keyword is used to
pass information to the running process to create a log file named LOG1.
command: "$DATA1.SERVOBJ.ROUTER"
envvars: ASN1="SNAME;$VOLUME1.NSKOBJS.GETPMSG;PEXT=100;SEXT=500"
envvars: PRM1="LNAME=$DATA2.LOGS.LOG1"
Appendix A: Using the Agent to Schedule Jobs 33