_retrieveAgentRunInfo

_retrieveAgentRunInfo

Retrieves the spool for a given agent run instance.

Syntax
Syntax Description
Example

Syntax

CALL SEND(agentInst, '_retrieveAgentRunInfo ',
agentName, runKey, dateTime, cc, rc
<, logSpool, listSpool>);

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

agentName C name of agent

runKey N run instance key

dateTime N date-time stamp

cc N completion code

rc N return code

logSpool N optional log spool model object id

listSpool N optional list spool model object id

Where...	Is type...	And represents...
agentName	C	name of agent
runKey	N	run instance key
dateTime	N	date-time stamp
cc	N	completion code
rc	N	return code
logSpool	N	optional log spool model object id
listSpool	N	optional list spool model object id

_retrieveAgentRunInfo method: retrieves the log and output spool for a given agent run, which is identified by the agentName and runKey parameters. The output can be displayed in a FRAME text viewer.
agentName: is an agent that has been defined to the DOMAIN server using the _defineAgent method.
runKey: is returned from the _runAgent method and can be 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 cc is 0, the agent run executed successfully.
rc: parameter indicates whether the _retrieveAgentRunInfo method was invoked successfully.

All parameters after rc are optional and positional. These parameters are

logSpool: is the log spool model object id that identifies the model in which to display the log spool that is retrieved. The SASHELP.CONNECT.RUNSPOOL class can be used to present the run instance log spool.
listSpool: is the listing output spool model object id that identifies the model in which to display the listing output spool that is retrieved. The SASHELP.CONNECT.RUNSPOOL class can be used to present the run instance listing output spool.

Note: Both log and listing output may be directed to the same spool instance or to different run spools. Either or both may be omitted as well. The run spool instances may be displayed with the FRAME text viewer. [cautionend]

Example

This example retrieves the agent run information and displays the log and listing output run spool in a FRAME text viewer instance named VIEWER_I.

model_c = loadclass('sashelp.connect.runspool.class');
model_i = instance(model_c);

call send(agentInst, '_retrieveAgentRunInfo', 
          agent_name, runkey, rundt, runcc, rc,
          model_i, model_i);

call notify('viewer_i', '_ATTACH_', model_i);

Chapter Contents
Previous
Next
Top of Page

_retrieveAgentRunInfo

Syntax

Syntax Description