General Methods (CL_APL_ECATT_API)
Use
This category contains the following methods:
CREATE_OBJECT
CREATE_OBJ creates an eCATT object in the specified system. The parameters are optional. If no values are specified for these parameters, the object is supplied with default values for these attributes. The method contains the following parameters:
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
IT_ATTR |
ETATTR_DESC_TABTYPE |
Table with attribute descriptions and values |
|
|
I_EXCEPTION_MODE |
ETONOFF |
'E' |
Mode E=Raise and Exit, C=Collect and Continue, I=Ignore |
|
I_PACKAGE |
ETTADIR-DEVCLASS |
Package |
|
|
I_TRANS_REQ |
E070-TRKORR |
Request/task |
|
|
I_PERS_RESP |
ET_RESP |
Person responsible |
|
|
I_WRITE_ENABLED |
ETONOFF |
'X' |
'X' = Open in change mode |
LOAD_OBJECT
This method is used to load an existing eCATT object to the memory area for processing. If the object is not found, an exception is raised.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_WRITE_ENABLED |
ETONOFF |
'X' |
'X' = Open in change mode |
|
I_EXCEPTION_MODE |
ETONOFF |
'E' |
Mode E=Raise and Exit, C=Collect and Continue, I=Ignore |
DELETE_OBJECT
This static method is used to delete an existing object.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
IS_OBJECT_ID |
ETAPI_OBJ |
eCATT object ID at API runtime |
|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
|
|
I_TRANS_REQ |
E070-TRKORR |
Request/task |
|
|
I_DELETE_ALL_VERSIONS |
ETONOFF |
'X' |
eCATT switch on/off |
|
I_COMMIT_WORK |
ETONOFF |
'X' |
Checkbox for COMMIT WORK |
|
E_LAST_VERSION_DELETED |
ETONOFF |
Deletes last script version |
RENAME_OBJECT
This method renames an existing eCATT object.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
IS_OBJECT_ID |
ETAPI_OBJ |
eCATT object ID at API runtime |
|
|
I_DEST_OBJ_NAME |
ETOBJ_NAME |
eCATT object name |
|
|
I_DEST_OBJECT_VERSION |
ETOBJ_VER |
eCATT object version |
|
|
I_PACKAGE |
ETTADIR-DEVCLASS |
Package |
|
|
I_TRANS_REQ |
E070-TRKORR |
Request/task |
|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
|
|
I_COMMIT_WORK |
ETONOFF |
'X' |
Checkbox for COMMIT WORK |
COPY_OBJECT
This method copies an eCATT object to a new object.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
IS_OBJECT_ID |
ETAPI_OBJ |
eCATT object ID at API runtime |
|
|
I_DEST_OBJ_NAME |
ETOBJ_NAME |
eCATT object name |
|
|
I_DEST_OBJECT_VERSION |
ETOBJ_VER |
eCATT object version |
|
|
I_PACKAGE |
ETTADIR-DEVCLASS |
Package |
|
|
I_TRANS_REQ |
E070-TRKORR |
Request/task |
|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
|
|
I_COMMIT_WORK |
ETONOFF |
'X' |
Checkbox for COMMIT WORK |
SAVE_OBJECT
This method saves changes to an eCATT object.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_TRANS_REQ |
E070-TRKORR |
Request/task |
|
|
I_SET_MODE |
ETONOFF |
SPACE |
'X' = Remove lock from object |
DOWNLOAD_OBJECT
This method downloads the eCATT object to a directory specified by the user.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
IS_OBJECT_ID |
ETAPI_OBJ |
eCATT object ID at API runtime |
|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
|
|
I_PATH |
STRING |
Path for saving downloaded file |
UPLOAD_OBJECT
This method is used to upload an eCATT object from a directory specified by the user. The upload object gets the name and the version of the runtime object that calls the method.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
IS_OBJECT |
ETAPI_OBJECTS |
Structure for mass processing functions for eCATT objects |
|
|
I_TRANS_REQ |
E070-TRKORR |
Request/task |
|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
|
|
I_COMMIT_WORK |
ETONOFF |
'X' |
Checkbox for COMMIT WORK |
|
I_PATH |
STRING |
Upload path |
DO_COMMIT
Executes BAPI_TRANSACTION_COMMIT on the RFC destination in the instance object.
DO_COMMIT_STATIC
Executes BAPI_TRANSACTION_COMMIT on the specified RFC destination.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
DO_ROLLBACK
Executes BAPI_TRANSACTION_ROLLBACK on the RFC destination in the instance object.
DO_ROLLBACK_STATIC
Executes BAPI_TRANSACTION_ROLLBACK on the specified RFC destination.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
EXISTENCE_CHECK
This method checks the existence of the specified eCATT object.
|
Parameter Name |
Type |
Default Value |
Description |
|---|---|---|---|
|
IS_OBJECT_ID |
ETAPI_OBJ |
eCATT object ID at API runtime |
|
|
I_OBJECT_RFCDEST |
RFCDEST |
Logical destination (specified in function call) |
|
|
E_OBJECT_EXIST |
ETONOFF |
Does eCATT object exist? Yes/No |
CLOSE_OBJECT
This method frees resources taken up by load and eCATT object use in the application layer.