BackgroundJob

No description is available

Available Methods

• Abort : Cancel job [ BAPI_XBP_JOB_ABORT ]
  
• AddABAPStep : Add job step with ABAP program to a job [ BAPI_XBP_JOB_ADD_ABAP_STEP ]
  
• AddExternalStep : Assign external program to job step [ BAPI_XBP_JOB_ADD_EXT_STEP ]
  
• CheckStatus : Reconcile job status according to DB with actual status [ BAPI_XBP_JOB_STATUS_CHECK ]
  
• Close : Complete job definition [ BAPI_XBP_JOB_CLOSE ]
  
• CountByName : Count how many jobs there are with a particular name [ BAPI_XBP_JOB_COUNT ]
  
• Delete : Delete a job in the R/3 System [ BAPI_XBP_JOB_DELETE ]
  
• GetDefinition : Read job definition [ BAPI_XBP_JOB_DEFINITION_GET ]
  
• GetStatus : Determine Status of a Job [ BAPI_XBP_JOB_STATUS_GET ]
  
• GetVariantListForReportname : Determine all defined variants of an ABAP program [ BAPI_XBP_VARIANT_INFO_GET ]
  
• ModifyABAPStep : Assign ABAP program to a particular job step [ BAPI_XBP_JOB_ABAP_STEP_MODIFY ]
  
• ModifyExternalStep : Assign external program to a particular job step [ BAPI_XBP_JOB_EXT_STEP_MODIFY ]
  
• Open : Create job [ BAPI_XBP_JOB_OPEN ]
  
• ReadJoblog : Read job log [ BAPI_XBP_JOB_JOBLOG_READ ]
  
• ReadSpoollist : Read spool list of ABAP job step [ BAPI_XBP_JOB_SPOOLLIST_READ ]
  
• Select : Select jobs according to various criteria [ BAPI_XBP_JOB_SELECT ]
  
• StartAsSoonAsPossible : Start job as soon as possible [ BAPI_XBP_JOB_START_ASAP ]
  
• StartImmediately : Start job immediately [ BAPI_XBP_JOB_START_IMMEDIATELY ]
  

Abort

Terminates a job that has just been activated.

Notes

You must have logged onto the XBP interface.

If the job was not active, nothing happens. .

Further Information

XBP documentation (SAPnet/CCMS)

AddABAPStep

This method deals with the second step of scheduling a job in the R/3background processing system. With this method you add a job step tothe job that you created with BackgroundJob.Open. This job step instructs the job to execute the external program.

Jobs can contain any number of jobs. It can also contain differenttypes of job steps (ABAP, external programs or commands). Here only ABAP job steps are installed.

With the method call BackgroundJob.Close you finish defining the job and transfer it with the status
Scheduled without start date to the background processing system.

With the method call BackgroundJob.StartImmediately or BackgroundJob.StartAsSoonAsPossible, you instruct the system to executethe job.

Further Information

XBP-Dokumentation (SAPnet/CCMS)

AddExternalStep

This method deals with the second step of scheduling a job in the R/3background processing system. With this method you add a job step tothe job that you created with BackgroundJob.Open. This job step instructs the job to execute the external program.

Here you can only enter external programs directly, You cannot schedulenon-SAP commands (also known as logical commands) with the BAP methods.(Non-SAP commands define programs or commands that can be executed athost system level.) If users do not have administrator authorization,
they can only schedule external programs using logical commands injobs. Users with administrator authorization, however, can schedule anexternal program in a job step in exactly the same form as it would call the program in the host system.

The authorization user specified with parameter SAP_USER_NAME must have
authorization to schedule external programs. This means that this user must have authorization for authorization object S_RZL_ADM (RZ control station: Systemadministration) with the value 01.

A job may contain any number of job steps. Jobs can only contain several different types of job steps (ABAP, external programs).

With the method call BackgroundJob.Close you finish defining the job and transfer it with the status Scheduled without start date to the background processing system.

With the method call BackgroundJob.StartImmediately or BackgroundJob.StartAsSoonAsPossible, you instruct the system to execute
the job.

Further Information

XBP documentation (SAPnet/CCMS).

CheckStatus

Problems in the R/3 System (such as termination of work processes inthe background processing system or network or database problems) maylead to differences in the status that is saved in the database and the actual job status.

With this method you can determine the status of a job. With the database status Ready or Active
, the method checks whether this status really actually applies. If there are anydifferences, the method updates the job status stored in the database.

Further Information

XBP-Dokumentation (SAPnet/CCMS)

Close

With this method you finish defining a background job. Once the methodhas been executed, the job is transferred to the background processing system with the status Job without start date.

To execute the job, use the methods BackgroundJob.StartAsSoonAsPossible or .StartImmediately.

You must first create the job with the method BackgroundJob.Open and then add at least one job step to the job using the methodsBackgroundJob.AddABAPStep or .BackgroundJob.AddExternalStep.

Further Information

XBP documentation (SAPnet/CCMS)

CountByName

You use this method to determine the number of jobs that match a jobspecification. the method also returns the job definitions in table form.

The method allows you to specify the job name generically. Example: AJOB*.

Further Information

XBP documentation (SAPnet/CCMS)

Delete

Use these methods to delete a job in the R/3 background processing system.

You cannot delete any jobs that are currently being processed. Nor canyou delete jobs that have not yet started, or jobs that are complete or terminated.

Further Information

XBP documentation (SAPnet/CCMS)

GetDefinition

With this method you can read the definition of a background job. Youcan use this, for example, to implement a job display function.

Notes

You cannot use this method to change a job definition. The interfaceonly lets you change job step definitions and delete or cancel jobs.

Further Information

XBP documentation (SAPnet/CCMS)

GetStatus

Use this method to determine the status of a job in the R/3 background processing system.

Further Information

XBP documentation (SAPnet/CCMS)

GetVariantListForReportname

With this method you can determine the variants that exist for areport. If a report should require selection criteria, the job step must specify a variant for the report to transfer the necessaryselection values to the report.

You can choose between the variants that are only permitted for
background processing and the variants that are permitted for both dialog mode and background processing.

Further Information

XBP documentation (SAPnet/CCMS)

ModifyABAPStep

With this method you can change a job step that you have alreadycreated with method BackgroundJob.AddABAPStep. All job step attributes can be changed.

You cna only modify ABAP job steps here.

Further Information

XBP documentation (SAPnet/CCMS)

ModifyExternalStep

With this method you can change a job step that you created with themethod BackgroundJob.AddExternalStep. All job step attributes can be changed.

Here you can only modify job steps that are to execute external programs or external commands.

Further Information

XBP documentation (SAPnet/CCMS)

Open

This method solves the first step in scheduling a job in the R/3background processing system. You create the job with this method.

Using additional method calls (BackgroundJob.AddABAPStep, BackgroundJob.AddExternalStep), you add job steps to the job.

With the method call BackgroundJob.Close, you finish defining the joband transfer it to the background processing system with the status Scheduled without start date.

You have execute the job with the method calls BackgroundJob.StartImmediately or BackgroundJob.StartAsSoonAsPossible.

Further Information

XBP-Dokumentation (SAPnet/CCMS)

ReadJoblog

With this method, you can import a job log to display it to a user or to examine it for error messages.

Notes

You cannot read the log until all the jobs have been processed.

Further Information

XBP docuemntation (SAPnet/CCMS)

ReadSpoollist

This method delivers the content of the spool request that was createdby a job step. The method only delivers spool requests that contain R/3 list data.

Further Information

XBP documentation (SAPnet/CCMS)

Select

Use this method to select jobs according to specific criteria. You can determine jobs according to status or date, for example.

With this method you can provide job display or administration functions.

Further Information

XBP documentation (SAPnet/CCMS)

StartAsSoonAsPossible

With this method, you execute a job in the R/3 background processing system. The method specifies that the job should be startedimmediately. If this is not possible (for example, if no backgroundwork processes are free at that time), the job is placed in a queue and is processed as soon as possible.

Alternative: Method BackgroundJob.StartImmediately. If the job cannot be executed immediately, this method returns an error.

Before you can use this method, you must first define the job with themethods BackgroundJob.Open and BackgroundJob.AddABAPStep or BackgroundJob.AddExternalStep and BackgroundJob.Close.

Further Information

XBP documentation (SAPnet/CCMS).

StartImmediately

With this method, you execute a job in the R/3 background processing system. The method specifies that the job should be startedimmediately. If this is not possible (for example, if no backgroundwork processes are free at that time), the job is placed in a queue and is processed as soon as possible.

Alternative: Methode BackgroundJob.StartASAP. This method specifiesthat the job should be started immediately, however it also allows the job to be started later if it cannot be started immediately.

Before you can use this method, you must define the job with the methods BackgroundJob.Open and BackgroundJob.AddABAPStep or
BackgroundJob.AddExternalStep and BackgroundJob.Close.

Further Information

XBP documentation (SAPnet/CCMS).