SAP ABAP Interface IF_GRFN_API_AM_JOBSTEP (Job step entiry API interface)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC (Application Component) Governance, Risk and Compliance
⤷
GRFN_ENTITY_API (Package) GRC Foundation API
GRCFND_A (Software Component) GRC Foundation ABAP⤷
GRC (Application Component) Governance, Risk and Compliance⤷
GRFN_ENTITY_API (Package) GRC Foundation API
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_GRFN_API_AM_JOBSTEP | AM Job Step Entity | 20100527 |
Properties
| Interface | IF_GRFN_API_AM_JOBSTEP | |
| Short Description | Job step entiry API interface |
General Data
| Package | GRFN_ENTITY_API | GRC Foundation API |
| Created | 20100527 | SAP |
| Last changed | 20141106 | |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface IF_GRFN_API_AM_JOBSTEP has no interface.
Friends
Interface IF_GRFN_API_AM_JOBSTEP has no friend.
Attributes
Interface IF_GRFN_API_AM_JOBSTEP has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ACTION_ALLOWED |
Instance method | Public | Method | Whether the actions are allowed | 20100622 |
| 2 | ACTION_CANCEL |
Instance method | Public | Method | Cancel this Job Step | 20100622 |
| 3 | ACTION_OBSOLETE |
Instance method | Public | Method | Obsolete this Job Step | 20100622 |
| 4 | ACTION_RESCHEDULE |
Instance method | Public | Method | Reschedule this Job Step | 20100622 |
| 5 | CREATE_JOBSTEPS |
Static method | Public | Method | Create Job Steps | 20100617 |
| 6 | CREATE_JOBSTEP_AME |
Static method | Public | Method | Create Job Step - Automated Monitoring(AM) Event Trigger(E) | 20100713 |
| 7 | CREATE_JOBSTEP_IES |
Static method | Public | Method | Create Job Step - Incoming Event Handling(IE) Single Mode(S) | 20100622 |
| 8 | CREATE_JOBSTEP_RESULT |
Instance method | Public | Method | Create Job Step Result - Runtime | 20100527 |
| 9 | GET_EXTENSION |
Instance method | Public | Method | Get integration extension API | 20120203 |
| 10 | QUERY |
Static method | Public | Method | Query Job Step | 20100527 |
| 11 | QUERY_BY_GROUP |
Static method | Public | Method | Query by Job Step Group, based on one Job | 20100702 |
| 12 | QUERY_BY_STATUS |
Static method | Public | Method | Query Job Step by Status, based on one Job | 20100622 |
| 13 | RETRIEVE |
Instance method | Public | Method | Retrieve Job Step | 20100527 |
| 14 | SEARCH_BY_CONTROL |
Static method | Public | Method | Search Job Steps by Control | 20100623 |
| 15 | SUBMIT |
Static method | Public | Method | Submit jobsteps | 20120202 |
| 16 | UPDATE |
Instance method | Public | Method | Update Job Step | 20100527 |
Events
Interface IF_GRFN_API_AM_JOBSTEP has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_SEARCH_BY_CONTROL | Public | See coding | 20100722 | BEGIN OF s_search_by_control,
job_id TYPE grfn_api_object_id, " Job ID
jobname TYPE btcjob, " Job Name
regulation_id TYPE grfn_api_object_id, " Job Regulation
regulation_t TYPE grfn_regulation, " Job Regulation
regulations_t type string, " All Job Regulations, Comma separated, including the main regulation
frequency_id TYPE grfn_tf_frequency, " Job Frequency
frequency_t TYPE grfn_tf_text, " Job Frequency
jobstep_id TYPE grfn_api_object_id, " Job Step ID
jobstep type grfn_jobstep, " Job Step
jobstep_status_id TYPE grfn_jobstepstatus, " Job Step Status
jobstep_status_t TYPE val_text, " Job Step Status
br_id TYPE grfn_api_object_id, " Job Step BR
br_name TYPE grfn_object_name, " Job Step BR
exec_date TYPE grfn_exec_date, " Job Step execution date
exec_time TYPE grfn_exec_time, " Job Step execution date
deficiency_total TYPE grfn_count, " Job Step Total Deficiency Number
deficiency_id TYPE grfn_deftype, " Job Step Overall Deficiency Result
deficiency_t TYPE grfn_deftype_desc, " Job Step Overall Deficiency Result
issue_id TYPE grfn_api_object_id, " Job Step related Issue
issue_status_id TYPE crm_j_status, " Issue Status
issue_status_t TYPE j_txt30, " Issue Status
issue_priority_id TYPE grpc_issue_priority, " Issue Priority
issue_priority_t TYPE val_text, " Issue Priority
END OF s_search_by_control
|
||
| 2 | T_SEARCH_BY_CONTROL | Public | See coding | 20100722 | t_search_by_control TYPE STANDARD TABLE OF s_search_by_control WITH DEFAULT KEY
|
Method Signatures
Method ACTION_ALLOWED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_ALLOW_CANCEL | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100622 | |||
| 2 | Exporting |
EV_ALLOW_OBSOLETE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100622 | |||
| 3 | Exporting |
EV_ALLOW_RESCHEDULE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100623 |
Method ACTION_CANCEL Signature
Method ACTION_CANCEL on Interface IF_GRFN_API_AM_JOBSTEP has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100622 |
Method ACTION_OBSOLETE Signature
Method ACTION_OBSOLETE on Interface IF_GRFN_API_AM_JOBSTEP has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100622 |
Method ACTION_RESCHEDULE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_NEW_JOBSTEP_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | The new created Job Step ID | 20100630 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100622 |
Method CREATE_JOBSTEPS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100617 | ||
| 2 | Importing |
IT_JOBSTEP | Call by reference | Type reference (TYPE) | GRFN_T_JOBDETAIL_CREATE | Job Step Creation List | 20100617 | ||
| 3 | Importing |
IT_JOBSTEP_CONTEXT | Call by reference | Type reference (TYPE) | GRFN_T_JOBSTEPCONTEXT | Job Step Context | 20100617 | ||
| 4 | Importing |
IV_JOB_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Job ID | 20100620 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100617 |
Method CREATE_JOBSTEP_AME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100713 | ||
| 2 | Importing |
IV_PREVIOUS_JOBSTEP_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Previous Job Step ID | 20100713 | ||
| 3 |  Returning |
RV_JOBSTEP_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Job Step ID | 20100713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100713 |
Method CREATE_JOBSTEP_IES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100622 | ||
| 2 | Importing |
IV_PREVIOUS_JOBSTEP_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Previous Job Step ID | 20100622 | ||
| 3 | Returning |
RV_JOBSTEP_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Job Step ID | 20100622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100622 |
Method CREATE_JOBSTEP_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_JOBSTEP_RESULT | Call by reference | Type reference (TYPE) | GRFN_T_API_JOBPRESULT | Job Step Result - Reference | 20100527 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100527 |
Method GET_EXTENSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_EXTENSION | Value transfer | Object reference (TYPE REF TO) | IF_GRFN_API_CM_JOBSTEP_EXT | Continuous Monitoring Jobstep | 20120203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20120203 |
Method QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_JOB | Call by reference | Type reference (TYPE) | GRFN_T_API_JOB | Job Detail List - The relevant Jobs of ET_JOBSTEP | 20100623 | ||
| 2 | Exporting |
ET_JOBSTEP | Call by reference | Type reference (TYPE) | GRFN_T_API_JOBSTEP | Job Step Detail List | 20100527 | ||
| 3 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100527 | ||
| 4 | Importing |
IV_EXEC_FROM | Call by reference | Type reference (TYPE) | GRFN_PERIOD_FROM | Job Step Execution Date From | 20100527 | ||
| 5 | Importing |
IV_EXEC_TO | Call by reference | Type reference (TYPE) | GRFN_PERIOD_FROM | Job Step Execution Date To | 20100527 | ||
| 6 | Importing |
IV_FREQUENCY | Call by reference | Type reference (TYPE) | GRFN_TF_FREQUENCY | Job Frequency | 20100527 | ||
| 7 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | BTCJOB | Job Name | 20100527 | ||
| 8 | Importing |
IV_MAXROWS | Call by reference | Type reference (TYPE) | GRFN_MAXROWS | 100 | Job Step max rows | 20100820 | |
| 9 | Importing |
IV_TARGET_CONN | Call by reference | Type reference (TYPE) | GRFN_CONNECTORID | Job Step Target Connector | 20100623 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100527 |
Method QUERY_BY_GROUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_JOBSTEP | Call by reference | Type reference (TYPE) | GRFN_T_API_JOBSTEP | Job Step Detail | 20100702 | ||
| 2 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100702 | ||
| 3 | Importing |
IV_GROUPID | Call by reference | Type reference (TYPE) | GRFN_NUMBER | Job Step Group ID | 20100702 | ||
| 4 | Importing |
IV_JOB_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Job ID | 20100702 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100702 |
Method QUERY_BY_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_JOBSTEP_ID | Call by reference | Type reference (TYPE) | GRFN_T_API_OBJECT_ID | Job Step Object ID table | 20100622 | ||
| 2 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100622 | ||
| 3 | Importing |
IT_JOBSTEP_STATUS | Call by reference | Type reference (TYPE) | GRFN_T_JOBSTEP_STATUS | Job Step Status | 20100622 | ||
| 4 | Importing |
IV_JOB_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20100622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100622 |
Method RETRIEVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_JOB | Call by reference | Type reference (TYPE) | GRFN_S_API_JOB | Job Detail | 20100707 | ||
| 2 | Exporting |
ES_JOBSTEP | Call by reference | Type reference (TYPE) | GRFN_S_API_JOBSTEP | Job Step Detail | 20100527 | ||
| 3 | Exporting |
ES_JOBSTEP_DEFICIENCY | Call by reference | Type reference (TYPE) | GRFN_S_JOBSTEP_DEFICIENCY | Job Step Result - Deficiency Count | 20100624 | ||
| 4 | Exporting |
ET_JOBSTEP_OLSP_SNP | Call by reference | Type reference (TYPE) | GRFN_T_JOBSTEP_OLSP_SNP | Job Step OLSP Snapshot | 20100713 | ||
| 5 | Exporting |
ET_JOBSTEP_RESULT | Call by reference | Type reference (TYPE) | GRFN_T_API_JOBSTEPRESULT | Job Step Result - Deficiency List | 20100624 | ||
| 6 | Exporting |
ET_JOBSTEP_RESULT_CONTEXT | Call by reference | Type reference (TYPE) | GRFN_T_JOBSTEP_CONTEXT_OBJECT | Job Step Context - Run Time Result | 20100701 | ||
| 7 | Exporting |
EV_JOBSTEP_CONTEXT | Call by reference | Type reference (TYPE) | GRFN_JOBSTEP_CONTEXT | Job Step Context - Design Time | 20100624 | ||
| 8 | Importing |
IV_EDITABLE | Call by reference | Type reference (TYPE) | GRFN_BOOLEAN | ABAP_FALSE | Boolean | 20100527 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100527 |
Method SEARCH_BY_CONTROL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_RESULT | Call by reference | Type reference (TYPE) | T_SEARCH_BY_CONTROL | 20100722 | |||
| 2 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100623 | ||
| 3 | Importing |
IV_CONTROL_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Control ID | 20100623 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100623 |
Method SUBMIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | SYSUBRC | 20120202 | |||
| 2 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | 20120202 | |||
| 3 | Importing |
IS_JOB | Call by reference | Type reference (TYPE) | GRFN_S_JOB_HEADER | 20120202 | |||
| 4 | Importing |
IT_JOBSTEP | Call by reference | Type reference (TYPE) | GRFN_T_JOBDETAIL_CREATE | 20120202 | |||
| 5 | Importing |
IV_NO_NEXT_JOBSTEP | Call by reference | Type reference (TYPE) | ABAP_BOOL | SPACE | 20120202 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
20120202 |
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_JOBSTEP_CHANGED | Call by reference | Type reference (TYPE) | GRFN_S_JOBSTEP_CHANGED | Job: Execution Result | 20100530 | ||
| 2 | Importing |
IV_EXEC_DATE | Call by reference | Type reference (TYPE) | GRFN_EXEC_DATE | Job Step: Execution date | 20100626 | ||
| 3 | Importing |
IV_EXEC_TIME | Call by reference | Type reference (TYPE) | GRFN_EXEC_TIME | Job Step: Execution time | 20100626 | ||
| 4 | Importing |
IV_GRC_JOBCOUNT | Call by reference | Type reference (TYPE) | BTCJOBCNT | SM37 Job ID - Local System | 20100531 | ||
| 5 | Importing |
IV_ISSUE_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Issue ID | 20100621 | ||
| 6 | Importing |
IV_RTA_JOBCOUNT | Call by reference | Type reference (TYPE) | GRFN_JOBCOUNT | SM37 Job ID - RTA | 20100530 | ||
| 7 | Importing |
IV_STATUS | Call by reference | Type reference (TYPE) | GRFN_JOBSTEPSTATUS | Job Step Status | 20100530 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100530 |
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 600 |
