R3_ACTIVATE_REPORT

The R3_ACTIVATE_REPORT script element allows you to modify an ABAP step. When you select an SAP job, you can reset the name of the report, the variant, and various archiving and printing parameters of an ABAP step.

Tips:

  • Activate the Combine Job Steps checkbox in the Connection object to combine several R3_ACTIVATE_REPORT script elements into one job. See Interfaces Section

  • Instead of using a variant, you can assign selection criteria by using a script. For more information, see R3_SET_SELECT_OPTION .

Transaction: SM36, SM37
Interface: AE and Standard

Syntax

R3_ACTIVATE_REP[ORT]

    REPORT=...
    [,VARIANT=...]
    [,DESTINATION=...]
    [,COPIES=...]
    [,LIST_NAME=...]
    [,LIST_TEXT=...]
    [,IMMEDIATELY=...]
    [,RELEASE=...]
    [,NEW_LIST_ID=...]
    [,EXPIRATION=...]
    [,LINE_COUNT=...]
    [,LINE_SIZE=...]
    [,LAYOUT=...]
    [,COVERPAGE=...]
    [,SAP_COVER_PAGE=...]
    [,OS_COVER_PAGE=...]
    [,RECEIVER=...]
    [,DEPARTMENT=...]
    [,AUTHORITY=...]
    [,DATA_SET=...]
    [,TYPE=...]
    [,SPOOL_PRIORITY=...]
    [,TEXTONLY=...]
    [,FRAMES=...]
    [,SUPPRESS_SHADING=...]
    [,WITH_STRUCTURE=...]
    [,DEFAULT_SPOOL_SIZE=...]
    [,PRINTER_MAIL_ADDRESS=...]
    [,SPOOL_PAGE_FROM=...]
    [,SPOOL_PAGE_TO=...]
    [,ARCHIVE_MODE=...]
    [,ARCHIVE_SAPOBJECT=...]
    [,ARCHIVE_OBJECT=...]
    [,ARCHIVE_INFO=...]
    [,ARCHIVE_TEXT=...]
    [,MONITOR=...]
    [,WAIT=...]
    [,ABORTED=...]
    [,REPL[ICATE]=...]
    [,BEG_LOGLINES=...]
    [,END_LOGLINES=...]
    [,GET_SPOOL=...]

  • R3_ACTIVATE_REP[ORT]
    Modifies an ABAP step

  • REP[ORT]=
    Name of the report
    Format: script literal
  • VAR[IANT]=
    (Optional) Name of the variant
    Format: script literal

Print Parameters

  • DEST[INATION]=
    (Optional) Name of the output device. In most cases, this is the name of a printer but it can also be the name of a fax machine or the like.
    Format: script literal
    Warning! For technical reasons caused by the SAP XBP interface, you cannot use the long SAP printer names. Use the 4-digit technical name instead.
  • COPIES=
    (Optional) Number of document copies that should be printed
    Format: integer
    Default: 0
  • LIST_N[AME]=
    (Optional) Name of the spool request. It can consist of any letters, numbers, special characters and blanks.
    Format: script literal
    Default: The suggested name consists of the 8 letters of the report name, the separator '_' and the first 3 letters of the user name.
  • LIST_T[EXT]=
    (Optional) Descriptive text for the cover page of the spool request. .
    Format: script literal
    Allowed values: any letters, numbers, special characters, and blanks
  • IMM[EDIATELY]=
    (Optional) Prints immediately
    Allowed values: NO (default) and YES
  • REL[EASE]=
    (Optional) Specifies whether the spool request will be deleted immediately after printing at the output device, or only when the spool retention period has expired.
    Format: script literal
    Allowed values: NO (default) and YES
  • NEW_LIST_ID=
    (Optional) New spool request
    Format: script literal
    Allowed values: YES (default) and NO
  • EXPIR[ATION]=
    (Optional) Specifies how many days a spool request is kept in the spool system before it is deleted.
    Format: Integer
    Default: 0
  • LINE_COUNT=
    (Optional) Number of lines per list page.
    Format: Integer
    Non-print format: If this parameter contains a zero or is empty, the number of pages of the particular list is not limited. The page length of the list is only determined by its content.
    Print format: The maximum number of lines per page depends on the selected format. To change the number of lines, select the layout format accordingly.
    Default: 0
  • LINE_SIZE=
    (Optional) Defines the current line width of the list.
    Print format: The maximum line width depends on the selected layout. To change the line width, select the layout format accordingly.
    Format: Integer
    Default: 0
  • LAYOUT=
    (Optional) Defines the output format of the spool request. Layout defines the page format such as the maximum number of lines and columns on a printed page.
    Format: script literal
  • COVER[PAGE]=
    (Optional) Determines whether a cover page with report selections is printed at the beginning. When a cover page is created, it will be adjusted to the job report. This documents the parameters that were used for this execution.
    Format: script literal
    Allowed values: NO (default) and YES
  • SAP_COVER[_PAGE]=
    (Optional) SAP cover page
    Format:     script literal
    Allowed values:
    • "" (default)
      No cover page is printed
    • X
      A cover page is printed
    • D
      It depends on the setting of the particular output device (printer) whether a cover page is printed or not.
  • OS_COVER[_PAGE]=
    (Optional) Host spool cover page
    Format: script literal
    Allowed values:
    • "" (default)
      No cover page is printed
    • X
      A cover page is printed
    • D
      It depends on the setting of the particular output device (printer) whether a cover page is printed or not.
  • RECEIVER=
    (Optional) Name of the receiver of the spool request. This name is printed on the cover page.
    Format: script literal
    Default: Current user name
  • DEPART[MENT]=
    (Optional) Department name of the spool request as it is printed on the cover page.
    Format: script literal
  • AUTHORITY=
    (Optional) Contains the authorization for the spool request. The content of the spool request is only displayed to authorized users.
    Format: script literal
    Maximum characters: 12
  • DATA_SET=
    (Optional) Name of the spool dataset
    Format: script literal
  • TYPE=
    (Optional) Type of spool request
    Format: script literal
  • SPOOL_PRI[ORITY]=
    (Optional) Spool request priority
    Format: integer
    Default: 5
  • TEXTO[NLY]=
    (Optional) Plain text. This parameter controls the output of non-ASCII characters of a print list.
    Format: script literal
    Allowed values: NO (default) and YES
  • FRAMES=
    (Optional) Defines whether frame characters are used or not.
    Format: script literal
    Allowed values: YES (default) and NO
  • SUPPRESS_SHADING=
    (Optional) Defines whether colors and shades are printed or not
    Allowed values: NO (default) and YES
  • WITH_STRUCTURE=
    Defines whether structured information is included in the report
    Allowed values: NO (default) and YES
  • DEFAULT_SPOOL_SIZE=
    (Optional) Spool request has a maximum line width of 255 characters.
    Allowed values:
    • NO (default)
      The length of the line is not limited
    • YES
      A line break is forced after the 255th column.
  • PRINTER_MAIL_ADDRESS=
    (Optional) Email address of an email printer
    Format: script literal
  • SPOOL_PAGE_FROM=
    SPOOL_PAGE_TO=
    (Optional) The number of the page starting from and until which you want to print.
    Format: string
    Default: All pages are printed.

Archive Parameters

  • ARCHIVE_M[ODE]=
    (Optional) Archiving mode
    Format: script literal
    Allowed values:
    • 1 (default)
      The document should be printed.
    • 2
      The document should be saved in the optical archive.
    • 3
      The document should be printed and saved in the optical archive.
  • ARCHIVE_S[APOBJECT]=
    (Optional) Object type of the business object as archived objects are classified according to object types.
    Format: script literal
  • ARCHIVE_I[NFO]=
    (Optional) Information field that provides the information code for the archiving request
    Format: script literal
  • ARCHIVE_T[EXT]=
    (Optional) Text information field that provides a descriptive text for the archiving request
    Format: script literal
    Allowed values: any letters, numbers, special characters, and blanks

Control Parameters

  • MON[ITOR]=
    (Optional) The logging of status monitoring in the activation log.
    Format: script literal
    Allowed Values: NO (default) and YES

Parameters that handle parent child relationships

  • WAIT=
    (Optional) Waits for SAP job children to end
    Format: script literal or AE name
    Allowed values:
    • NO (default)
      Does not wait for all children to end
    • YES
      Waits for all children to end. Children are logged in the activation report.
  • ABORTED=
    (Optional) Reaction to an abnormal end of SAP job children
    Format: script literal or AE name
    Allowed values:
    • YES (default)
      SAP job (parent) has aborted. The script does not continue and the AE job ends abnormally.
    • NO
      SAP job (parent) has not aborted. The script continues and the AE job ends normally. 
  • REPL[ICATE]=
    (Optional) Handles the children of intercepted jobs.
    Format: script literal
    Allowed values:
    • NO (default)
      There is no replication in the AE system.
    • YES
      The children of a job are replicated in the AE system. They are displayed in the Process Monitoring perspective. Statistical records and reports are created in the AE system.
  • BEG_LOGLINES=
    (Optional) This parameter determines the number of lines that should be passed on to the AE job report counted from the beginning of the SAP job log.
    Allowed values: numbers
    Default: The complete job log is used if neither the parameter END_LOGLINES nor BEG_LOGLINES are specified. If only one of these two parameters is specified, the corresponding value is applied
    No job log is transferred if the value 0 is specified in both parameters.
  • END_LOGLINES=
    (Optional) The number of lines that should be written to the AE job report counted from the end of the SAP' job lob.
    Allowed values: numbers
    Default: The complete job log is used if neither the parameter END_LOGLINES nor BEG_LOGLINES are specified. If only one of these two parameters is specified, the corresponding value is applied
    No job log is transferred if the value 0 is specified in both parameters.
  • GET_SPOOL=
    (Optional) Requests the spool list of the started job
    Format: script literal
    Allowed values:
    • NO (default)
      The spool list is not requested.

      • The spool list is requested for ALL child jobs if you use this script element several times in an SAP job, and if you combine all the individual job steps by using the Combine job steps option in the Connection object, even if the parameter GET_SPOOL="YES" is only set for one R3_ACTIVE_REPORT. For more information, see Connection (CONN).

      Spool entries of children are only requested when the parameter REPLICATE= is either set to YES or to ALL.

    • YES
      The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP Agent INI file with the parameter Download_dir= ([GLOBAL] section). For more information, see Agent SAP.

      • The name of the text file is structured as follows:
      <SAP job count>_<step number>_<spool number>.txt

      This file is also registered as job output in the AE job. For more information, see Registered Job Output.

Example

R3_ACTIVATE_REPORT REPORT='ZSUSER00',VARIANT='ALL_USERS',COVERPAGE='YES',DESTINATION='LT77',IMMEDIATELY='YES'

See also:

seealso

About SAP JCL

Extended and External Output Reports