SAP ABAP Class CL_EHSGBC_BATCH (EHS: Background Processing)
Hierarchy
☛
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
⤷
EHS-SAF (Application Component) Product Safety
⤷
CBGLMP_API (Package) EHS: API Implementations
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials⤷
EHS-SAF (Application Component) Product Safety⤷
CBGLMP_API (Package) EHS: API ImplementationsProperties
| Class | CL_EHSGBC_BATCH | |
| Short Description | EHS: Background Processing | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CBGLMP_API | EHS: API Implementations |
| Created | 20110914 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CL_EHSGBC_CONSTANTS |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_EHSGBC_BATCH has no interface implemented.
Friends
Class CL_EHSGBC_BATCH has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_BTC_ABORTED |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'A' | State of Background Job | 20110914 | |
| 2 | GC_BTC_DERELEASE_JOB |
Constant | Public | Type reference (TYPE) | BTCH0000-INT4 | 18 | Reference Type INT4 for Background Processing | 20110914 | |
| 3 | GC_BTC_FINISHED |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'F' | State of Background Job | 20110914 | |
| 4 | GC_BTC_INTERCEPTED |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'P' | State of Background Job | 20110914 | |
| 5 | GC_BTC_NO |
Constant | Public | Type reference (TYPE) | BTCH0000-CHAR1 | 'N' | Single-Character Indicator | 20110914 | |
| 6 | GC_BTC_PROCESS_ALWAYS |
Constant | Public | Type reference (TYPE) | BTCH0000-CHAR1 | ' ' | Reference Type CHAR1 for Background Processing | 20110914 | |
| 7 | GC_BTC_PUT_ACTIVE |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'Z' | State of Background Job | 20110914 | |
| 8 | GC_BTC_READY |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'Y' | State of Background Job | 20110914 | |
| 9 | GC_BTC_READ_JOBHEAD_ONLY |
Constant | Public | Type reference (TYPE) | BTCH0000-INT4 | 19 | Reference Type INT4 for Background Processing | 20110914 | |
| 10 | GC_BTC_RELEASED |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'S' | State of Background Job | 20110914 | |
| 11 | GC_BTC_RUNNING |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'R' | State of Background Job | 20110914 | |
| 12 | GC_BTC_SCHEDULED |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'P' | State of Background Job | 20110914 | |
| 13 | GC_BTC_STDT_AFTERJOB |
Constant | Public | Type reference (TYPE) | TBTCSTRT-STARTDTTYP | 'A' | Start Date Type ID | 20110914 | |
| 14 | GC_BTC_STDT_DATETIME |
Constant | Public | Type reference (TYPE) | TBTCSTRT-STARTDTTYP | 'D' | Start Date Type ID | 20110914 | |
| 15 | GC_BTC_STDT_EVENT |
Constant | Public | Type reference (TYPE) | TBTCSTRT-STARTDTTYP | 'E' | Start Date Type ID | 20110914 | |
| 16 | GC_BTC_STDT_IMMEDIATE |
Constant | Public | Type reference (TYPE) | TBTCSTRT-STARTDTTYP | 'I' | Start Date Type ID | 20110914 | |
| 17 | GC_BTC_UNKNOWN_STATE |
Constant | Public | Type reference (TYPE) | BTCSTATUS | 'X' | State of Background Job | 20110914 | |
| 18 | GC_BTC_YES |
Constant | Public | Type reference (TYPE) | BTCH0000-CHAR1 | 'Y' | Single-Character Indicator | 20110914 | |
| 19 | GC_DBTABLE |
Constant | Public | Type reference (TYPE) | TABNAME | 'TBTCO' | Table Name | 20110914 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | AS_STATUS_DESCR_CL |
Static method | Public | Method | Internal Status as Status Description | 20110914 |
| 2 | CREATE_AND_START_CL |
Static method | Public | Method | Create and Start a Batch Job | 20110914 |
| 3 | DELETE_CL |
Static method | Public | Method | Delete a Batch Job | 20110914 |
| 4 | GET_JOBS_OF_EVENT_CL |
Static method | Public | Method | Determines Background Jobs for an Event/Parameter | 20121023 |
| 5 | GET_JOBS_OF_PROGRAM_CL |
Static method | Public | Method | Determine Batch Jobs of a Specified ABAP Program | 20110914 |
| 6 | GET_RUNTIME_INFO_CL |
Static method | Public | Method | Determine Runtime Info of a Batch Job | 20110914 |
| 7 | GET_STATUS_CL |
Static method | Public | Method | Determine Status of a Batch Job | 20110914 |
| 8 | JOB_DELETE_CL |
Static method | Public | Method | Deletion of Released Background Jobs (eventid) | 20121023 |
| 9 | JOB_RAISE_EVENT_CL |
Static method | Public | Method | Trigger a Background Event, Max. Active. Jobs | 20120126 |
| 10 | LOG_DISPLAY_CL |
Static method | Public | Method | Display a Batch Job Log | 20110914 |
| 11 | MODIFY_STATUS_CL |
Static method | Public | Method | Modify Status of a Batch Job | 20110914 |
| 12 | RAISE_EVENT_CL |
Static method | Public | Method | Trigger a Background Event | 20111207 |
| 13 | STOP_CL |
Static method | Public | Method | Stop a Running Batch Job (Status 'Active') | 20110914 |
| 14 | TRIGGER_STATUS_MONITOR |
Static method | Public | Method | Set Up Background Job for Monitoring Print Request Status | 20130131 |
Events
Class CL_EHSGBC_BATCH has no event.
Types
Class CL_EHSGBC_BATCH has no local type.
Method Signatures
Method AS_STATUS_DESCR_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_STATUS | Call by reference | Type reference (TYPE) | BTCSTATUS | State of Background Job | 20110914 | ||
| 2 |  Returning |
RV_DESCR | Value transfer | Type reference (TYPE) | STRING | 20110914 |
Method AS_STATUS_DESCR_CL on class CL_EHSGBC_BATCH has no exception.
Method CREATE_AND_START_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_JOB_COUNT | Call by reference | Type reference (TYPE) | BTCJOBCNT | Job ID | 20110914 | ||
| 2 | Importing |
IS_START_DATA | Call by reference | Type reference (TYPE) | TBTCSTRT | Start data description / Repetition period of background job | 20110914 | ||
| 3 | Importing |
IV_AUTHCKNAM | Call by reference | Type reference (TYPE) | TBTCJOB-AUTHCKNAM | SY-UNAME | Background User Name for Authorization Check | 20110914 | |
| 4 | Importing |
IV_JOBCLASS | Call by reference | Type reference (TYPE) | TBTCJOB-JOBCLASS | 'C' | Job classification | 20110914 | |
| 5 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | TBTCO-JOBNAME | Background job name | 20110914 | ||
| 6 | Importing |
IV_REPNAME | Call by reference | Type reference (TYPE) | TBIST-REPNAME | ABAP Program Name | 20110914 | ||
| 7 | Importing |
IV_TARGETGROUP | Call by reference | Type reference (TYPE) | BPSRVGRP | Server Group Name Background Processing | 20110914 | ||
| 8 | Importing |
IV_TARGETSERVER | Call by reference | Type reference (TYPE) | BTCSRVNAME | Server name | 20110914 | ||
| 9 | Importing |
IV_VARIANT | Call by reference | Type reference (TYPE) | RALDB-VARIANT | Variant Name | 20110914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_EHSGBC_EXCEPTION |
20110914 |
Method DELETE_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_EHSGBC_MESSAGE | Message object to return failure messages | 20110914 | ||
| 2 | Importing |
IV_FLG_COMMIT | Call by reference | Type reference (TYPE) | AS4FLAG | CL_EHSGBC_CONSTANTS=>GC_TRUE | Flag (X or Blank) | 20110914 | |
| 3 | Importing |
IV_FLG_FORCE | Call by reference | Type reference (TYPE) | AS4FLAG | CL_EHSGBC_CONSTANTS=>GC_TRUE | Flag (X or Blank) | 20110914 | |
| 4 | Importing |
IV_JOBCOUNT | Call by reference | Type reference (TYPE) | BTCJOBCNT | Job ID | 20110914 | ||
| 5 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | BTCJOB | Background job name | 20110914 |
Method DELETE_CL on class CL_EHSGBC_BATCH has no exception.
Method GET_JOBS_OF_EVENT_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ET_JOBLIST | Value transfer | Type reference (TYPE) | CCGLD_TBTCJOB | EHS: Tabelle zu TBTCJOB (Hintergrundjob Kopfdaten) | 20121023 | ||
| 2 | Importing |
IV_EVENTID | Call by reference | Type reference (TYPE) | BTCEVENTID | Ereignisse der Hintergrundverarbeitung | 20121023 | ||
| 3 | Importing |
IV_EVENTPARM | Call by reference | Type reference (TYPE) | BTCEVTPARM | Parameter eines Batch-Events (z.B. Jobname/Jobcount ) | 20121023 |
Method GET_JOBS_OF_EVENT_CL on class CL_EHSGBC_BATCH has no exception.
Method GET_JOBS_OF_PROGRAM_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PROGRAM | Call by reference | Type reference (TYPE) | SY-REPID | Program Name | 20110914 | ||
| 2 | Importing |
IV_STATUS | Call by reference | Type reference (TYPE) | BTCSTATUS | '*' | State of Background Job | 20110914 | |
| 3 | Importing |
IV_VARIANT | Call by reference | Type reference (TYPE) | RALDB-VARIANT | Variant Name | 20110914 | ||
| 4 | Returning |
RT_JOBLIST | Value transfer | Type reference (TYPE) | CCGLD_TBTCJOB | EHS: Table of Job Header Data | 20110914 |
Method GET_JOBS_OF_PROGRAM_CL on class CL_EHSGBC_BATCH has no exception.
Method GET_RUNTIME_INFO_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RS_INFO | Value transfer | Type reference (TYPE) | TBTCM | Run-time information on batch job | 20110914 |
Method GET_RUNTIME_INFO_CL on class CL_EHSGBC_BATCH has no exception.
Method GET_STATUS_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_FLG_HAS_CHILD | Call by reference | Type reference (TYPE) | AS4FLAG | Flag (X or Blank) | 20110914 | ||
| 2 | Exporting |
EV_STATUS | Call by reference | Type reference (TYPE) | BTCSTATUS | State of Background Job | 20110914 | ||
| 3 | Importing |
IV_JOBCOUNT | Call by reference | Type reference (TYPE) | BTCJOBCNT | Job ID | 20110914 | ||
| 4 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | BTCJOB | Background job name | 20110914 |
Method GET_STATUS_CL on class CL_EHSGBC_BATCH has no exception.
Method JOB_DELETE_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_EHSGBC_MESSAGE | EHS: GLM Meldungen | 20121023 | ||
| 2 | Importing |
IV_EVENTID | Call by reference | Type reference (TYPE) | BTCEVENTID | 20121023 | |||
| 3 | Importing |
IV_EVENTPARM | Call by reference | Type reference (TYPE) | BTCEVTPARM | 20121023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_EHSGBC_EXCEPTION |
EHS: GLM API Ausnahmen | 20121023 |
Method JOB_RAISE_EVENT_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_EHSGBC_MESSAGE | EHS: GLM Meldungen | 20121023 | ||
| 2 | Importing |
IV_EVENTID | Call by reference | Type reference (TYPE) | BTCEVENTID | Ereignisse der Hintergrundverarbeitung | 20120126 | ||
| 3 | Importing |
IV_EVENTPARM | Call by reference | Type reference (TYPE) | BTCEVTPARM | Parameter eines Batch-Events | 20121010 | ||
| 4 | Importing |
IV_MAX_ACTIVE_JOBS | Call by reference | Type reference (TYPE) | CBGLE_INITVALUE | 0 | maximale Anzahl aktiver Hintergrundprozesse | 20120130 | |
| 5 | Importing |
IV_ON_COMMIT | Call by reference | Type reference (TYPE) | AS4FLAG | Ereigniss mit nur bei nächstem Commit ausgelöst | 20121029 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_EHSGBC_EXCEPTION |
EHS: GLM API Ausnahmen | 20121023 |
Method LOG_DISPLAY_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_EHSGBC_MESSAGE | Genifix: Message handling | 20110914 | ||
| 2 | Importing |
IV_JOBCOUNT | Call by reference | Type reference (TYPE) | BTCJOBCNT | Job ID | 20110914 | ||
| 3 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | BTCJOB | Background job name | 20110914 |
Method LOG_DISPLAY_CL on class CL_EHSGBC_BATCH has no exception.
Method MODIFY_STATUS_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_EHSGBC_MESSAGE | Genifix: Message handling | 20110914 | ||
| 2 | Importing |
IV_DIALOG | Call by reference | Type reference (TYPE) | BTCH0000-CHAR1 | GC_BTC_NO | 20110914 | ||
| 3 | Importing |
IV_JOBCOUNT | Call by reference | Type reference (TYPE) | BTCJOBCNT | Job ID | 20110914 | ||
| 4 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | BTCJOB | Background job name | 20110914 | ||
| 5 | Importing |
IV_OPCODE | Call by reference | Type reference (TYPE) | BTCH0000-INT4 | GC_BTC_DERELEASE_JOB | Operation code, e.g. gc_btc_release_job | 20110914 |
Method MODIFY_STATUS_CL on class CL_EHSGBC_BATCH has no exception.
Method RAISE_EVENT_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_EVENTID | Call by reference | Type reference (TYPE) | BTCEVENTID | Ereignisse der Hintergrundverarbeitung | 20111207 | ||
| 2 | Importing |
IV_EVENTPARM | Call by reference | Type reference (TYPE) | BTCEVTPARM | Parameter eines Batch-Events (z.B. Jobname/Jobcount ) | 20111207 | ||
| 3 | Importing |
IV_SERVER | Call by reference | Type reference (TYPE) | MSNAME2 | Name des Applikationsservers | 20111207 |
Method RAISE_EVENT_CL on class CL_EHSGBC_BATCH has no exception.
Method STOP_CL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MESSAGES | Call by reference | Object reference (TYPE REF TO) | CL_EHSGBC_MESSAGE | EHS: Labeling messages | 20110914 | ||
| 2 | Importing |
IV_JOBCOUNT | Call by reference | Type reference (TYPE) | BTCJOBCNT | Job ID | 20110914 | ||
| 3 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | BTCJOB | Background job name | 20110914 |
Method STOP_CL on class CL_EHSGBC_BATCH has no exception.
Method TRIGGER_STATUS_MONITOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CV_FLG_ERROR | Call by reference | Type reference (TYPE) | AS4FLAG | 20130131 | |||
| 2 | Changing |
CV_FLG_WARNING | Call by reference | Type reference (TYPE) | AS4FLAG | 20130131 | |||
| 3 | Importing |
IO_MESSAGE_HANDLER | Call by reference | Object reference (TYPE REF TO) | CL_EHSGBC_MESSAGE | 20130131 |
Method TRIGGER_STATUS_MONITOR on class CL_EHSGBC_BATCH has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
