Automation Engine Script Guide > AE JCL for Applications > SAP > R3_SEND_SPOOL_REQUEST

R3_SEND_SPOOL_REQUEST

Sends an existing spool request.

Transaction: SP01

Interface: AE

Syntax

R3_SEND_SPOOL_REQ[UEST]

[JOBNAME=...]
[,JOBCOUNT=...]
[,STEP=...]
[,SPOOLNR=...]
[,RECIPIENT=...]
[,ADDRESSTYPE=...]
[,EXPRESS=...]
[,COPY=...]
[,BLINDCOPY=...]
[,NOFORWARD=...]
[,LINE_FROM=...]
[,LINE_TO=...]
[,TITLE=...]
[,ERROR=...]
[,NOPRINT=...]
[,DELIVER=...]
[,STATUSBYMAIL=...]

Syntax

Description/Format

JOBNAME=

Name of the background jobAn Automation Engine object type for a process that runs on a target system..
Format of the value: script literal

JOBCOUNT=

Number of the background job.
Format of the value
: scriptA particular Automation Engine object type. literal

STEP=

Step number.
Format of the value:
number

SPOOLNR=

Spool listShows entities in a grid view number.
Format of the value
: script literal

This parameter can be used as an alternative to JOBNAME=, JOBCOUNT= and STEP=.

RECIPIENT=

Recipient.
Format of the value
: script literal

ADDRESSTYPE=

Address type.
Format of the value
: script literal

Allowed values:

"B" (default value) - SAP userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management.
"C" - General distribution list
"D" - X.500 address
"F" - Fax number
"G" - Organization objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task/ID
"H" - Organization departmentDepartment name to which the Automation Engine user belongs./position
"J" - SAP object
"L" - Telex number
"O" - SAP office user
"P" - Personal distribution list
"R" - SAP user in a different SAP system
"U" - Internet address
"X" - X.400 address

EXPRESS=

Sends an express message.
Format of the value
: script literal

Allowed values: "" (default value) and "X"

"" - No message is sent.
"X" -  An express message is sent.

COPY=

Sends a copy.
Format of the value
: script literal

Allowed values: "" (default value) and "X"

"" - No message is sent.
"X" -  A copy is sent.

BLINDCOPY=

Sends a blind copy.
Format of the value: script literal

Allowed values: "" (default value) and "X"

"" - No message is sent.
"X" -  A blind copy is sent.

NOFORWARD=

Forwarding is not allowed.
Format of the value: script literal

Allowed values: "" (default value) and "X"

"" - Forwarding is allowed.
"X" -  
Forwarding is not allowed.

LINE_FROM=

From line.
Format of the value: Number

Default value: "0"

LINE_TO=

To line.
Format of the value: Number

Default value: "0"

TITLE=

Mail title (Subject).
Format of the value: script literal

ERROR=

Handling if an error occurs.
Format of the value: script literal

Allowed values: "IGNORE" and "ABEND" (default value)

"IGNORE" -  The AE job continues.
"ABEND" -  The AE job ends abnormally.

NOPRINT=

Printing is not allowed.
Format of the value: script literal

Allowed values: "Y" and "N" (default value)

"Y" - Printing is not allowed.
"N" - Printing is allowed.

DELIVER=

Receipt.
Format of the value: script literal

Allowed values: "" (default value), "A", "E" and "N"

"" - As specified in the SAP system
"A" - Always.
"E" - Only in error case
"N" - Never

STATUSBYMAIL=

Receipt by e-mail.
Format of the value: script literal

Allowed values: "" (default value), "A", "E" and "N"

"" - As specified in the SAP system.
"A" - Always
"E" - Only in error case
"N" - Never

Comments

There are three ways of using this functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,…. You can:

  1. define the spool by using the parameters JOBNAME= and JOBCOUNT=. The parameter STEP= is optional, the default value is 1.
  2. directly specify SPOOLNR=.
  3. use none of the above parameters. In this case, the spool of the job that has last been executed via the AE job is used. You can specify a step number.

The following SAP support packagesDelivery package, a bundle of functionality. are required in order to use the parameters NOPRINT=, DELIVER= and STATUSBYMAIL=:

Example

R3_SEND_SPOOL_REQUEST JOBNAME='MYJOB',JOBCOUNT=123,RECIPIENT='Smith',ADDRESSTYPE='O'

 

See also:

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH