_storeAgentRunInfo

_storeAgentRunInfo

Retrieves and stores the spool for a given agent run instance in an external file or catalog entry.

Syntax
Syntax Description
Example

Syntax

CALL SEND(agentInst, '_storeAgentRunInfo ',
agentName, runKey, dateTime, cc, type, logSpec,
listSpec, rc);

Where... Is type... And represents...

agentName C name of agent

runKey N run instance key

dateTime N date/time stamp

cc N completion code

type C type of storage file

logSpec C external file or catalog in which to store the log

listSpec C external file or catalog in which to store the listing output

rc
N return code

Where...	Is type...	And represents...
agentName	C	name of agent
runKey	N	run instance key
dateTime	N	date/time stamp
cc	N	completion code
type	C	type of storage file
logSpec	C	external file or catalog in which to store the log
listSpec	C	external file or catalog in which to store the listing output
rc	N	return code

_storeAgentRunInfo method

retrieves the log and listing output spool for a given agent run which is identified by the agentName and runKey parameters and stores it in either an external file or catalog entry.

agentName

is an agent that has been defined to the DOMAIN server using the _defineAgent method.

runKey

is returned from the _runAgent method and is used to retrieve the run information for this particular run.

dateTime

is a return parameter that holds the date/time stamp for the run instance.

cc

is a return parameter that holds the completion code. If 0, the agent run executed successfully.

type

parameter indicates the type of file in which the agent run information will be stored. This parameter must have a value of either CATALOG or EXTERNAL.

logSpec
listSpec

parameters indicate the file(s) in which to store the log and listing output from the agent run. These parameters will vary based on the value of type:

If type is CATALOG, logSpec and listSpec must be a valid catalog names that represent the catalog entry. It must be in the form of
```
libname.memname.entryname
```
entrytype does not have to be specified because the log information is stored in an entrytype of AGENTLOG and the output is stored in an entrytype of AGENTOUT.
If type is EXTERNAL, logSpec and listSpec must be valid filerefs. When an external file is used, the user has the flexibility to decide whether to store the log and listing output in the same file or in separate files. If they are identical, the log and listing output are stored in the same file. If not, the log and listing output are stored separately.

rc

indicates whether the _storeAgentRunInfo method was invoked successfully.

Example

This example stores the agent run info in the external file EXTREF, which is defined by the fileref.

ftype = 'EXTERNAL';
fref  = 'extref';
rc = filename('extref', '/tmp/agent.txt');
call send(agentInst, '_storeAgentRunInfo', 
          agent_name, runkey, rundt, runcc,
          ftype, fref, rc);

Chapter Contents
Previous
Next
Top of Page

_storeAgentRunInfo

Syntax

Syntax Description