SAP Function XDA_SCHEDULE_JOB - Schedule Data Archiving Job

Parameter Reference Type Length Default Optional Text
APP_SERVER_NAME MSNAME2 C 40 X New Application Server Name Length (Since 6.10)
ARCH_PARAMETERS ARC_PARAMS u 332 X ImageLink Structure
CLEANUP_JOB_TABLE CHAR1 C 1 ' ' X 'X': Remove Entries for Non-Existent Jobs from ADMI_JOBS/ADMI_RJOBS
DELETE_FAILED_JOB CHAR1 C 1 ' ' X 'X': Delete the Job if Scheduling Not Successful
DONT_RELEASE CHAR1 C 1 ' ' X 'X': Schedule without Releasing
EXT_USER XMILOGEUSR C 16 X Name of a User in an External Management Tool
FILE_KEY ARKEY C 20 X Key for Archive File
JOBTYPE ADMI_JOB_T C 3 Category of Data Archiving Job
OBJECT OBJCT_TR01 C 10 Archiving Object
PRINT_PARAMETERS PRI_PARAMS u 196 X Structure for Passing Print Parameters
READ_OR_INDEX_PROG PROGNAME C 40 X ABAP Program Name
SESSION ADMI_RUN_D N 6 X Archiving Session Number
SUB_JOB_SUCCESSOR ADMI_JOB_T C 3 X Category of Data Archiving Job
TARGETGROUP BPSRVGRP C 20 X Server Group Name Background Processing
USER ADMI_USER C 12 SY-UNAME X Name of the User for Authorization Check
VARIANT VARIANT C 14 X ABAP: Name of Variant (Without Program Name)

Parameter Reference Type Length Text
JOBCOUNT ADMI_JOBCN C 8 Identification Number of the Archive Job
JOBNAME ADMI_JOBNA C 32 Name of the Archive Job

Parameter Reference Length Optional Text
FILES_TO_BE_READ ARCHIV_KEY 20 X Key for Archive File

Exception Text
INPUT_INCONSISTENT Entry Values Inconsistent
JOBTYPE_NOT_SUPPORTED Jobs of this Type Cannot Be Scheduled
JOB_NOT_CREATED Job Could Not Be Generated
NOT_AUTHORIZED Insufficient authorization
NO_SUCH_UNLOCKED_USER User does not exist in current client or is locked
NO_SUCH_VARIANT Variant Does not Exist
OBJECT_NOT_FOUND Archiving Object Unknown

Functionality
This RFC-enabled function module is used to schedule the following jobtypes in Data Archiving. The job is started immediately:

  • Preprocessing job

  • Write job

  • Delete job

  • Read job

  • Index job

  • Storage job

  • Retrieval job

  • Reload job

  • Postprocessing job

  • Scheduling job (SUB job)

    • Example

    Notes

    Description
    If the system was able to schedule a job successfully, itsidentification number is returned here.

    Description
    If the system was able to schedule a job successfully, itsidentification number is returned here.

    Description
    Application server (instance name) on which the job is to be carriedout.
    If a server name is specified here, the parameter TARGETGROUP and anyserver group set up in cross-archiving object Customizing are ignored.

    Description
    If, at this point, no archiving parameters or at PRINT_PAPAMETERS noprint parameters are transferred, standard values are determined.

    Description
    Removes entries from ADK control tables for jobs that no longer exist.

    Value range

    • 'X': Entries are deleted

    • ' ': Entries are retained

      • Default
      ' '

      Description

      Value range

      • 'X': If the job definition or (if requested) the release of the job was
        • not successful, the job is immediately deleted from the Job Management.
        • ' ': The job definition is retained.

          • Value range

          • 'X': Job is scheduled but not released

          • ' ': Job is scheduled and released

            • Description
            The name given here is for the internal purposes of the ADK log. Usingparameter EXT_USER is particularly recommended if an external tool isspecified as USER and a detailed entry of a real user is possible.

            Description
            If required by the jobtype, the archive file key must, at this point,be specified in accordance with archive mamagement.
            With job type "REA " and "IDX", this parameter only makes a differenceif the program does not have a selection screen for selecting files.

            Description
            Job type for scheduling

            Value range

            • 'PRE': Preporocessing job

            • 'WRI': Write job

            • 'DEL': Delete job

            • 'REA': Read job

            • 'IDX': Index job

            • 'STO': Storage job

            • 'RET': Retrieval job

            • 'REL': Reload job

            • 'FIN': Postprocessing job

            • 'SUB': Scheduling job for follow-on job type according to
              • SUB_JOB_SUCCESSOR

              Description
              Archiving object for which the job is to be scheduled

              Description
              If, at this point, no print parameters are entered, or if atARCH_PARAMETERS no archiving parameters are transferred, standardvalues are determined.

              Description
              The name of the read or index program that is to be carried out mustonly be entered for a read or index job.

              Description
              If required by the job type, the number of the archiving session mustbe entered at this point.

              Description
              Follow-on job type that is scheduled by scheduling job with job classA.

              Value range

              • 'PRE': Preprocessing job

              • 'WRI': Write job

              • 'FIN': Postprocessing job

                • Description
                If no server group name is specified for background processing, thesystem schedules jobs on the server group that is set up incross-archiving object Customizing. If no server group is found, thebackground processing system assigns the jobs to available servers.
                For job types 'WRI', 'PRE' and 'FIN', the following applies: If theserver group determined contains an application server that is runningof the database computer and is configured for background processing, aserver of this kind is used for the scheduling and no other servergroup is even considered. Priority is given to the database server evenif no server group can be determined.

                Description
                The user name is used for the authorization checks in programs thatbelong to the job type.

                Default
                Current user

                Description
                Name der Variante, mit der das dem Jobtyp laut Definition desArchivierungsobjekts zugeordnete Programm ausgeführt werden soll
                Name of the variant with which the program is to be carried out. Theprogram in question is the program that is assigned to the archivingobject in line with the job type definintion.

                Description
                For a read program (job type "REA"), which does not realize archivefile selection using a selection screen, the keys for the archivefiles to be read can be transferred using this table. If this tablecontains at least one line, the parameter FILE_KEY is ignored.