IF_OO_ADT_CLASSRUN interface.
| Interface/Class | Details/Code Snippet |
IF_OO_ADT_CLASSRUN |
- By implementing the IF_OO_ADT_CLASSRUN interface in a global class, you can make the class executable.
- In ADT, you can execute the class using F9.
- The statements that are processed when executing the class can be included in the implementation of the `if_oo_adt_classrun~main` method.
- Using `out->write( ... ).` statements, you can output the content of data objects to the ADT console. The `name` parameter can be used to precede the data object content with a string.
``` abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. out->write( `Hello world` ). TYPES: BEGIN OF s, comp1 TYPE string, comp2 TYPE i, comp3 TYPE string_table, comp4 TYPE REF TO string, END OF s, it_type TYPE TABLE OF s WITH EMPTY KEY. DATA(struct) = VALUE s( comp1 = `Hello` comp2 = 1 comp3 = VALUE #( ( `a` ) ( `b` ) ( `a` ) ( `p` ) ) comp4 = NEW #( `world` ) ). DATA(itab) = VALUE it_type( ( struct ) ( comp1 = `Hi` comp2 = 2 comp3 = VALUE #( ( `x` ) ( `y` ) ( `z` ) ) comp4 = NEW #( `ABAP` ) ) ). out->write( struct ). out->write( data = itab name = `itab` ). ENDMETHOD. ENDCLASS. ``` |
CL_DEMO_CLASSRUN |
As an alternative to using the IF_OO_ADT_CLASSRUN interface for displaying output in the console, you can also use the CL_DEMO_CLASSRUN class, which offers more methods.
For more information, refer to this blog.
The following example makes use of the CL_DEMO_CLASSRUN class. A structure and an internal table are displayed in the console. A structure component is a reference variable, which is automatically dereferenced. Plus, the write_xml method is shown, which displays XML data.
``` abap CLASS zcl_demo_abap DEFINITION INHERITING FROM cl_demo_classrun PUBLIC CREATE PUBLIC. PUBLIC SECTION. METHODS main REDEFINITION. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD main. TYPES: BEGIN OF s, comp1 TYPE string, comp2 TYPE i, comp3 TYPE string_table, comp4 TYPE REF TO string, END OF s, it_type TYPE TABLE OF s WITH EMPTY KEY. DATA(struct) = VALUE s( comp1 = `Hello` comp2 = 1 comp3 = VALUE #( ( `a` ) ( `b` ) ( `a` ) ( `p` ) ) comp4 = NEW #( `world` ) ). DATA(itab) = VALUE it_type( ( struct ) ( comp1 = `Hi` comp2 = 2 comp3 = VALUE #( ( `x` ) ( `y` ) ( `z` ) ) comp4 = NEW #( `ABAP` ) ) ). out->write( struct ). out->write( itab ). DATA(some_xml) = cl_abap_conv_codepage=>create_out( )->convert( ` |
CL_XCO_CP_ADT_SIMPLE_CLASSRUN |
XCO alternative for output in the ADT console
``` abap CLASS zcl_demo_abap DEFINITION PUBLIC INHERITING FROM cl_xco_cp_adt_simple_classrun FINAL CREATE PUBLIC . PUBLIC SECTION. PROTECTED SECTION. METHODS: main REDEFINITION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD main. out->write( `Hello world` ). ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_SYSTEM_UUID |
Creating and and converting system UUIDs with various algorithms
``` abap TRY. "----------- Creating UUIDs ----------- "16 Byte System UUID in Binary Format "Example: 429A229A88021EDFB7E2E25DF99A8E73 DATA(uuid_x16) = cl_system_uuid=>create_uuid_x16_static( ). "16 Byte System UUID in Base64 "Example: GfeYceW27j{tuk9T{PgkSm DATA(uuid_c22) = cl_system_uuid=>create_uuid_c22_static( ). "16 Byte System UUID in Base32 "Example: IKNCFGUIAIPN7N7C4JO7TGWOOM DATA(uuid_c26) = cl_system_uuid=>create_uuid_c26_static( ). "16 Byte System UUID in Hex Format "Example: 429A229A88021EDFB7E2E25DF99AEE73 DATA(uuid_c32) = cl_system_uuid=>create_uuid_c32_static( ). "16 Byte System UUID in RFC4122 Format "Example: 429A229A-8802-1EDF-B7E2-E25DF99B0E73 DATA(uuid_c36) = cl_system_uuid=>create_uuid_c36_static( ). "----------- Converting UUIDs ----------- cl_system_uuid=>convert_uuid_x16_static( EXPORTING uuid = uuid_x16 IMPORTING uuid_c22 = DATA(x16_to_c22) uuid_c32 = DATA(x16_to_c32) uuid_c26 = DATA(x16_to_c26) uuid_c36 = DATA(x16_to_c36) ). cl_system_uuid=>convert_uuid_c22_static( EXPORTING uuid = uuid_c22 IMPORTING uuid_x16 = DATA(c22_to_x16) uuid_c32 = DATA(c22_to_c32) uuid_c26 = DATA(c22_to_c26) uuid_c36 = DATA(c22_to_c36) ). cl_system_uuid=>convert_uuid_c26_static( EXPORTING uuid = uuid_c26 IMPORTING uuid_x16 = DATA(c26_to_x16) uuid_c22 = DATA(c26_to_c22) uuid_c32 = DATA(c26_to_c32) uuid_c36 = DATA(c26_to_c36) ). cl_system_uuid=>convert_uuid_c32_static( EXPORTING uuid = uuid_c32 IMPORTING uuid_x16 = DATA(c32_to_x16) uuid_c22 = DATA(c32_to_c22) uuid_c26 = DATA(c32_to_c26) uuid_c36 = DATA(c32_to_c36) ). cl_system_uuid=>convert_uuid_c36_static( EXPORTING uuid = uuid_c36 IMPORTING uuid_x16 = DATA(c36_to_x16) uuid_c22 = DATA(c36_to_c22) uuid_c26 = DATA(c36_to_c26) uuid_c32 = DATA(c36_to_c32) ). CATCH cx_uuid_error INTO DATA(error). DATA(error_text) = error->get_text( ). ENDTRY. ``` |
XCO_CP XCO_CP_UUID |
Creating UUIDs and transforming between different UUID formats using XCO
``` abap "Creating UUIDs "Type sysuuid_x16 DATA(x16_uuid) = xco_cp=>uuid( )->value. "Other types using the 'as' method and providing a format "Note that a data object of type string is returned when using the 'value' attribute. DATA(c22_string) = xco_cp=>uuid( )->as( xco_cp_uuid=>format->c22 )->value. DATA(c32_string) = xco_cp=>uuid( )->as( xco_cp_uuid=>format->c32 )->value. DATA(c36_string) = xco_cp=>uuid( )->as( xco_cp_uuid=>format->c36 )->value. "Tranforming between different formats DATA(uuid_string_c36) = `429A229A-8802-1EDF-B7E2-E25DF99B0E73`. DATA(uuid_string_c32) = `429A229A88021EDFB7E2E25DF99B0E73`. DATA(uuid_x16) = xco_cp_uuid=>format->c36->to_uuid( uuid_string_c36 )->value. ASSERT uuid_x16 = uuid_string_c32. DATA(uuid_c32) = CONV sysuuid_c32( xco_cp_uuid=>format->c32->from_uuid( xco_cp_uuid=>format->c36->to_uuid( uuid_string_c36 ) ) ). ASSERT uuid_c32 = uuid_string_c32. uuid_x16 = xco_cp_uuid=>format->c32->to_uuid( uuid_string_c32 )->value. ASSERT uuid_x16 = uuid_string_c32. DATA(uuid_c36) = CONV sysuuid_c36( xco_cp_uuid=>format->c36->from_uuid( xco_cp_uuid=>format->c32->to_uuid( uuid_string_c32 ) ) ). ASSERT uuid_c36 = uuid_string_c36. ``` |
| Class | Details/Code Snippet |
CL_ABAP_BEHV_AUX |
A utility class for retrieving information about RAP handler implementations, such as the current context of RAP handler/saver methods, the handler kind, and the current RAP transactional phase (e.g., RAP interaction phase.
``` abap "Getting the current context of RAP handler implementations; "storing the information (true/false) in a variable declared inline cl_abap_behv_aux=>get_current_context( IMPORTING from_projection = FINAL(fr_proj) from_interface = FINAL(fr_int) in_local_mode = FINAL(loc_mode) draft_activate = FINAL(dr_act) for_permissions = FINAL(for_perm) privileged = FINAL(priv) ). "Getting the root entity name and handler kind "For the latter, you can check the fixed values of abp_behv_kind (e.g., 'R' stands for read) DATA ent TYPE abp_root_entity_name. FINAL(handler_kind) = cl_abap_behv_aux=>get_current_handler_kind( IMPORTING root_entity = ent ). "Getting information about the current transactional phase FINAL(phase) = cl_abap_behv_aux=>get_current_phase( ). "e.g. INTERACTION or EARLY_SAVE ``` |
CL_ABAP_BEHAVIOR_HANDLER |
Used for RAP handler classes that inherit from class CL_ABAP_BEHAVIOR_HANDLER.
``` abap "Skeleton of a RAP handler class declaration part in a CCIMP include CLASS lcl_handler DEFINITION INHERITING FROM cl_abap_behavior_handler. PRIVATE SECTION. ... "Here go RAP handler method declarations ENDCLASS. ... ``` |
CL_ABAP_BEHAVIOR_SAVER |
Used as base class from which a RAP saver class in an ABAP behavior pool (ABP) inherits. The RAP saver class must be defined in the CCIMP include of an ABP.
``` abap "Skeleton of a RAP saver class declaration part in a CCIMP include CLASS lsc_bdef DEFINITION INHERITING FROM cl_abap_behavior_saver. PROTECTED SECTION. METHODS finalize REDEFINITION. METHODS check_before_save REDEFINITION. METHODS save REDEFINITION. METHODS cleanup REDEFINITION. METHODS cleanup_finalize REDEFINITION. ENDCLASS. ... ``` |
CL_ABAP_BEHAVIOR_SAVER_FAILED |
``` abap "Skeleton of a RAP saver class declaration part in a CCIMP include CLASS lsc_bdef DEFINITION INHERITING FROM cl_abap_behavior_saver_failed. PROTECTED SECTION. ... METHODS save REDEFINITION. "Unlike in CL_ABAP_BEHAVIOR_SAVER, the RAP response parameters failed and reported are included. ... ENDCLASS. ... ``` |
CL_ABAP_BEHAVIOR_EVENT_HANDLER |
It is used as base class from which a RAP event handler class in its CCIMP include inherits. Its purpose is to locally consume RAP business events.
More information: ABAP for RAP Business Events.
``` abap "Skeleton of a RAP event handler class declaration part in a CCIMP include "The assumption is that there are the events 'created', 'updated', and "'deleted' specified in the BDEF. CLASS lhe_event DEFINITION INHERITING FROM cl_abap_behavior_event_handler. PRIVATE SECTION. METHODS on_updated FOR ENTITY EVENT updated FOR some_bdef~updated. METHODS on_deleted FOR ENTITY EVENT deleted FOR some_bdef~deleted. METHODS on_created FOR ENTITY EVENT created FOR some_bdef~created. ENDCLASS. ... ``` |
| Class | Details/Code Snippet |
CL_ABAP_TX |
``` abap ... "Activating the modify transactional phase cl_abap_tx=>modify( ). "The following database modification statement is not allowed in the "modify transactional phase. In certain contexts, e.g. in ABAP Cloud, "the runtime error BEHAVIOR_ILLEGAL_STMT_IN_CALL occurs. MODIFY zdemo_abap_carr FROM TABLE @( VALUE #( ( carrid = 'XY' carrname = 'XY Airlines' currcode = 'EUR' url = 'some_url' ) ) ). ... "Activating the save transactional phase cl_abap_tx=>save( ). "In this phase, database modifications are allowed. MODIFY zdemo_abap_carr FROM TABLE @( VALUE #( ( carrid = 'XY' carrname = 'XY Airlines' currcode = 'EUR' url = 'some_url' ) ) ). ... ``` |
| Class | Details/Code Snippet |
CL_ABAP_MATH |
For operations with (decimal) floating point numbers and for providing constants for minimum and maximum values.
``` abap "Constants for the minimum and maximum values of built-in numeric types "Example: Type i DATA(min_int4) = cl_abap_math=>min_int4. "-2147483648 DATA(max_int4) = cl_abap_math=>max_int4. "2147483647 "Rounding binary floating point number to 15 places using commercial rounding DATA flpnum TYPE f VALUE '1.005'. DATA(rd) = cl_abap_math=>round_f_to_15_decs( flpnum ). "1.005000000000001E0 DATA(str2dcm) = |{ flpnum DECIMALS = 2 }|. "1.00 DATA(str2dcm_rd) = |{ cl_abap_math=>round_f_to_15_decs( flpnum ) DECIMALS = 2 }|. "1.01 "Properties of decimal floating point numbers "Example: 98.765; an integer with fixed precision, i.e. a given length (the length of 98765), "which is scaled by dividing through a power of 10 (10 powered by n, representing "the number of decimal places; in the example, the scaling is the negative exponent) DATA(decf) = CONV decfloat34( '98.765' ). DATA(scale) = cl_abap_math=>get_scale( decf ). "3 DATA(precision) = cl_abap_math=>get_number_of_digits( decf ). "5 ``` |
CL_ABAP_DECFLOAT |
For handling decimal floating point numbers.
``` abap "Converting currency amounts to decimal floating point numbers using a "a currency key. The reverse is also possible. DATA(dec) = CONV decfloat34( '12340' "'123.456' ). DATA pdec TYPE p LENGTH 9 DECIMALS 2. cl_abap_decfloat=>convert_decfloat_to_curr( EXPORTING amount_decfloat = dec cuky = 'EUR' IMPORTING amount_curr = pdec ) . "12340.0 "123.46 "Converting strings to decimal floating point numbers "The character string is converted to a value of type decfloat34, "which is passed back in VALUE. DATA dcfl34 TYPE decfloat34. DATA return_code TYPE i. DATA str TYPE string VALUE `1234.8652`. TRY. cl_abap_decfloat=>read_decfloat34( EXPORTING string = str IMPORTING value = dcfl34 rc = return_code ). CATCH cx_sy_conversion_overflow cx_abap_decfloat_invalid_char cx_abap_decfloat_parse_err. ENDTRY. ``` |
CL_ABAP_BIGINT |
For calculations with integers of any size (e.g. to avoid the risk of an arithmetic overflow). Find more information in
this blog, and check out the different methods available.
``` abap "Creating an arbitrary precision integer from a variable of type i "and calculating the power; converting the result to string DATA(pow1) = cl_abap_bigint=>factory_from_int4( 10 )->pow( 10 )->to_string( ). "Comparison with integer value (the maximum value of type i; see the class above) DATA(compare_i) = cl_abap_bigint=>factory_from_int4( 10 )->pow( 10 )->compare_int4( cl_abap_math=>max_int4 ). "LARGER "10000000000 (result) "2147483647 (maximum value for type i) "Comparison with the ipow function (here, an exception is raised) TRY. DATA(pow2) = ipow( base = 10 exp = 10 ). CATCH cx_sy_arithmetic_overflow. ENDTRY. ``` |
CL_ABAP_RATIONAL |
For calculations with rational numbers without precision loss and rounding errors.
``` abap "Creating a rational number from a string DATA(rat_num) = cl_abap_rational=>factory_from_string( EXPORTING iv_value = `-1/3` ). "Performing an addition and converting the result to string DATA(addition_res) = rat_num->add( cl_abap_rational=>factory_from_string( EXPORTING iv_value = `3/2` ) )->to_string( ). "7/6 ``` |
CL_ABAP_RANDOM* |
For generating arbitrary numbers for different numeric types:
CL_ABAP_RANDOM_INT (type i),
CL_ABAP_RANDOM_INT8 (int8),
CL_ABAP_RANDOM_FLOAT (f),
CL_ABAP_RANDOM_PACKED (p),
CL_ABAP_RANDOM_PACKED_DEC1 - CL_ABAP_RANDOM_PACKED_DEC14 (p with 1 to 14 decimal places),
CL_ABAP_RANDOM_DECFLOAT16 (decfloat16),
CL_ABAP_RANDOM_DECFLOAT34 (decfloat34)
``` abap "Getting multiple random integers that are to be stored in an "internal table of type i TYPES int_tab_type TYPE TABLE OF i WITH EMPTY KEY. DATA int_tab TYPE int_tab_type. "The optional parameters are explicitly specified in the example; "'seed' represents the initial starting number, you can use "'cl_abap_random=>seed( )' to specify an arbitrary start value DATA(random_num1) = cl_abap_random_int=>create( seed = cl_abap_random=>seed( ) min = 1 max = 100 ). DO 3 TIMES. APPEND random_num1->get_next( ) TO int_tab. ENDDO. "Getting a random integer in one go using method chaining DATA(random_num2) = cl_abap_random_int=>create( seed = cl_abap_random=>seed( ) min = 100 max = 1000 )->get_next( ). ``` The following example explores the generation of arbitrary numeric values. - It uses dynamic programming techniques. Find more information in the [Dynamic Programming](06_Dynamic_Programming.md) cheat sheet. - The class names are constructed dynamically. They all begin with `CL_ABAP_RANDOM_`. - An object is created dynamically based on the constructed class name. - This object is assigned the result of a dynamic method call. The error handling is included as the `min` and `max` parameters are not available for all methods. - The `get_next` method returns an appropriately typed data object, e.g. in case of `CL_ABAP_RANDOM_DECFLOAT34`, a data object of type `decfloat34` is returned. As a generic returning parameter is not possible, the example uses a data object of type `string`. So, the value returned is converted to type `string`. Note that are special conversion rules (e.g. the minus character for negative values are added at the end by default). - The resulting string values are added to an internal table for display purposes. - The example also includes static method calls. ```abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. TYPES: BEGIN OF random_values, class TYPE string, random_value TYPE string, END OF random_values. DATA random_value_table TYPE TABLE OF random_values WITH EMPTY KEY. DATA(cl_name_parts) = VALUE string_table( ( `DECFLOAT16` ) ( `DECFLOAT34` ) ( `FLOAT` ) ( `INT` ) ( `INT8` ) ( `PACKED` ) ( `PACKED_DEC` ) ). LOOP AT cl_name_parts INTO DATA(wa). IF wa CS `PACKED_DEC`. FIND PCRE `\d` IN wa. IF sy-subrc <> 0. DELETE cl_name_parts INDEX sy-tabix. DO 14 TIMES. APPEND wa && sy-index TO cl_name_parts. ENDDO. CONTINUE. ENDIF. ENDIF. DATA(cl_name) = `CL_ABAP_RANDOM_` && wa. DATA oref TYPE REF TO object. TRY. CALL METHOD (cl_name)=>create EXPORTING seed = cl_abap_random=>seed( ) min = 1 max = 1000 RECEIVING prng = oref. CATCH cx_sy_dyn_call_param_not_found. CALL METHOD (cl_name)=>create EXPORTING seed = cl_abap_random=>seed( ) RECEIVING prng = oref. ENDTRY. DATA value_conv2string TYPE string. CALL METHOD oref->('GET_NEXT') RECEIVING value = value_conv2string. APPEND VALUE #( class = cl_name random_value = value_conv2string ) TO random_value_table. ENDLOOP. out->write( random_value_table ). DATA(a) = cl_abap_random_decfloat16=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(b) = cl_abap_random_decfloat34=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(c) = cl_abap_random_float=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(d) = cl_abap_random_int=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(e) = cl_abap_random_int8=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(f) = cl_abap_random_packed=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(g) = cl_abap_random_packed_dec1=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(h) = cl_abap_random_packed_dec2=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(i) = cl_abap_random_packed_dec3=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(j) = cl_abap_random_packed_dec4=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(k) = cl_abap_random_packed_dec5=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(l) = cl_abap_random_packed_dec6=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(m) = cl_abap_random_packed_dec7=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(n) = cl_abap_random_packed_dec8=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(o) = cl_abap_random_packed_dec9=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(p) = cl_abap_random_packed_dec10=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(q) = cl_abap_random_packed_dec11=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(r) = cl_abap_random_packed_dec12=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(s) = cl_abap_random_packed_dec13=>create( seed = cl_abap_random=>seed( ) )->get_next( ). DATA(t) = cl_abap_random_packed_dec14=>create( seed = cl_abap_random=>seed( ) )->get_next( ). ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_ABAP_CHAR_UTILITIES |
Provides utilities for string processing, such as attributes that represent new lines and horizontal tabs.
``` abap DATA(tabbed) = `#` && cl_abap_char_utilities=>horizontal_tab && `#`. "The following attributes can be replaced by a representation of "the control characters in a string template. ASSERT cl_abap_char_utilities=>newline = |\n|. ASSERT cl_abap_char_utilities=>horizontal_tab = |\t|. ASSERT cl_abap_char_utilities=>cr_lf = |\r\n|. ``` |
CL_ABAP_STRING_UTILITIES |
For processing text strings, such as handling trailing blanks in character strings (i.e. data objects of type string).
``` abap DATA(string) = `ABAP `. "Removing trailing blanks cl_abap_string_utilities=>del_trailing_blanks( CHANGING str = string ). "`ABAP` "Preserving trailing blanks when assigning text fields to data objects of "type string DATA(chars) = 'ABAP '. cl_abap_string_utilities=>c2str_preserving_blanks( EXPORTING source = chars IMPORTING dest = DATA(str_w_blanks) ). "`ABAP ` DATA(str_no_blanks) = CONV string( chars ). "`ABAP` ``` |
XCO_CP |
Offers various options to process strings using the XCO Library; see a selection in the code snippet
``` abap "--------- Extracting a substring from a string --------- DATA(some_string) = `abcdefghijklmnopqrstuvwxyz`. "Creating an encapsulation of a string using XCO DATA(str) = xco_cp=>string( some_string ). "Using the FROM and TO methods, you can determine "the character position. Note that the value includes the "character at the position specified. "The character index pattern for the example string above "is (the string has 26 characters in total): "a = 1, b = 2, c = 3 ... z = 26 "a = -26, b = -25, c = -24 ... z = -1 "Providing a value that is out of bounds means that "the first (or the last) character of the string is used "by default. "Note: When combining FROM and TO, e.g. with method "chaining ...->from( ...)->to( ... ), note that another "instance is created with the first 'from', and another "character index pattern is created based on the new "and adjusted string value. "bcdefghijklmnopqrstuvwxyz DATA(sub1) = str->from( 2 )->value. "defghijklmnopqrstuvwxyz DATA(sub2) = str->from( -23 )->value. "vwxyz DATA(sub3) = str->from( -5 )->value. "abcde DATA(sub4) = str->to( 5 )->value. "ab DATA(sub5) = str->to( -25 )->value. "Result of 1st 'from' method call: bcdefghijklmnopqrstuvwxyz "Based on this result, the 'to' method call is "applied. "bcdefg DATA(sub6) = str->from( 2 )->to( 6 )->value. "Result of 1st 'to' method call: abcdefghijklmnopq "Based on this result, the 'from' method call is "applied. "defghijklmnopq DATA(sub7) = str->to( -10 )->from( 4 )->value. "Values that are out of bounds. "In the example, the first and last character of the "string are used. "abcdefghijklmnopqrstuvwxyz DATA(sub8) = str->from( 0 )->to( 100 )->value. "--------- Splitting and joining --------- "Splitting a string into a string table DATA(str_table) = xco_cp=>string( `Hello.World.ABAP` )->split( `.` )->value. "Hello "World "ABAP "Concatenating a string table into a string; specifying a delimiter str_table = VALUE #( ( `a` ) ( `b` ) ( `c` ) ). "a, b, c DATA(conc_str1) = xco_cp=>strings( str_table )->join( `, ` )->value. "Concatenating a string table into a string; specifying a delimiter and "reversing the table order "c / b / a DATA(conc_str2) = xco_cp=>strings( str_table )->reverse( )->join( ` / ` )->value. "--------- Prepending and appending strings --------- DATA(name) = xco_cp=>string( `Max Mustermann` ). "Max Mustermann, Some Street 1, 12345 Someplace DATA(address) = name->append( `, Some Street 1, 12345 Someplace` )->value. "Mr. Max Mustermann DATA(title) = name->prepend( `Mr. ` )->value. "--------- Transforming to lowercase and uppercase --------- "ABAP DATA(to_upper) = xco_cp=>string( `abap` )->to_upper_case( )->value. "hallo world DATA(to_lower) = xco_cp=>string( `HALLO WORLD` )->to_lower_case( )->value. "--------- Checking if a string starts/ends with a specific string --------- DATA check TYPE string. DATA(str_check) = xco_cp=>string( `Max Mustermann` ). "yes IF str_check->ends_with( `mann` ). check = `yes`. ELSE. check = `no`. ENDIF. "no IF str_check->starts_with( `John` ). check = `yes`. ELSE. check = `no`. ENDIF. "--------- Matching string against regular expression --------- DATA match TYPE string. "yes IF xco_cp=>string( ` 1` )->matches( `\s\d` ). match = 'yes'. ELSE. match = 'no'. ENDIF. "no IF xco_cp=>string( ` X` )->matches( `\s\d` ). match = 'yes'. ELSE. match = 'no'. ENDIF. ``` |
| Class | Details/Code Snippet |
CL_ABAP_GZIP* |
(De)compressing character strings and byte strings using GZIP:
CL_ABAP_GZIP,
CL_ABAP_GZIP_BINARY_STREAM,
CL_ABAP_GZIP_TEXT_STREAM,
CL_ABAP_UNGZIP_BINARY_STREAM,
CL_ABAP_UNGZIP_TEXT_STREAM
``` abap "------- (De)compressing binary data ------- DATA(str) = `This is a data object of type string. It should be converted to xstring, compressed and decompressed.`. DATA(xstr) = cl_abap_conv_codepage=>create_out( )->convert( str ). DATA xstr_comp TYPE xstring. "Compressing binary data TRY. cl_abap_gzip=>compress_binary( EXPORTING raw_in = xstr IMPORTING gzip_out = xstr_comp ). CATCH cx_parameter_invalid_range cx_sy_buffer_overflow cx_sy_compression_error. ENDTRY. "Comparing the length of the data objects DATA(len_xstr) = xstrlen( xstr ). "101 DATA(len_xstr_comp) = xstrlen( xstr_comp ). "81 "Decompressing binary data DATA xstr_decomp TYPE xstring. TRY. cl_abap_gzip=>decompress_binary( EXPORTING gzip_in = xstr_comp IMPORTING raw_out = xstr_decomp ). CATCH cx_parameter_invalid_range cx_sy_buffer_overflow cx_sy_compression_error. ENDTRY. DATA(len_xstr_decomp) = xstrlen( xstr_decomp ). "101 DATA(conv_str) = cl_abap_conv_codepage=>create_in( )->convert( xstr_decomp ). "abap_true DATA(is_equal) = xsdbool( len_xstr = len_xstr_decomp AND str = conv_str ). "------- (De)compressing character strings ------- DATA zipped TYPE xstring. TRY. cl_abap_gzip=>compress_text( EXPORTING text_in = `Hello world` IMPORTING gzip_out = zipped ). CATCH cx_parameter_invalid_range cx_sy_buffer_overflow cx_sy_conversion_codepage cx_sy_compression_error. ENDTRY. DATA txt TYPE string. TRY. cl_abap_gzip=>decompress_text( EXPORTING gzip_in = zipped IMPORTING text_out = txt ). CATCH cx_parameter_invalid_range cx_sy_buffer_overflow cx_sy_conversion_codepage cx_sy_compression_error. ENDTRY. ASSERT txt = `Hello world`. ``` |
CL_ABAP_CONV_CODEPAGE |
For handling code pages, converting strings to the binary representation of different code pages and vice versa.
``` abap DATA(hi) = `Hello world`. "string -> xstring "Note: UTF-8 is used by default. Here, it is specified explicitly. TRY. DATA(conv_xstring) = cl_abap_conv_codepage=>create_out( codepage = `UTF-8` )->convert( hi ). CATCH cx_sy_conversion_codepage. ENDTRY. "48656C6C6F20776F726C64 "xstring -> string DATA(conv_string) = cl_abap_conv_codepage=>create_in( )->convert( conv_xstring ). "Hello world ``` |
XCO_CP |
Converting strings to xstrings using a codepage using the XCO Library
``` abap "536F6D6520737472696E67 DATA(xstr) = xco_cp=>string( `Some string` )->as_xstring( xco_cp_character=>code_page->utf_8 )->value. "Some string DATA(str) = xco_cp=>xstring( xstr )->as_string( xco_cp_character=>code_page->utf_8 )->value. ``` |
XCO_CP |
Base64 decoding/encoding using XCO
``` abap DATA(a_string) = `Hello world`. "string -> xstring "Result: 48656C6C6F20776F726C64 DATA(conv_xstring) = xco_cp=>string( a_string )->as_xstring( xco_cp_character=>code_page->utf_8 )->value. "Encoding of raw binary data into its Base64 representation "Result: SGVsbG8gd29ybGQ= DATA(raw2base64) = xco_cp=>xstring( conv_xstring )->as_string( xco_cp_binary=>text_encoding->base64 )->value. "Decoding of a Base64 representation into raw binary data "Result: 48656C6C6F20776F726C64 DATA(base642raw) = xco_cp=>string( raw2base64 )->as_xstring( xco_cp_binary=>text_encoding->base64 )->value. "xstring -> string "Result: Hello world DATA(conv_string_xco) = xco_cp=>xstring( base642raw )->as_string( xco_cp_character=>code_page->utf_8 )->value. ``` |
CL_WEB_HTTP_UTILITY |
Endcoding strings/xstrings in Base64 and decoding Base64-encoded strings/xstrings
``` abap DATA(hi) = `Hello world`. "Encoding a string in BASE64 "Result is of type string "SGVsbG8gd29ybGQ= DATA(encode_base64_str) = cl_web_http_utility=>encode_base64( unencoded = hi ). "Decoding a base64-encoded String "Result is of type string "Hello world DATA(decode_base64_str) = cl_web_http_utility=>decode_base64( encoded = encode_base64_str ). ********************************************************************** "string -> xstring "48656C6C6F20776F726C64 DATA(conv_xstring) = cl_abap_conv_codepage=>create_out( codepage = `UTF-8` )->convert( hi ). "Encoding an xstring in BASE64 "Result is of type string "SGVsbG8gd29ybGQ= DATA(encode_base64_xstr) = cl_web_http_utility=>encode_x_base64( unencoded = conv_xstring ). "Decoding a base64-encoded xstring "48656C6C6F20776F726C64 DATA(decode_base64_xstr) = cl_web_http_utility=>decode_x_base64( encoded = encode_base64_xstr ). "xstring -> string "Hello world DATA(conv_string) = cl_abap_conv_codepage=>create_in( )->convert( decode_base64_xstr ). ``` |
| Class | Details/Code Snippet | CL_ABAP_REGEX CL_ABAP_MATCHER |
``` abap "Example string DATA(str) = `a1 # B2 ? cd . E3`. "----------- Creating an instance of a regular expression ----------- "Creating an instance of a regular expression with PCRE syntax "using cl_abap_regex "Example pattern: Any-non digit followed by a digit DATA(regex) = cl_abap_regex=>create_pcre( pattern = `\D\d` ignore_case = abap_true ). "----------- Creating matchers ----------- "Two ways are possible (both ways return references of type "ref to cl_abap_matcher): "- create_matcher method of the cl_abap_regex class "- create_pcre method of the cl_abap_matcher class "Note that several importing parameters are available to enable "further settings of the regular expression, e.g. ignoring the "case, using the extended mode, etc. The example pass a string "to the 'text' parameter. You can also specify internal tables "with the 'table' parameter and more. "Creating a matcher using the create_matcher method of the cl_abap_regex class DATA(matcher_1) = regex->create_matcher( text = str ). "Creating a matcher in one go using method chaining DATA(matcher_2) = cl_abap_regex=>create_pcre( pattern = `\D\d` ignore_case = abap_true )->create_matcher( text = str ). "Creating a matcher using the create_pcre method of the cl_abap_matcher class DATA(matcher_3) = cl_abap_matcher=>create_pcre( pattern = `\D\d` text = str ignore_case = abap_true ). "----------- Exploring searching and replacing ----------- "--- Finding all occurrences using the find_all method --- "In the example, result has the type match_result_tab containing the findings. DATA(result_fa1) = matcher_1->find_all( ). *LINE OFFSET LENGTH SUBMATCHES *0 0 2 OFFSET LENGTH * *0 5 2 OFFSET LENGTH * *0 15 2 OFFSET LENGTH DATA(result_fa2) = matcher_2->find_all( ). ASSERT result_fa2 = result_fa1. "Getting the result in one go using method chaining with cl_abap_matcher DATA(result_fa3) = cl_abap_matcher=>create_pcre( pattern = `\D\d` text = str ignore_case = abap_true )->find_all( ). ASSERT result_fa3 = result_fa1. "--- Example with submatches --- str = `XabcdXXefgXXhXXijklmnXX`. DATA(result_fa4) = cl_abap_matcher=>create_pcre( pattern = `X(.*?)X` text = str ignore_case = abap_true )->find_all( ). *LINE OFFSET LENGTH SUBMATCHES *0 0 6 OFFSET LENGTH * 1 4 *0 6 5 OFFSET LENGTH * 7 3 *0 11 3 OFFSET LENGTH * 12 1 *0 14 8 OFFSET LENGTH * 15 6 "--- Replacing all occurrences using the 'replace_all' method --- DATA(matcher_repl_1) = cl_abap_regex=>create_pcre( pattern = `X(.*?)X` )->create_matcher( text = str ). "4 DATA(repl_count_1) = matcher_repl_1->replace_all( newtext = `#$1#` ). "#abcd##efg##h##ijklmn#X DATA(repl_result_1) = matcher_repl_1->text. "Using cl_abap_matcher DATA(matcher_repl_2) = cl_abap_matcher=>create_pcre( pattern = `X(.*?)X` text = str ). DATA(repl_count_2) = matcher_repl_2->replace_all( newtext = `#$1#` ). DATA(repl_result_2) = matcher_repl_2->text. "---- Sequential processing of the regular expression --- "---- using the find_next method ------------------------ "The example explores various other methods, and writes "information to a string table. str = `a1bc2def3ghij45klm67opqr8stuvwx90yz`. DATA(matcher_fn) = cl_abap_matcher=>create_pcre( pattern = `\d(\D.)` text = str ). DATA strtab TYPE string_table. WHILE matcher_fn->find_next( ) = abap_true. APPEND |---- Finding { sy-index } -----| TO strtab. "Type match_result DATA(match_result) = matcher_fn->get_match( ). DATA(offset) = matcher_fn->get_offset( ). DATA(length) = matcher_fn->get_length( ). DATA(matched_content) = str+offset(length). APPEND |Match offset: { offset }| TO strtab. APPEND |Match length: { length }| TO strtab. APPEND |Match content: { matched_content }| TO strtab. "Type match_result DATA(subgroup) = matcher_fn->get_match( )-submatches. LOOP AT subgroup INTO DATA(wa). DATA(sub_tabix) = sy-tabix. DATA(submatch_line) = wa. DATA(submatch_offset) = wa-offset. DATA(submatch_length) = wa-length. DATA(submatch) = matcher_fn->get_submatch( sub_tabix ). APPEND |Submatch { sub_tabix } offset: { submatch_offset }| TO strtab. APPEND |Submatch { sub_tabix } length: { submatch_length }| TO strtab. APPEND |Submatch { sub_tabix } content: { submatch }| TO strtab. ENDLOOP. ENDWHILE. "---- Using an object of type cl_abap_regex in ABAP --- "---- statements with the REGEX addition -------------- DATA(result_find_all_1) = cl_abap_matcher=>create_pcre( pattern = `\d(\D.)` text = str )->find_all( ). DATA(result_find_all_2) = cl_abap_regex=>create_pcre( pattern = `\d(\D.)` )->create_matcher( text = str )->find_all( ). DATA(reg_expr) = cl_abap_regex=>create_pcre( pattern = `\d(\D.)` ). FIND ALL OCCURRENCES OF REGEX reg_expr IN str RESULTS DATA(result_find_all_3). *LINE OFFSET LENGTH SUBMATCHES *0 1 3 OFFSET LENGTH * 2 2 *0 4 3 OFFSET LENGTH * 5 2 *0 8 3 OFFSET LENGTH * 9 2 *0 14 3 OFFSET LENGTH * 15 2 *0 19 3 OFFSET LENGTH * 20 2 *0 24 3 OFFSET LENGTH * 25 2 *0 32 3 OFFSET LENGTH * 33 2 ASSERT result_find_all_3 = result_find_all_1. ASSERT result_find_all_3 = result_find_all_2. "Note that the REGEX addition is obsolete when using (POSIX) syntax patterns "A syntax warning is displayed for the following example. "FIND ALL OCCURRENCES OF REGEX `\d(\D.)` IN str RESULTS DATA(result_8). "The syntax warning can be suppressed using a pragma FIND ALL OCCURRENCES OF REGEX `\d(\D.)` IN str RESULTS DATA(result_find_all_4) ##REGEX_POSIX. "Using PCRE instead FIND ALL OCCURRENCES OF PCRE `\d(\D.)` IN str RESULTS DATA(result_find_all_5). ASSERT result_find_all_5 = result_find_all_3. "---------------- Exploring more parameters of the create_pcre method ---------------- "See the class documentation for more parameters and information. "--- enable_multiline parameter --- str = |abc\ndef\nghi\njkl|. DATA(matcher_no_ml) = cl_abap_matcher=>create_pcre( pattern = `^` text = str ). "1 DATA(repl_count_no_ml) = matcher_no_ml->replace_all( newtext = `#` ). "|#abc\ndef\nghi\njkl| DATA(repl_result_no_ml) = matcher_no_ml->text. DATA(matcher_w_ml) = cl_abap_matcher=>create_pcre( pattern = `^` text = str enable_multiline = abap_true ). "4 DATA(repl_count_w_ml) = matcher_w_ml->replace_all( newtext = `#` ). "|#abc\n#def\n#ghi\n#jkl| DATA(repl_result_w_ml) = matcher_w_ml->text. "--- table/ignore_case parameters --- data(str_table) = VALUE string_table( ( `abZdez` ) ( `zZfghZ` ) ( `ijkZZz` ) ( `zzzzZ` ) ). DATA(matcher_tab) = cl_abap_matcher=>create_pcre( pattern = `z+` table = str_table ignore_case = abap_true ). "6 DATA(repl_count_tab) = matcher_tab->replace_all( newtext = `#` ). "ab#de# / #fgh# / ijk# / # DATA(repl_result_tab) = matcher_tab->table. "--- extended parameter --- str = `abc def`. DATA(matcher_w_extended) = cl_abap_matcher=>create_pcre( pattern = `abc def` text = str ). "No replacement in the following example as the extended mode is "enabled by default. "0 DATA(repl_count_w_extended) = matcher_w_extended->replace_all( newtext = `#` ). "abc def DATA(repl_result_w_extended) = matcher_w_extended->text. "Disabling the extended mode so that whitespaces are not ignored DATA(matcher_not_extended) = cl_abap_matcher=>create_pcre( pattern = `abc def` text = str extended = abap_false ). "1 DATA(repl_count_not_extended) = matcher_not_extended->replace_all( newtext = `#` ). "# DATA(repl_result_not_extended) = matcher_not_extended->text. ``` |
| Class | Details/Code Snippet |
CL_ABAP_CONTEXT_INFO |
Provides context information relevant to the current ABAP session.
``` abap "Getting the current date in UTC (not the system or user time), e.g. 20240101 DATA(sys_date) = cl_abap_context_info=>get_system_date( ). "Getting the current time in UTC, e.g. 152450 DATA(sys_time) = cl_abap_context_info=>get_system_time( ). ``` |
CL_ABAP_DATFM |
For conversions between the external and the internal representation of a date specification
``` abap DATA(date4conversion) = CONV d( '20240202' ). DATA conv_date_str TYPE string. DATA conv_date_d TYPE d. DATA date_format TYPE cl_abap_datfm=>ty_datfm. "Conversion of d (internal) to string (external time format) TRY. cl_abap_datfm=>conv_date_int_to_ext( EXPORTING im_datint = date4conversion im_datfmdes = cl_abap_datfm=>get_datfm( ) IMPORTING ex_datext = conv_date_str ex_datfmused = date_format ). CATCH cx_abap_datfm_format_unknown. ENDTRY. "Conversion of string (external) to d (internal time format) TRY. cl_abap_datfm=>conv_date_ext_to_int( EXPORTING im_datext = conv_date_str im_datfmdes = date_format IMPORTING ex_datint = conv_date_d ex_datfmused = date_format ). CATCH cx_abap_datfm_no_date cx_abap_datfm_invalid_date cx_abap_datfm_format_unknown cx_abap_datfm_ambiguous. ENDTRY. ``` |
CL_ABAP_TIMEFM |
For conversions between the external and the internal representation of a time specification
``` abap DATA(time4conversion) = CONV t( '123456' ). DATA conv_time_str TYPE string. DATA conv_time_t TYPE t. "Conversion of t (internal) to string (external time format) TRY. cl_abap_timefm=>conv_time_int_to_ext( EXPORTING time_int = time4conversion without_seconds = abap_false format_according_to = cl_abap_timefm=>iso IMPORTING time_ext = conv_time_str ). CATCH cx_parameter_invalid_range. ENDTRY. "Conversion of string (external) to t (internal time format) TRY. cl_abap_timefm=>conv_time_ext_to_int( EXPORTING time_ext = conv_time_str IMPORTING time_int = conv_time_t ). CATCH cx_abap_timefm_invalid. ENDTRY. ``` |
CL_ABAP_UTCLONG |
For handling time stamps in time stamp fields (data objects with type utclong).
``` abap "utclong_current: Using the built-in function to create a UTC time stamp DATA(low_timestamp) = utclong_current( ). "utclong_add: Using the built-in function to create a UTC time stamp and "adding time values DATA(high_timestamp) = utclong_add( val = low_timestamp days = 1 hours = 2 minutes = 3 seconds = 4 ). "diff: Calculating time differences "In the example, the returned values correspond to the ones added above. cl_abap_utclong=>diff( EXPORTING high = high_timestamp low = low_timestamp IMPORTING days = DATA(days) hours = DATA(hours) minutes = DATA(minutes) seconds = DATA(seconds) ). "read: Reading a time stamp from a string DATA(ts) = |{ utclong_current( ) TIMESTAMP = ENVIRONMENT TIMEZONE = 'UTC' }|. TRY. cl_abap_utclong=>read( EXPORTING string = ts timezone = 'UTC' IMPORTING value = DATA(utc_ts) ). CATCH cx_abap_utclong_invalid. ENDTRY. "e.g. 2024-01-01T13:01:54.546134Z ``` |
CL_ABAP_TSTMP |
For calculating and converting time stamps in packed numbers (types timestamp and timestampl)
``` abap "Creating a time stamp of type timestamp (the inline creation creates "a data object with that type by default) GET TIME STAMP FIELD DATA(ts1). "e.g. 20240101131220 "Calculations for time stamps in packed numbers "Adding 1 hour DATA(ts2) = cl_abap_tstmp=>add( tstmp = ts1 secs = 3600 ). "e.g. 20240101141220.0000000 "Subtracting 2 hours DATA(ts3) = cl_abap_tstmp=>subtractsecs( tstmp = ts1 secs = 7200 ). "e.g. 20240101111220.0000000 "Type timestampl DATA tsl1 TYPE timestampl. GET TIME STAMP FIELD tsl1. "e.g. 20240101131701.3309040 "Converting type timestampl to timestamp DATA(ts4) = cl_abap_tstmp=>move_to_short( tsl1 ). "e.g. 20240101131701 "Converting types timestamp/timestampl to UTCLONG DATA(ts2utcl) = cl_abap_tstmp=>tstmp2utclong( tsl1 ). "e.g. 2024-01-01 13:19:23.8622560 "Converting type utclong to timestamp DATA(utcl2ts) = cl_abap_tstmp=>utclong2tstmp_short( ts2utcl ). "e.g. 20240101132231 "Converting type utclong to timestampl DATA(utcl2tsl) = cl_abap_tstmp=>utclong2tstmp( ts2utcl ). "e.g. 20240101132231.0667200 ``` |
XCO_CP_TIME |
Class of the XCO time library that provides abstractions for getting and working with date and time information. Find more details here.
``` abap "Creating a time stamp "As a result (which is also true for other results below), "you get a handler with which you can get further information "(check the options following '->'). DATA(m_moment) = xco_cp_time=>moment( iv_year = '2024' iv_month = '01' iv_day = '01' iv_hour = '12' iv_minute = '34' iv_second = '55' ). "Getting the created time stamp as a string "20240101123455 DATA(m2_moment_string) = m_moment->as( xco_cp_time=>format->abap )->value. "... and with other formats applied. "20240101T123455 DATA(m3_moment_format_a) = m_moment->as( xco_cp_time=>format->iso_8601_basic )->value. "2024-01-01T12:34:55 DATA(m4_moment_format_b) = m_moment->as( xco_cp_time=>format->iso_8601_extended )->value. "Getting user time zone "e.g. UTC DATA(m1_user_time_zone) = xco_cp_time=>time_zone->user->value. "Getting the current moment in the time zone of the current user "e.g. 2024-01-01T08:54:39 DATA(m5_cur_moment4user) = xco_cp=>sy->moment( xco_cp_time=>time_zone->user )->as( xco_cp_time=>format->iso_8601_extended )->value. "Current moment in UTC "e.g. 2024-01-01T08:54:39 (result is the same as above in the case of the cheat sheet example) DATA(m6_cur_moment_utc) = xco_cp=>sy->moment( xco_cp_time=>time_zone->utc )->as( xco_cp_time=>format->iso_8601_extended )->value. "Current UNIX timestamp "e.g. 1703863291 DATA(m7_unix_tstmp) = xco_cp=>sy->unix_timestamp( )->value. "For the time stamp, you can also use the TIME method "e.g. 10:27:59 DATA(m8_time) = xco_cp=>sy->time( xco_cp_time=>time_zone->user )->as( xco_cp_time=>format->iso_8601_extended )->value. "Getting second, minute, hour information "e.g. 59 DATA(m9_seconds) = xco_cp=>sy->time( xco_cp_time=>time_zone->user )->second. "e.g. 27 DATA(m10_minutes) = xco_cp=>sy->time( xco_cp_time=>time_zone->user )->minute. "e.g. 10 DATA(m11_hours) = xco_cp=>sy->time( xco_cp_time=>time_zone->user )->hour. "Calculations with time "Adding "e.g. 11:29:00 DATA(m12_add_time) = xco_cp=>sy->time( xco_cp_time=>time_zone->user )->add( iv_hour = 1 iv_minute = 1 iv_second = 1 )->as( xco_cp_time=>format->iso_8601_extended )->value. "Subtracting "e.g. 09:26:58 DATA(m13_subtract_time) = xco_cp=>sy->time( xco_cp_time=>time_zone->user )->subtract( iv_hour = 1 iv_minute = 1 iv_second = 1 )->as( xco_cp_time=>format->iso_8601_extended )->value. "Getting date information "e.g. 2024-01-01 DATA(m14_date) = xco_cp=>sy->date( )->as( xco_cp_time=>format->iso_8601_extended )->value. "e.g. 01 DATA(m15_day) = xco_cp=>sy->date( )->day. "e.g. 01 DATA(m16_month) = xco_cp=>sy->date( )->month. "e.g. 2024 DATA(m17_year) = xco_cp=>sy->date( )->year. "Calculations with dates "Adding "e.g. 2025-02-02 DATA(m18_add_date) = xco_cp=>sy->date( )->add( iv_day = 1 iv_month = 1 iv_year = 1 )->as( xco_cp_time=>format->iso_8601_extended )->value. "Subtracting "e.g. 2022-12-31 DATA(m19_subtract_date) = xco_cp=>sy->date( )->subtract( iv_day = 1 iv_month = 1 iv_year = 1 )->as( xco_cp_time=>format->iso_8601_extended )->value. ``` |
| Class | Details/Code Snippet |
CL_FHC_CALENDAR_RUNTIME |
The following example explores accessing calendar-related information (factory and holiday calendars). Find more information in the [SAP Help Portal documentation](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/f7cbd3c336f84dc09c85639c55b4309f.html?version=Cloud). Note the [released CDS views](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/cc36b142349f40c499155b65e812c3ac.html?version=Cloud) in that context. ``` abap SELECT FactoryCalendarID FROM I_FactoryCalendarBasic ORDER BY FactoryCalendarID INTO TABLE @DATA(factory_cal_ids). SELECT PublicHolidayCalendarID FROM I_PublicHolidayCalendarBasic ORDER BY PublicHolidayCalendarID INTO TABLE @DATA(public_holiday_cal_ids). DATA(example_cal_ids) = VALUE string_table( ( `SAP_US` ) ( `SAP_IN` ) ( `SAP_QA` ) ( `SAP_SA` ) ( `SAP_DE_BW` ) ). LOOP AT example_cal_ids INTO DATA(example_cal_id). IF line_exists( factory_cal_ids[ table_line = example_cal_id ] ). DATA(factory_calendar_id) = CONV cl_fhc_calendar_runtime=>ty_fcal_id( example_cal_id ). ELSE. CLEAR factory_calendar_id. ENDIF. IF line_exists( public_holiday_cal_ids[ table_line = example_cal_id ] ). DATA(holiday_calendar_id) = CONV cl_fhc_calendar_runtime=>ty_hcal_id( example_cal_id ). ELSE. CLEAR holiday_calendar_id. ENDIF. "---------------------- Factory calendar-related information ---------------------- TRY. DATA(factory_cal) = cl_fhc_calendar_runtime=>create_factorycalendar_runtime( iv_factorycalendar_id = factory_calendar_id ). DATA(fc_date_conv) = factory_cal->convert_date_to_factorydate( CONV d( '20241115' ) ). DATA(fc_factory_date_conv) = factory_cal->convert_factorydate_to_date( 7219 ). DATA(fc_last_factory_date) = factory_cal->get_last_factorydate( ). DATA(fc_days_between) = factory_cal->calc_workingdays_between_dates( iv_start = '20241201' iv_end = '20250101' ). DATA(fc_days_add) = factory_cal->add_workingdays_to_date( iv_start = '20241220' iv_number_of_workingdays = 5 ). DATA(fc_days_subtract) = factory_cal->subtract_workingdays_from_date( iv_start = '20250101' iv_number_of_workingdays = 5 ). DATA(fc_is_working_date_1) = factory_cal->is_date_workingday( '20250101' ). DATA(fc_is_working_date_2) = factory_cal->is_date_workingday( '20241231' ). DATA(fc_description) = factory_cal->get_description( ). DATA(fc_id) = factory_cal->get_id( ). CATCH cx_fhc_runtime INTO DATA(error_factory_cal). DATA(error_msg_factory_cal) = error_factory_cal->get_text( ). ENDTRY. "---------------------- Holiday calendar-related information ---------------------- TRY. DATA(holiday_cal) = cl_fhc_calendar_runtime=>create_holidaycalendar_runtime( iv_holidaycalendar_id = holiday_calendar_id ). DATA(hc_is_holiday) = holiday_cal->is_holiday( CONV d( '20250101' ) ). holiday_cal->calc_holidays_between_dates( EXPORTING iv_start = '20240101' iv_end = '20250101' IMPORTING et_holidays = DATA(hc_holidays_between) ). DATA(hc_val_start) = holiday_cal->get_validity_start( ). DATA(hc_val_end) = holiday_cal->get_validity_end( ). DATA(hc_description) = holiday_cal->get_description( ). DATA(hc_id) = holiday_cal->get_id( ). DATA(hc_holiday_assignm) = holiday_cal->get_holiday_assignments( ). DATA holidays TYPE string_table. LOOP AT hc_holiday_assignm INTO DATA(holiday_wa). APPEND |Holiday ID: "{ holiday_wa->get_holiday_id( ) }", "{ holiday_wa->get_text( )-description }"| TO holidays. ENDLOOP. DATA holidays_in_time_frame TYPE string_table. LOOP AT hc_holidays_between INTO DATA(holiday_info_wa). DATA(hc_get_holiday) = holiday_cal->get_holiday( holiday_info_wa-date ). DATA(hc_holiday_text) = hc_get_holiday->get_text( ). DATA(hc_holiday_class) = hc_get_holiday->get_class( ). DATA(hc_holiday_conf) = hc_get_holiday->get_confession( ). DATA(hc_holiday_type) = hc_get_holiday->get_type( ). DATA(hc_holiday_id) = hc_get_holiday->get_holiday_id( ). APPEND |Date "{ holiday_info_wa-date }", Title "{ hc_holiday_text-description }"| TO holidays_in_time_frame. ENDLOOP. CATCH cx_fhc_runtime INTO DATA(error_holiday_cal). DATA(error_msg_holidays_cal) = error_holiday_cal->get_text( ). ENDTRY. CLEAR: holidays, holidays_in_time_frame. ENDLOOP. ``` |
CL_SCAL_UTILS |
Calendar utilities for getting month names, year and week of a date, first day of a week, name and number of the weekday for a specified date ``` abap TRY. "Getting month names cl_scal_utils=>month_names_get( EXPORTING iv_language = sy-langu IMPORTING et_month_names = DATA(months) ev_returncode = DATA(return_code) ). DATA(month_names) = VALUE string_table( FOR wa IN months ( CONV string( wa-ltx ) ) ). "Getting year and week of a date cl_scal_utils=>date_get_week( EXPORTING iv_date = '20251201' IMPORTING ev_year = DATA(year) ev_week = DATA(week) ). "Getting the first day of a week "Note the class documentation cl_scal_utils=>week_get_first_day( EXPORTING iv_year_week = 0 iv_year = 2025 iv_week = 48 IMPORTING ev_date = DATA(date) ). "Getting the name and number of the weekday for a specified date cl_scal_utils=>date_compute_day( EXPORTING iv_date = '20251201' IMPORTING ev_weekday_number = DATA(day_number) ev_weekday_name = DATA(day_name) ). CATCH cx_scal INTO DATA(error_scal). DATA(error_msg_scal) = error_scal->get_text( ). ENDTRY. ``` |
| Class | Details/Code Snippet |
CL_ABAP_TYPEDESCR |
RTTS represent a hierarchy of type description classes containing methods for:
CL_ABAP_TYPEDESCR, there are the following classes available. The list shows the hierarchy of type description classes. The example shows a small selection. See also the dynamic programming cheat sheet.
CL_ABAP_TYPEDESCR
|
|--CL_ABAP_DATADESCR
| |
| |--CL_ABAP_ELEMDESCR
| | |
| | |--CL_ABAP_ENUMDESCR
| |
| |--CL_ABAP_REFDESCR
| |--CL_ABAP_COMPLEXDESCR
| |
| |--CL_ABAP_STRUCTDESCR
| |--CL_ABAP_TABLEDESCR
|
|--CL_ABAP_OBJECTDESCR
|
|--CL_ABAP_CLASSDESCR
|--CL_ABAP_INTFDESCR
``` abap
TYPES elem_type TYPE c LENGTH 5.
DATA(tdo_elem) = CAST cl_abap_elemdescr(
cl_abap_typedescr=>describe_by_name( 'ELEM_TYPE' ) ).
DATA(rel_name) = tdo_elem->get_relative_name( ).
TYPES reftype TYPE REF TO string.
DATA(dref) = NEW i( 123 ).
DATA(type_descr1) = cl_abap_typedescr=>describe_by_data_ref( dref ).
DATA(tdo_ref) = CAST cl_abap_refdescr(
cl_abap_typedescr=>describe_by_name( 'REFTYPE' ) ).
DATA(type_descr2) = tdo_ref->get_referenced_type( ).
DATA structure TYPE zdemo_abap_carr.
DATA(tdo_struc) = CAST cl_abap_structdescr(
cl_abap_typedescr=>describe_by_data( structure ) ).
DATA(abs_name) = tdo_struc->absolute_name.
DATA(struc_components) = tdo_struc->get_components( ).
DATA itab TYPE SORTED TABLE OF zdemo_abap_carr WITH UNIQUE KEY carrid.
DATA(tdo_itab) = CAST cl_abap_tabledescr(
cl_abap_typedescr=>describe_by_data( itab ) ).
DATA(keys) = tdo_itab->get_keys( ).
DATA(tab_components) = CAST cl_abap_structdescr( tdo_itab->get_table_line_type( ) )->components.
DATA(tdo_oref) = CAST cl_abap_classdescr(
cl_abap_typedescr=>describe_by_name( 'CL_ABAP_CLASSDESCR' ) ).
DATA(cl_methods) = tdo_oref->methods.
DATA(cl_attr) = tdo_oref->attributes.
DATA(tdo_iref) = CAST cl_abap_intfdescr(
cl_abap_typedescr=>describe_by_name( 'ZDEMO_ABAP_OBJECTS_INTERFACE' ) ).
DATA(intf_methods) = tdo_iref->methods.
DATA(intf_attr) = tdo_iref->attributes.
```
|
| Class | Details/Code Snippet |
CL_ABAP_CORRESPONDING |
For assignments of components between structures or between internal tables with dynamically specified mapping rules. For more information, you can refer to the ABAP Keyword Documentation.
The example shows simple assignments with structures.
``` abap DATA: BEGIN OF s1, a TYPE i, b TYPE c LENGTH 3, c TYPE c LENGTH 5, END OF s1. DATA: BEGIN OF s2, a TYPE i, b TYPE c LENGTH 3, d TYPE string, END OF s2. "Populating structures s1 = VALUE #( a = 1 b = 'aaa' c = 'bbbbb' ). s2 = VALUE #( a = 2 b = 'ccc' d = `dddd` ). DATA(s3) = s1. DATA(s4) = s2. "Creating a mapping object "An initial mapping table means that only identically named components are assigned. "Other components retain their original values, i.e. the assignment for structures "works like MOVE-CORRESPONDING or the CORRESPONDING operator with the BASE addition DATA(map_obj) = cl_abap_corresponding=>create( source = s1 destination = s2 mapping = VALUE #( ) ). "Performing the assignment map_obj->execute( EXPORTING source = s1 CHANGING destination = s2 ). *s2 *A B D *1 aaa dddd "Performing the assignment without extra variable; specifying the mapping table: "level: 0 means the top level "kind: 1 means that components specified in this line are mapped to each other; " see the specification options in cl_abap_corresponding=>mapping_... "srcname/dstname: source component/target component cl_abap_corresponding=>create( source = s3 destination = s4 mapping = VALUE #( ( level = 0 kind = 1 srcname = 'c' dstname = 'd' ) ) )->execute( EXPORTING source = s3 CHANGING destination = s4 ). *s4 *A B D *1 aaa bbbbb ``` |
| Class | Details/Code Snippet |
CL_ABAP_STRUCT_UTILITIES |
Provides methods to get information about filled components in structures allowing an efficient processing of non-initial components of a structure.
``` abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. out->write( `---------- filled_components method ----------` ). "It returns an internal table containing the names of the non-initial "components of the structure and their index. DATA: BEGIN OF struct, a TYPE c LENGTH 1, b TYPE i, c TYPE zdemo_abap_carr, d TYPE REF TO string, END OF struct. struct = VALUE #( a = 'X' b = 123 c = VALUE #( carrid = 'LH' ) d = NEW #( `ABAP` ) ). "Getting component information using RTTI DATA(all_comps) = CAST cl_abap_structdescr( cl_abap_typedescr=>describe_by_data( struct ) )->components. out->write( all_comps ). "Getting an internal table containing the names of non-initial components "and their index DATA(filled_comps) = cl_abap_struct_utilities=>filled_components( struct ). out->write( filled_comps ). "In a loop, structure components are cleared. The filled_components method "is called in each loop pass, visualizing the filled components in the "structure. DO lines( all_comps ) TIMES. CLEAR struct-(sy-index). filled_comps = cl_abap_struct_utilities=>filled_components( struct ). out->write( filled_comps ). ENDDO. out->write( `---------- filled_components_c method ----------` ). "Same as above. All structure components must be typed with c LENGTH 1. DATA: BEGIN OF struct_c1, a TYPE c LENGTH 1 VALUE 'X', b TYPE c LENGTH 1, c TYPE c LENGTH 1 VALUE 'X', END OF struct_c1. filled_comps = cl_abap_struct_utilities=>filled_components_c( struct_c1 ). out->write( filled_comps ). out->write( `---------- filled_components_x method ----------` ). "Same as above. All structure components must be typed with x LENGTH 1. "It is especially useful for checking filled components of BDEF derived types, "for example, %control. DATA struc_der_type TYPE STRUCTURE FOR READ IMPORT zdemo_abap_rap_ro_m. struc_der_type = VALUE #( %control = VALUE #( key_field = if_abap_behv=>mk-on field1 = if_abap_behv=>mk-on field2 = if_abap_behv=>mk-off field3 = if_abap_behv=>mk-off field4 = if_abap_behv=>mk-on ) ). filled_comps = cl_abap_struct_utilities=>filled_components_x( struc_der_type-%control ). out->write( filled_comps ). ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_ABAP_DIFF |
Using the methods diff and diff_with_line_ref of the CL_ABAP_DIFF class, you can compare the content of two compatible index tables. The returning parameter is an internal table showing how the content of one internal table can be modified to match another one. diff_with_line_ref also returns a reference to the original table lines. Various importing parameters are available to adjust the comparison. Find more information in the class documentation and in the ABAP Keyword Documentation.
```abap CLASS zcl_demo_test DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_test IMPLEMENTATION. METHOD if_oo_adt_classrun~main. TYPES: BEGIN OF s, a TYPE i, b TYPE string, c TYPE c LENGTH 3, END OF s. DATA it1 TYPE TABLE OF s WITH EMPTY KEY. DATA it2 TYPE TABLE OF s WITH EMPTY KEY. it1 = VALUE #( ( a = 1 b = `aaa` c = 'zzz' ) ( a = 2 b = `bbb` c = 'yyy' ) ( a = 3 b = `ccc` c = 'xxx' ) ( a = 4 b = `ddd` c = 'www' ) ). it2 = VALUE #( ( a = 1 b = `aaa` c = 'zzz' ) ( a = 2 b = `#bb` c = 'yy#' ) ( a = 3 b = `cc` c = 'x' ) ( a = 4 b = `ddd` c = 'www' ) ( a = 5 b = `eee` c = 'vvv' ) ). DATA(it3) = it1. DATA is_identical TYPE abap_bool. DATA(comparison) = cl_abap_diff=>create( ). TRY. DATA(comp_res1) = comparison->diff( EXPORTING target = it2 source = it1 IMPORTING flag_identical = is_identical ). IF is_identical = abap_true. out->write( `The two internal tables have identical content.` ). ELSE. out->write( comp_res1 ). ENDIF. CATCH cx_abap_diff INTO DATA(error1). out->write( error1->get_text( ) ). ENDTRY. TRY. DATA(comp_res2) = comparison->diff_with_line_ref( EXPORTING target = it2 source = it1 IMPORTING flag_identical = is_identical ). IF is_identical = abap_true. out->write( `The two internal tables have identical content.` ). ELSE. out->write( comp_res2 ). ENDIF. CATCH cx_abap_diff INTO DATA(error2). out->write( error2->get_text( ) ). ENDTRY. TRY. DATA(comp_res3) = comparison->diff_with_line_ref( EXPORTING target = it3 source = it1 IMPORTING flag_identical = is_identical ). IF is_identical = abap_true. out->write( `The two internal tables have identical content.` ). ELSE. out->write( comp_res3 ). ENDIF. CATCH cx_abap_diff INTO DATA(error3). out->write( error3->get_text( ) ). ENDTRY. ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_ABAP_DYN_PRG |
For validating input for dynamic specifications.
``` abap "The following method checks database table names. The name is provided "with the val parameter. The packages formal parameter expects a table "containing the names of packages in which the specified table should be "included. Assuming you provide incorrect input for the table name, or "the table is not contained in the specified packages, you can expect an "exception to be raised. TRY. DATA(dbtab) = cl_abap_dyn_prg=>check_table_name_tab( val = `ZDEMO_ABAP_FLI` packages = VALUE #( ( `TEST_ABAP_CHEAT_SHEETS` ) ( `TEST_SOME_PACK` ) ) ). SELECT SINGLE * FROM (dbtab) INTO NEW @DATA(ref_wa). CATCH cx_abap_not_a_table cx_abap_not_in_package. ... ENDTRY. "In the following examples, a method is used to check whether "the input is allowed or not. For this, you specify an allowlist. "Here, the relvant parameter expects a comma-separated list of "allowed values. TRY. DATA(value1) = cl_abap_dyn_prg=>check_allowlist( val = `A` allowlist_str = `A,B,C,D` ). ... "Here might go an ABAP SQL statement with a dynamic specification. CATCH cx_abap_not_in_allowlist. ... ENDTRY. "Another parameter of the method expects an internal table that "contains the allowed values. TRY. DATA(value2) = cl_abap_dyn_prg=>check_allowlist( val = `XYZ` allowlist_htab = VALUE #( ( `A` ) ( `B` ) ( `C` ) ( `D` ) ) ). ... "Here might go an ABAP SQL statement with a dynamic specification. CATCH cx_abap_not_in_allowlist. ... ENDTRY. ``` |
| Class | Details/Code Snippet |
CL_ABAP_CONTEXT_INFO |
Provides context information relevant to the current ABAP session.
``` abap "User alias, e.g. XY0000001234 DATA(alias) = cl_abap_context_info=>get_user_alias( ). "Formatted name, e.g. John Doe TRY. DATA(formatted_name) = cl_abap_context_info=>get_user_formatted_name( ). CATCH cx_abap_context_info_error. ENDTRY. "The class also provides the option to retrieve the current date and time "in UTC. "Getting the current date in UTC (not the system or user time), e.g. 20240101 DATA(sys_date) = cl_abap_context_info=>get_system_date( ). "Getting the current time in UTC, e.g. 152450 DATA(sys_time) = cl_abap_context_info=>get_system_time( ). ``` |
XCO_CP |
``` abap DATA(user_w_xco) = xco_cp=>sy->user( )->name. ``` |
| Class | Details |
CL_IXML_* CL_SXML_* |
```abap "As mentioned, refer to the ABAP Keyword Documentation and the "XML/JSON cheat sheet (and executable example) for examples "Creating an XML writer using sXML DATA(writer) = CAST if_sxml_writer( cl_sxml_string_writer=>create( type = if_sxml=>co_xt_xml10 encoding = 'UTF-8' ) ). "The above writer uses a cast to if_sxml_writer. In doing so, "more special methods can be accessed. You can check it by adding "the object component selector (->) behind the closing parenthesis. "Plus: The example above specifies the default parameters "explicitly. Here, they are omitted. You can also create a JSON "writer. DATA(writer2) = cl_sxml_string_writer=>create( ). ... "Creating some XML data "Creating an XML reader using sXML "Note: Similar to the writer, the interface IF_SXML_READER exists "for readers. DATA(reader) = cl_sxml_string_reader=>create( some_xml ). ... "Reading XML data sequentially ``` |
XCO_CP_JSON |
Handling JSON data using the XCO library
``` abap "Creating and populating a demo structure and internal table DATA: BEGIN OF carrier_struc, carrier_id TYPE c length 3, connection_id TYPE n length 4, city_from TYPE c length 20, city_to TYPE c length 20, END OF carrier_struc. DATA carriers_tab LIKE TABLE OF carrier_struc WITH EMPTY KEY. carrier_struc = VALUE #( carrier_id = 'AA' connection_id = '17' city_from = 'New York' city_to = 'San Francisco' ). carriers_tab = VALUE #( ( carrier_id = 'AZ' connection_id = '788' city_from = 'Rome' city_to = 'Tokyo' ) ( carrier_id = 'JL' connection_id = '408' city_from = 'Frankfurt' city_to = 'Tokyo' ) ). "ABAP (structure) -> JSON using XCO DATA(struc2json_xco) = xco_cp_json=>data->from_abap( carrier_struc )->to_string( ). "Result: {"CARRIER_ID":"AA","CONNECTION_ID":"0017","CITY_FROM":"New York","CITY_TO":"San Francisco"} "ABAP (internal table) -> JSON using XCO DATA(itab2json_xco) = xco_cp_json=>data->from_abap( carriers_tab )->to_string( ). "Result: [{"CARRIER_ID":"AZ","CONNECTION_ID":"0788","CITY_FROM":"Rome","CITY_TO":"Tokyo"}, " {"CARRIER_ID":"JL","CONNECTION_ID":"0408","CITY_FROM":"Frankfurt","CITY_TO":"Tokyo"}] "JSON -> ABAP (structure) using XCO DATA json2struc_xco LIKE carrier_struc. xco_cp_json=>data->from_string( struc2json_xco )->write_to( REF #( json2struc_xco ) ). "Result: "CARRIER_ID CONNECTION_ID CITY_FROM CITY_TO "AA 0017 New York San Francisco "JSON -> ABAP (internal table) using XCO DATA json2itab_xco LIKE carriers_tab. xco_cp_json=>data->from_string( itab2json_xco )->write_to( REF #( json2itab_xco ) ). "Result: "CARRIER_ID CONNECTION_ID CITY_FROM CITY_TO "AZ 0788 Rome Tokyo "JL 0408 Frankfurt Tokyo "Creating JSON using XCO "You can check out more methods that offer various options to build "the JSON by clicking CTRL + Space after '->' in ADT. "In the following example, JSON data similar to above is created. "First, a JSON data builder is created. Then, using different methods, "JSON data is created. DATA(json_builder_xco) = xco_cp_json=>data->builder( ). json_builder_xco->begin_object( )->add_member( 'CarrierId' )->add_string( 'DL' )->add_member( 'ConnectionId' )->add_string( '1984' )->add_member( 'CityFrom' )->add_string( 'San Francisco' )->add_member( 'CityTo' )->add_string( 'New York' )->end_object( ). "Getting JSON data DATA(json_created_xco) = json_builder_xco->get_data( )->to_string( ). "Result: {"CarrierId":"DL","ConnectionId":"1984","CityFrom":"San Francisco","CityTo":"New York"} "Transforming the created JSON to ABAP (structure) "Note: The JSON was intentionally created without the underscores in the "name to demonstrate the 'apply' method. The following example demonstrates "a transformation of camel case and underscore notation. As above, check out "more options by clicking CTRL + Space after '...transformation->'. CLEAR json2struc_xco. xco_cp_json=>data->from_string( json_created_xco )->apply( VALUE #( ( xco_cp_json=>transformation->pascal_case_to_underscore ) ) )->write_to( REF #( json2struc_xco ) ). "Result "CARRIER_ID CONNECTION_ID CITY_FROM CITY_TO "DL 1984 San Francisco New York ``` |
/UI2/CL_JSON |
- Handling JSON data using the /UI2/CL_JSON class
- Note that there are many additional and optional parameters available, some of which are explored in examples in the [Working with XML and JSON in ABAP](21_XML_JSON.md) cheat sheet.
```abap DATA(some_table) = VALUE string_table( ( `aaa` ) ( `bbb` ) ( `ddd` ) ). "--------- ABAP -> JSON --------- DATA(abap_to_json) = /ui2/cl_json=>serialize( data = some_table ). "--------- JSON -> ABAP --------- DATA table_json_to_abap TYPE string_table. /ui2/cl_json=>deserialize( EXPORTING json = abap_to_json CHANGING data = table_json_to_abap ). ``` |
| Class | Details/Code Snippet |
XCO_CP_ABAPXCO_CP_ABAP_REPOSITORY |
``` abap "Getting all accessible repository objects in the system "To further process the returned values, you can loop over them. DATA(all_obj) = xco_cp_abap_repository=>objects->all->in( xco_cp_abap=>repository )->get( ). "Gettig all database tables DATA(all_tables) = xco_cp_abap_repository=>objects->tabl->all->in( xco_cp_abap=>repository )->get( ). "Refining the search by applying a filter "Creating a filter and adding a search pattern DATA(filter1) = xco_cp_abap_repository=>object_name->get_filter( xco_cp_abap_sql=>constraint->contains_pattern( 'ZDEMO_ABAP_RAP_R%' ) ). "Getting all BDEFs in the system having a specific pattern DATA(bdefs_in_package) = xco_cp_abap_repository=>objects->bdef->where( VALUE #( ( filter1 ) ) )->in( xco_cp_abap=>repository )->get( ). "Getting all accessible interfaces with a particular name pattern in the entire system DATA(filter2) = xco_cp_abap_repository=>object_name->get_filter( xco_cp_abap_sql=>constraint->contains_pattern( 'IF_ABAP_BEHV%' ) ). DATA(all_intfs) = xco_cp_abap_repository=>objects->intf->where( VALUE #( ( filter2 ) ) )->in( xco_cp_abap=>repository )->get( ). "Getting all classes in the system that correspond to a specific name pattern and "that are contained in a specific software component "Creating filters DATA(filter3) = xco_cp_system=>software_component->get_filter( xco_cp_abap_sql=>constraint->equal( 'SAP_BASIS' ) ). DATA(filter4) = xco_cp_abap_repository=>object_name->get_filter( xco_cp_abap_sql=>constraint->contains_pattern( '%CL_ABAP_RAND%' ) ). DATA(filtered_classes) = xco_cp_abap_repository=>objects->clas->where( VALUE #( ( filter3 ) ( filter4 ) ) )->in( xco_cp_abap=>repository )->get( ). "Checking if a repository object with a specific name exists in the system DATA(type_names) = VALUE string_table( ( `ZDEMO_ABAP_FLI` ) ( `ZDEMO_ABAP_FLSCH_VE` ) ). LOOP AT type_names INTO DATA(type_name). DATA(filter5) = xco_cp_abap_repository=>object_name->get_filter( xco_cp_abap_sql=>constraint->equal( type_name ) ). "A table is returned containing found repository objects of the specified name DATA(repo_objects) = xco_cp_abap_repository=>objects->where( VALUE #( ( filter5 ) ) )->in( xco_cp_abap=>repository )->get( ). "Some examples for further processing the returned objects "You can explore more options, e.g., by adding the object component selector (->) "to the final parenthesis and checking the suggestions by ADT. LOOP AT repo_objects INTO DATA(obj). "Retrieving the four-character value of the object type DATA(val) = obj->type->value. "Retrieving the package name of the repository object DATA(package) = obj->get_package( )->name. "The following example implementation retrieves key component. CASE val. WHEN `TABL`. "Retrieving the key component names of DDIC database tables DATA(table_keys) = xco_cp_abap_repository=>object->tabl->database_table->for( CONV #( obj->name->value ) )->fields->key->get_names( ). WHEN `DDLS`. "Retrieving the key component names of CDS entities DATA(ddls_key_spec) = xco_cp_abap_repository=>object->ddls->for( CONV #( obj->name->value ) )->entity( )->fields->all->get_names( ). LOOP AT ddls_key_spec INTO DATA(field). DATA(is_key) = xco_cp_abap_repository=>object->ddls->for( CONV #( obj->name->value ) )->view_entity( )->field( field )->content( )->get_key_indicator( ). DATA ddls_keys TYPE string_table. IF is_key IS NOT INITIAL. APPEND field TO ddls_keys. ENDIF. ENDLOOP. CLEAR ddls_keys. ENDCASE. ENDLOOP. ENDLOOP. "Getting information about some of the technical properties of different "repository objects. The examples show the creation of handlers. You can "explore more options, e.g., by adding the object component selector (->) "to the final parenthesis and checking the suggestions by ADT. "Database table DATA(handler_tabl) = xco_cp_abap_dictionary=>database_table( 'ZDEMO_ABAP_CARR' ). "Data element DATA(handler_dtel) = xco_cp_abap_dictionary=>data_element( 'MANDT' ). "Table type DATA(handler_table_type) = xco_cp_abap_dictionary=>table_type( 'STRING_TABLE' ). "CDS view entity DATA(handler_cds_ve) = xco_cp_cds=>view_entity( 'ZDEMO_ABAP_RAP_RO_M' ). "Interface DATA(handler_intf) = xco_cp_abap=>interface( 'ZDEMO_ABAP_OBJECTS_INTERFACE' ). "Getting information about where the interface is implemented DATA(where_is_intf_impl) = handler_intf->implementations->all->get_names( ). "Class DATA(handler_cl) = xco_cp_abap=>class( 'ZCL_DEMO_ABAP_UNIT_TEST' ). "Getting subclasses DATA(subcl) = xco_cp_abap=>class( 'CL_ABAP_TYPEDESCR' )->subclasses->all->get( ). "Getting the names of the subclasses DATA(subcl_names) = xco_cp_abap=>class( 'CL_ABAP_TYPEDESCR' )->subclasses->all->get_names( ). "Getting the direct superclass DATA(direct_super_class) = xco_cp_abap=>class( 'CL_ABAP_DATADESCR' )->definition->content( )->get_superclass( )->name. "Taking an XCO handler for a database table as an example, see some of the "details you can retrieve. The method names should be self-explanatory. DATA(dbtab_name) = handler_tabl->name. DATA(dbtab_descr) = handler_tabl->content( )->get_short_description( ). DATA(dbtab_del_cl) = handler_tabl->content( )->get_delivery_class( )->value. DATA(dbtab_field_names) = handler_tabl->fields->all->get_names( ). DATA(dbtab_keys) = handler_tabl->fields->key->get_names( ). DATA(dbtab_vis) = handler_tabl->get_api_state( )->get_visibilities( ). "Initial for the cheat sheet table DATA(dbtab_rel_state) = handler_tabl->get_api_state( )->get_release_state( )->value. ``` |
| Class | Details/Code Snippet |
XCO_CP_GENERATION |
For creating, updating and deleting ABAP repository objects. More information: Generation APIs The rudimentary snippet is taken from the executable example of the ABAP for Cloud Development cheat sheet. ``` abap ... DATA(n10_handler) = xco_cp_generation=>environment->dev_system( ... ). DATA(n11_put) = n10_handler->create_put_operation( ). "Creating a domain DATA(n12_doma_spec) = n11_put->for-doma->add_object( ... "e.g. 'ZDEMO_ABAP_STATUS' )->set_package( ... )->create_form_specification( ). n12_doma_spec->set_short_description( 'Demo domain' ). n12_doma_spec->set_format( xco_cp_abap_dictionary=>built_in_type->char( 10 ) ). n12_doma_spec->fixed_values->add_fixed_value( 'BOOKED' )->set_description( 'Booked' ). n12_doma_spec->fixed_values->add_fixed_value( 'CANCELED' )->set_description( 'Canceled' ). ... "Executing the generation TRY. n11_put->execute( ). CATCH cx_xco_gen_put_exception. ENDTRY. ``` |
| Class | Details/Code Snippet |
XCO_CPXCO_CP_CALL_STACK |
Getting the current ABAP call stack programmatically. See more information here.
``` abap "Getting the full current call stack DATA(call_stack) = xco_cp=>current->call_stack->full( ). "Creating a format for the call stack "In the example, an ADT debugger-like style is used DATA(format) = xco_cp_call_stack=>format->adt( )->with_line_number_flavor( xco_cp_call_stack=>line_number_flavor->source ). "Retrieving the full call stack as text, e.g. so that it can be output "or written somewhere DATA(call_stack_as_text) = call_stack->as_text( format ). "Extracting the call stack based on specifications "You can specify the extractions using from/to and "further detailing out the kinds of extractions "such as the position or the first/last occurrence "of a specific line pattern. "In the example, a line pattern is created (method that "starts with a specific pattern). The extracting should "go up to the last occurrence of this pattern. It is "started at position 1. DATA(line_pattern) = xco_cp_call_stack=>line_pattern->method( )->where_class_name_starts_with( 'CL_REST' ). DATA(extracted_call_stack_as_text) = call_stack->from->position( 1 )->to->last_occurrence_of( line_pattern )->as_text( format ). ``` |
| Class | Details/Code Snippet |
CL_BCS_MAIL_MESSAGE |
``` abap TRY. DATA(mail) = cl_bcs_mail_message=>create_instance( ). mail->set_sender( '...@...' ). mail->add_recipient( '...@...' ). mail->set_subject( 'Test Mail' ). mail->set_main( cl_bcs_mail_textpart=>create_instance( iv_content = ' HelloThis is a test mail. ' iv_content_type = 'text/html' ) ). mail->send( IMPORTING et_status = DATA(status_table) ). "You can check the status of the email sending in the returned table. "'status' components: E (error), S (sent), W (waiting) CATCH cx_bcs_mail INTO DATA(error_mail). ... ENDTRY. ``` The following snippet includes some file attachments: ```abap TRY. "Creating a new mail instance DATA(mail) = cl_bcs_mail_message=>create_instance( ). "Settings mail->set_sender( '...@...' ). mail->add_recipient( '...@...' ). mail->set_subject( 'Test Mail' ). mail->set_main( cl_bcs_mail_textpart=>create_instance( iv_content = `Test MailPlease find some files attached. |
| Class | Details/Code Snippet |
XCO_CPXCO_CP_TENANT |
For obtaining various information about the currently active tenant.
``` abap "Getting a handler for the currently active tenant DATA(ten) = xco_cp=>current->tenant( ). "Getting the UI URL of the currently active tenant DATA(ui_url) = ten->get_url( xco_cp_tenant=>url_type->ui ). "Protocol "e.g. https DATA(prot) = ui_url->get_protocol( ). "Host and domain "e.g. abcde-...-com DATA(host) = ui_url->get_host( ). "Port "e.g. 443 DATA(port) = ui_url->get_port( ). "Global account ID DATA(global_acc_id) = ten->get_global_account_id( )->as_string( ). "Guid DATA(guid) = ten->get_guid( )->value. "Id DATA(id) = ten->get_id( ). "Subaccount ID DATA(sub_acc_id) = ten->get_subaccount_id( )->as_string( ). ``` |
| Class | Details/Code Snippet |
CX_* |
Exception classes are special classes, usually starting with the name CX_*, that serve as the basis for catchable exceptions. When an exception is raised, an object of such an exception class is created. There are several predefined exception classes. Find more information in the [Exceptions and Runtime Errors](27_Exceptions.md) cheat sheet.
``` abap TRY. DATA(res) = 1 / 0. CATCH cx_sy_zerodivide. ENDTRY. DATA(str_table) = VALUE string_table( ( `a` ) ( `b` ) ( `c` ) ). TRY. DATA(table_entry) = str_table[ 4 ]. CATCH cx_sy_itab_line_not_found. ENDTRY. ``` |
| Class | Details/Code Snippet |
CL_ABAP_PARALLEL |
For performing the parallel processing for instances of ABAP Objects. For more information, refer to the class documentation.
The following example class demonstrates parallel processing using the `CL_ABAP_PARALLEL` class. 🟢 Click to expand for more information and example codeNotes on the example: - As a prerequisite, ensure you have a class implementing the `IF_ABAP_PARALLEL` interface. In this self-contained example, the executable class itself implements it. - Before running the class with F9 in ADT, set a breakpoint for the `ASSERT` statement in the implementation of the `if_oo_adt_classrun~main` method. - The example visualizes parallel processing by adding timestamps to an internal table. When program execution stops, you can check the table contents. - First, instances of the example class are created for the parallel processing of instances. - Next, an instance of the `CL_ABAP_PARALLEL` class is created. The example omits optional parameters; refer to the class documentation for details. - Parallel processing begins with the `run_inst` method, adding the instances to the input parameter. - A table of result information for tasks is returned and stored in a data object. - After starting the parallel processing, the `if_abap_parallel~do` method is called for each instance. This method includes a `DO` loop that populates the `info` table with timestamps. - The example includes a `WAIT` statement to pause program execution to ensure that all the parallel processing runs have completed. - The result information table is then looped over, and details are accessed by casting to the respective class (in this case, the example class). - The `info` table is sorted by timestamps. In the debugger, you can explore the functionality of the parallel processing in the following ways: - The `instance` component may show a random instance, like `inst3`, processed first. - Due to many loop passes, other instances might start in parallel before the current instance finishes. The `instance` component might show, for example, that `inst3` was processed first while `inst1` began. Some `time_stamp` values may even show identical values.```abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. INTERFACES if_abap_parallel. METHODS constructor IMPORTING text TYPE string OPTIONAL. PROTECTED SECTION. PRIVATE SECTION. DATA instance_name TYPE string. DATA time_stamp TYPE utclong. TYPES: BEGIN OF struct, time_stamp TYPE utclong, instance TYPE string, comment TYPE string, END OF struct. DATA info TYPE TABLE OF struct WITH EMPTY KEY. DATA parallel_proc LIKE info. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. APPEND VALUE #( time_stamp = time_stamp instance = `----` comment = `Time stamp stored when first running/calling the class` ) TO info. DATA(inst1) = NEW zcl_demo_abap( `inst1` ). DATA(inst2) = NEW zcl_demo_abap( `inst2` ). DATA(inst3) = NEW zcl_demo_abap( `inst3` ). DATA(inst4) = NEW zcl_demo_abap( `inst4` ). DATA(inst5) = NEW zcl_demo_abap( `inst5` ). APPEND VALUE #( time_stamp = utclong_current( ) instance = `----` comment = `Time stamp stored before starting parallel processing` ) TO info. DATA(parallel) = NEW cl_abap_parallel( ). parallel->run_inst( EXPORTING p_in_tab = VALUE #( ( inst1 ) ( inst2 ) ( inst3 ) ( inst4 ) ( inst5 ) ) IMPORTING p_out_tab = DATA(result_info) ). APPEND VALUE #( time_stamp = utclong_current( ) instance = `----` comment = `Time stamp stored after starting parallel processing` ) TO info. WAIT UP TO 1 SECONDS. APPEND VALUE #( time_stamp = utclong_current( ) instance = `----` comment = `Time stamp stored after the WAIT statement` ) TO info. LOOP AT result_info INTO DATA(wa). DATA(res) = CAST zcl_demo_abap( wa-inst ). APPEND LINES OF res->parallel_proc TO info. APPEND VALUE #( time_stamp = res->time_stamp instance = res->instance_name comment = `Time stamp stored in constructor implementation when instantiating class` ) TO info. ENDLOOP. SORT info BY time_stamp ASCENDING. ASSERT 1 = 1. ENDMETHOD. METHOD if_abap_parallel~do. DO 1000 TIMES. APPEND VALUE #( time_stamp = utclong_current( ) instance = instance_name comment = |Entry { sy-index } added within "do" method| ) TO parallel_proc. ENDDO. ENDMETHOD. METHOD constructor. IF text IS SUPPLIED AND text IS NOT INITIAL. instance_name = text. ENDIF. time_stamp = utclong_current( ). ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_BALI_LOG |
For creating and reading application logs. Refer to this documentation for more information and code snippets. Note that there is also an XCO module available dealing with business application log (XCO_CP_BAL; see this documentation).
``` abap "Demo application job (sub)objects and external ID "Note: "- Refer to the documentation about how to create an application log object in ADT, " and for more options the classes offer in the context of application logs. "- Required authorization for authorization object: S_APPL_LOG. CONSTANTS: obj TYPE cl_bali_header_setter=>ty_object VALUE 'DEMO_LOG', subobj TYPE cl_bali_header_setter=>ty_subobject VALUE 'DEMO_SUB', external_id TYPE cl_bali_header_setter=>ty_external_id VALUE 'DEMO_EXT_ID'. "---- Creating (and deleting) application log entries ---- TRY. "Creating an instance of the application Log class DATA(appl_log) = cl_bali_log=>create( ). "Setting the header log, using application log object descriptions appl_log->set_header( header = cl_bali_header_setter=>create( object = obj subobject = subobj external_id = external_id ) ). "Before creating new application log entries, deleting existing ones based on the application "log object information and the user DATA(filter4del) = cl_bali_log_filter=>create( ). filter4del->set_create_info( user = xco_cp=>sy->user( )->name )->set_descriptor( object = obj subobject = subobj external_id = external_id ). "Reading the logs from the database by applying the filter DATA(del_appl_log) = cl_bali_log_db=>get_instance( )->load_logs_w_items_via_filter( filter = filter4del ). "Deleting existing application log entries that are retrieved based on the applied filter LOOP AT del_appl_log INTO DATA(log_del). cl_bali_log_db=>get_instance( )->delete_log( log = log_del ). ENDLOOP. CATCH cx_bali_runtime. ENDTRY. TRY. "Creating new application log entries "Creating a free text and adding it to the application log DATA(free_txt) = cl_bali_free_text_setter=>create( severity = if_bali_constants=>c_category_free_text text = |This text is added to the application log at { utclong_current( ) }| ). appl_log->add_item( item = free_txt ). "Creating an exception and adding it to the application log DATA(strtab) = VALUE string_table( ( `a` ) ( `b` ) ( `c` ) ). TRY. DATA(line) = strtab[ 4 ]. CATCH cx_sy_itab_line_not_found INTO DATA(error). ENDTRY. DATA(exc) = cl_bali_exception_setter=>create( severity = if_bali_constants=>c_category_exception exception = error ). appl_log->add_item( item = exc ). "Saving the application log to the database cl_bali_log_db=>get_instance( )->save_log( log = appl_log ). CATCH cx_bali_runtime. ENDTRY. WAIT UP TO 1 SECONDS. "---- Reading the application log ---- TRY. "Creating a filter "Only the messages from the current user based on the application log "object information and in the time frame now - 1 hour are retrieved. DATA(filter) = cl_bali_log_filter=>create( ). DATA(now) = utclong_current( ). DATA(anhourearlier) = utclong_add( val = now hours = '1-' ). filter->set_create_info( user = xco_cp=>sy->user( )->name )->set_descriptor( object = obj subobject = subobj external_id = external_id )->set_time_interval( start_time = anhourearlier end_time = now ). "Reading the logs from the database by applying the filter DATA(log_table) = cl_bali_log_db=>get_instance( )->load_logs_w_items_via_filter( filter = filter ). "Processing the read result LOOP AT log_table INTO DATA(log). "Retrieving all items DATA(items) = log->get_all_items( ). "Retrieving the application log messages (and displaying) LOOP AT items INTO DATA(item). DATA(log_item_number) = item-log_item_number. DATA(msg) = item-item->get_message_text( ). "Displaying the entries when running a class "that implements the if_oo_adt_classrun interface "out->write( |{ log_item_number } { msg }| ). ENDLOOP. ENDLOOP. CATCH cx_bali_runtime. ENDTRY. ``` |
| Class | Details/Code Snippet |
CL_BGMC_PROCESS_FACTORY |
- Used in the context of the Background Processing Framework (bgPF) to run code asynchronously in the background.
- Different flavors are available:
- Using bgPF without transactional control, for example, if you do not work with a RAP application or transactional control is not relevant in an ABAP program. In this case, you can implement the IF_BGMC_OP_SINGLE_TX_UNCONTR interface.
- Using bgPF with transactional control, for example, if you work with a RAP application. In that case, you can implement the IF_BGMC_OP_SINGLE interface. Note: If you are in a RAP context, you do not need to implement COMMIT/ROLLBACK WORK because the RAP framework takes care of it.
- More information:
- Background Processing Framework
- Transactional control with the controlled SAP LUW
**Example 1: Using bgPF without transactional control**
🟢 Click to expand for example code (Example 1)The following, self-contained, and oversimplified example is intended to give a rough idea about the functionality. It does not include transactional control. The example class can be run using F9 in ADT. It does the following: A demo database table of the cheat sheet repository is filled synchronously and asynchronously (using bgPF) with entries, just to show an effect and get an idea. Two entries are created in the background. WAIT statements are included to have a self-contained example, and that all created database entries can be shown in the output. In the example, the background processing may be visualized, for example, by the MODIFY statement that is followed by a WAIT statement in the loop. The output can show that the entry for the first asynchronously created entry was added before a synchronously created entry. For more visualization options regarding the execution in the background, you can, for example, check the ABAP Cross Trace. For more information, refer to the documentation.
``` abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. INTERFACES if_bgmc_op_single_tx_uncontr. CLASS-METHODS get_uuid RETURNING VALUE(uuid) TYPE sysuuid_x16. PRIVATE SECTION. CLASS-DATA number TYPE i. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. "Deleting a demo database table DELETE FROM zdemo_abap_tabca. number += 1. MODIFY zdemo_abap_tabca FROM @( VALUE #( id = get_uuid( ) calc_result = |Synchronous entry creation in the MAIN method { number }| crea_date_time = cl_abap_tstmp=>utclong2tstmp( utclong_current( ) ) ) ). "Processing code in the background DO 2 TIMES. "Creating an instance of the example class (that implements the bgPF-relevant "interface if_bgmc_op_single_tx_uncontr) DATA(inst) = NEW zcl_demo_abap( ). TRY. "Getting the default factory for transactional background processes and "creating a process for a single operation DATA(backgr) = cl_bgmc_process_factory=>get_default( )->create( ). "Setting a name of the process backgr->set_name( `bgPF Test` ). "Setting the transactionally uncontrolled operation of the process backgr->set_operation_tx_uncontrolled( inst ). "Saving the background process for the asynchronous execution backgr->save_for_execution( ). "An explicit COMMIT WORK is required to start the background process. "This explicit call is not needed in the context of RAP because the RAP "framework will take care of the commit call. COMMIT WORK. CATCH cx_bgmc INTO DATA(error). out->write( error->get_text( ) ). ROLLBACK WORK. ENDTRY. number += 1. MODIFY zdemo_abap_tabca FROM @( VALUE #( id = get_uuid( ) calc_result = |Synchronous entry creation in the MAIN method { number }| crea_date_time = cl_abap_tstmp=>utclong2tstmp( utclong_current( ) ) ) ). WAIT UP TO 1 SECONDS. ENDDO. WAIT UP TO 2 SECONDS. "Displaying the content of a demo database table that was filled "in the course of the class execution SELECT id, calc_result, crea_date_time FROM zdemo_abap_tabca ORDER BY crea_date_time INTO TABLE @DATA(itab). out->write( itab ). ENDMETHOD. METHOD if_bgmc_op_single_tx_uncontr~execute. MODIFY zdemo_abap_tabca FROM @( VALUE #( id = get_uuid( ) calc_result = `Asynchronous entry creation in background in the EXECUTE method` crea_date_time = cl_abap_tstmp=>utclong2tstmp( utclong_current( ) ) ) ). ENDMETHOD. METHOD get_uuid. TRY. uuid = cl_system_uuid=>create_uuid_x16_static( ) . CATCH cx_uuid_error. ENDTRY. ENDMETHOD. ENDCLASS. ``` **Example 2: Using bgPF with transactional control** 🟢 Click to expand for example code (Example 2)This example is similar to example 1. Unlike example 1, example 2 executes operations under transactional control. The transactional phase is explicitly switched using the `cl_abap_tx` class. ```abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. INTERFACES if_bgmc_op_single. METHODS constructor IMPORTING num TYPE i OPTIONAL. PRIVATE SECTION. DATA num TYPE i. DATA uuid TYPE sysuuid_x16. DATA timestamp TYPE utclong. METHODS modify. METHODS save. METHODS get_uuid RETURNING VALUE(uuid) TYPE sysuuid_x16. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. "Deleting a demo database table DELETE FROM zdemo_abap_tabca. "Synchronous entry creation MODIFY zdemo_abap_tabca FROM @( VALUE #( id = get_uuid( ) calc_result = |Synchronous entry creation in the MAIN method. "num" value: { num }| crea_date_time = cl_abap_tstmp=>utclong2tstmp( utclong_current( ) ) ) ). "Processing code in the background DO 2 TIMES. "Creating an instance of the example class (that implements the bgPF-relevant "interface if_bgmc_op_single) DATA(inst) = NEW zcl_demo_abap( num = sy-index ). TRY. "Getting the default factory for transactional background processes and "creating a process for a single operation DATA(backgr) = cl_bgmc_process_factory=>get_default( )->create( ). "Setting a name of the process backgr->set_name( `bgPF Test` ). "Setting the transactionally controlled operation of the process backgr->set_operation( inst ). "Saving the background process for the asynchronous execution backgr->save_for_execution( ). "An explicit COMMIT WORK is required to start the background process. "This explicit call is not needed in the context of RAP because the RAP "framework will take care of the commit call. COMMIT WORK. CATCH cx_bgmc INTO DATA(error). out->write( error->get_text( ) ). ROLLBACK WORK. ENDTRY. "Another synchronous entry creation MODIFY zdemo_abap_tabca FROM @( VALUE #( id = get_uuid( ) calc_result = |Synchronous entry creation in the MAIN method. "num" value: { num }| crea_date_time = cl_abap_tstmp=>utclong2tstmp( utclong_current( ) ) ) ). WAIT UP TO 1 SECONDS. ENDDO. WAIT UP TO 2 SECONDS. "Displaying the content of a demo database table that was filled "in the course of the class execution SELECT id, calc_result, crea_date_time FROM zdemo_abap_tabca ORDER BY crea_date_time INTO TABLE @DATA(itab). out->write( itab ). ENDMETHOD. METHOD if_bgmc_op_single~execute. "Executing the operation under transactional control "Note: "- The method execution is started in the MODIFY transactional phase "- This means that only those operations are allowed that do not violate " transactional contracts to guarantee transactional consistency. "- As an example, database modifications performed when the MODIFY transactional " phase is active are not allowed. "- When the transactional phase is switched from MODIFY to SAVE, such database " modifications are allowed. "- This may happen explicitly using the save method of the cl_abap_tx class, " as is the case in the example. "- You can try out the following: Comment out the cl_abap_tx=>save( ). statement, " and run the example again. It results in a runtime error. "Includes the modification of class attributes modify( ). "Explicitly switches from the MODIFY to the SAVE transactional phase cl_abap_tx=>save( ). "Includes a database modification save( ). ENDMETHOD. METHOD get_uuid. TRY. uuid = cl_system_uuid=>create_uuid_x16_static( ). CATCH cx_uuid_error. ENDTRY. ENDMETHOD. METHOD constructor. IF num IS SUPPLIED. me->num = num. ENDIF. ENDMETHOD. METHOD modify. me->uuid = get_uuid( ). me->timestamp = utclong_current( ). ENDMETHOD. METHOD save. MODIFY zdemo_abap_tabca FROM @( VALUE #( id = uuid calc_result = |Asynchronous entry creation in background in the EXECUTE method. "num" value: { num }| crea_date_time = cl_abap_tstmp=>utclong2tstmp( utclong_current( ) ) ) ). ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_ABAP_LOCK_OBJECT_FACTORY |
For activating lock objects. Note that you can also use the DEQUEUE_ALL method to remove all locks in the current SAP LUW.
The following example code snippet uses artifacts from the ABAP cheat sheet repository.
``` abap "Deleting demo database table DELETE FROM zdemo_abap_rapt1. "Creating a database table entry and reading it into a data reference variable MODIFY zdemo_abap_rapt1 FROM @( VALUE #( key_field = 1 field1 = 'aaa' field2 = 'bbb' field3 = 2 field4 = 3 ) ). SELECT SINGLE * FROM zdemo_abap_rapt1 WHERE key_field = 1 INTO NEW @DATA(key). TRY. "Instantiating a lock object DATA(lock) = cl_abap_lock_object_factory=>get_instance( iv_name = 'EZDEMO_ABAP_LOCK' ). "Enqueuing a lock object "Note that there are various parameters. The parameter used in the example contains "a list of lock fields including a reference to the parameter value. lock->enqueue( it_parameter = VALUE #( ( name = 'KEY_FIELD' value = REF #( key->key_field ) ) ) ). CATCH cx_abap_lock_failure cx_abap_foreign_lock INTO DATA(enq_error). ENDTRY. TRY. "Dequeuing a lock object lock->dequeue( it_parameter = VALUE #( ( name = 'KEY_FIELD' value = REF #( key->key_field ) ) ) ). CATCH cx_abap_lock_failure INTO DATA(deq_error). ENDTRY. ``` |
| Class | Details/Code Snippet |
CL_WEB_HTTP_CLIENT_MANAGERCL_HTTP_DESTINATION_PROVIDER |
🟢 1. Read example: Retrieving ABAP cheat sheet markdown content using a GitHub API and sending a ZIP file with the content via email> **⚠️ Note/Disclaimer** > - The following self-contained and oversimplified example is not a representative best practice example, nor does it cover a meaningful use case. It only explores method calls and is intended to give a rough idea of the functionality. > - The example uses the create_by_url method, which is only suitable for public services or testing purposes. No authentication is required for the APIs used.
> - Note the Disclaimer.
> - For more information, more meaningful examples, and tutorials that deal with the classes and methods, see the following links:
> - Call an External API and Parse the Response in SAP BTP ABAP Environment
> - How to call a remote OData service from the trial version of SAP Cloud Platform ABAP environment
> - The example is generally about calling external APIs and parsing the HTTP responses. It retrieves the Markdown files of the ABAP cheat sheet documents Markdown contained in the ABAP cheat sheet GitHub repository.
> - Before using the GitHub APIs, make sure that you have consulted the following documentation: GitHub Docs, Render a Markdown document, Rate limits for the REST API
> - For the example to work and send emails, make sure that the configurations from [here](https://help.sap.com/docs/btp/sap-business-technology-platform/emailing) have been performed.
> - To run the example class, copy and paste the code into a class named `zcl_demo_abap`. Run the class using F9. The email sending status will be displayed, and you can expect an email to be sent.
``` abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. "Markdown URLs CONSTANTS url_cs TYPE string VALUE `https://api.github.com/repos/SAP-samples/abap-cheat-sheets/git/trees/main`. CONSTANTS url_gh TYPE string VALUE `https://raw.githubusercontent.com/SAP-samples/abap-cheat-sheets/main/`. "Here go email addresses CONSTANTS sender_addr TYPE cl_bcs_mail_message=>ty_address VALUE '...@...'. CONSTANTS recipient_addr TYPE cl_bcs_mail_message=>ty_address VALUE '...@...'. TYPES: BEGIN OF s, file_name TYPE string, markdown TYPE string, error TYPE abap_boolean, END OF s. DATA tab TYPE TABLE OF s WITH EMPTY KEY. DATA url TYPE string. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. "----------- Retrieving all Markdown file names in the ABAP cheat sheet GitHub repository ----------- TRY. "Creating a client object using a destination "In the example, the HTTP destination is created using a plain URL. "Here, a GitHub API is used to retrieve file names of the ABAP cheat sheet repository. DATA(http_client) = cl_web_http_client_manager=>create_by_http_destination( i_destination = cl_http_destination_provider=>create_by_url( i_url = url_cs ) ). "Sending an HTTP GET request and returning the response "In the example, the HTTP body is retrieved as string data. DATA(response) = http_client->execute( if_web_http_client=>get )->get_text( ). IF response CS `API rate limit exceeded`. out->write( `API rate limit exceeded` ). RETURN. ENDIF. CATCH cx_root INTO DATA(err). out->write( err->get_text( ) ). RETURN. ENDTRY. "----------- Retrieving Markdown content from ABAP cheat sheet GitHub repository ----------- IF err IS INITIAL. "Markdown file names are contained in the returned string in a specific "pattern. In the following code, the markdown file names are extracted "using a regular expression (pattern: "path":"04_ABAP_Object_Orientation.md") "After '"path":"' (not including this part, indivated by \K), two "digits must follow. Then, the further file name is captured with a "non-greedy capturing up to '.md'. FIND ALL OCCURRENCES OF PCRE `("path":")\K\d\d.*?\.md` IN response RESULTS DATA(results) IGNORING CASE. "The 'results' internal table contains all findings and includes their "offset and length information. "Using a loop, the actual file names are extracted from the 'response' "string and added to an internal table that is to receive more information "in the code below. LOOP AT results REFERENCE INTO DATA(md). tab = VALUE #( BASE tab ( file_name = substring( val = response off = md->offset len = md->length ) ) ). ENDLOOP. SORT tab BY file_name ASCENDING. "In the following loop, the Markdown content is retrieved using an HTTP GET request, also "by creating a client object and using a destination (another plain URL). The URL is constructed "using the constant value plus the markdown file that was retrieved before. LOOP AT tab REFERENCE INTO DATA(cs). url = url_gh && cs->file_name. TRY. http_client = cl_web_http_client_manager=>create_by_http_destination( i_destination = cl_http_destination_provider=>create_by_url( i_url = url ) ). DATA(raw_md) = http_client->execute( if_web_http_client=>get )->get_text( ). cs->markdown = raw_md. CATCH cx_root. cs->error = abap_true. ENDTRY. ENDLOOP. "----------- Creating a zip file containing all ABAP cheat sheet Markdown documents ----------- DATA(zip) = NEW cl_abap_zip( ). "Iteratively adding the ABAP cheat sheet Markdown documents to the zip file LOOP AT tab REFERENCE INTO cs WHERE error = abap_false. TRY. DATA(conv_xstring) = cl_abap_conv_codepage=>create_out( codepage = `UTF-8` )->convert( cs->markdown ). CATCH cx_sy_conversion_codepage. ENDTRY. "Adding the xstring content as file content to zip zip->add( name = cs->file_name content = conv_xstring ). ENDLOOP. "Saving the zip file DATA(zipped_file) = zip->save( ). "----------- Creating a ZIP file containing all ABAP cheat sheet Markdown documents ----------- "Sending email TRY. "Creating a new mail instance DATA(mail) = cl_bcs_mail_message=>create_instance( ). "Settings mail->set_sender( sender_addr ). mail->add_recipient( recipient_addr ). mail->set_subject( 'Test Mail' ). "Main document mail->set_main( cl_bcs_mail_textpart=>create_instance( iv_content = ' Test MailPlease find ABAP cheat sheet markdown files attached. 🟢 2. Post example: Demonstrating a post request by converting Markdown to HTML using the GitHub API> **⚠️ Note/Disclaimer** > - As stated for the previous example, also note for this example: Before using the GitHub APIs, make sure that you have consulted the following documentation: GitHub Docs, Render a Markdown document, Rate limits for the REST API > - To run the example class, copy and paste the code into a class named `zcl_demo_abap`. Run the class using F9. It is set up to display HTML content in the console. Using the GitHub API, sample Markdown content is sent and converted to HTML. ``` abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. CONSTANTS url_api TYPE string VALUE `https://api.github.com/markdown`. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. DATA(markdown_content) = `# Lorem ipsum dolor sit amet \n` && `Consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. \n` && `Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. \n` && `- Duis aute irure \n` && `- Dolor in reprehenderit in voluptate \n` && `1. Velit esse cillum dolore eu fugiat nulla pariatur \n` && `2. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \n` && `3. [ABAP cheat sheets](https://github.com/SAP-samples/abap-cheat-sheets)`. TRY. "Creation of a client object using a destination "This example deals with a POST request. DATA(http_client) = cl_web_http_client_manager=>create_by_http_destination( i_destination = cl_http_destination_provider=>create_by_url( i_url = url_api ) ). DATA(request) = http_client->get_http_request( ). request->set_text( `{"text":"` && markdown_content && `"}` ). request->set_header_fields( VALUE #( ( name = 'Accept' value = 'application/vnd.github+json' ) ) ). DATA(post) = http_client->execute( if_web_http_client=>post ). DATA(status) = post->get_status( ). IF status-code <> 200. out->write( |Post request error: { status-code } / { status-reason }| ). ELSE. DATA(html) = post->get_text( ). out->write( html ). ENDIF. CATCH cx_root INTO DATA(error). out->write( error->get_text( ) ). ENDTRY. ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
XCO_CP_XLSX |
The XCO library offers classes such as `XCO_CP_XLSX` and methods for reading and writing XLSX content. You can find more information [here](https://help.sap.com/docs/btp/sap-business-technology-platform/xlsx). The following example demonstrates a selection of methods and includes the following steps:
- Importing existing XLSX content into your SAP BTP ABAP Environment system (not related to the XCO library; just to have content to work with in the self-contained example below)
- This is a simplified, nonsemantic, and explorative RAP example (not delving into RAP as such; just using various ABAP repository objects related to RAP) solely for importing XLSX content to work with in the example.
- ⚠️ Note the repository's readme file for disclaimer and the [documentation](https://help.sap.com/docs/btp/sap-business-technology-platform/xlsx-read-access) for security considerations when importing and processing external content.
- The import is done using an automatically created SAP Fiori Elements app preview, which provides a simple UI for uploading local XLSX content.
- The repository objects are automatically created in ADT when walking through a wizard. Refer to the prerequisite steps for details.
- Reading XLSX content into an internal table using XCO
- Writing XLSX content using XCO based on internal table content
- A demo class explores a selection of XCO classes and methods. You can find the code in the expandable section.
- Exporting the adapted XLSX content (not related to the XCO library; just to visualize newly created XLSX content using XCO)
Expand the following collapsible section for example code.
🟢 Click to expand for example code**Prerequisite Steps for the XLSX Content Import into the SAP BTP ABAP Environment** The XLSX XCO module works with XLSX content in the form of an xstring. The following example assumes that you have XLSX content available as xstring. To try out the example, you can proceed as follows: - In your ABAP Cloud project in ADT, create a database table in the desired target package. This example uses the name `ztdemo_abap_xlsx`. - Give it a description, such as *Demo table*, and assign it to a transport. - Set up the example database table as follows: ```abap @EndUserText.label : 'Demo table' @AbapCatalog.enhancement.category : #NOT_EXTENSIBLE @AbapCatalog.tableCategory : #TRANSPARENT @AbapCatalog.deliveryClass : #A @AbapCatalog.dataMaintenance : #RESTRICTED define table ztdemo_abap_xlsx { key client : abap.clnt not null; key id : sysuuid_x16 not null; file_content : abap.rawstring(0); file_name : abap.char(128); file_mimetype : abap.char(128); @AbapCatalog.anonymizedWhenDelivered : true local_created_by : abp_creation_user; local_created_at : abp_creation_tstmpl; @AbapCatalog.anonymizedWhenDelivered : true local_last_changed_by : abp_locinst_lastchange_user; local_last_changed_at : abp_locinst_lastchange_tstmpl; last_changed_at : abp_lastchange_tstmpl; } ``` - Activate the database table. - In the *Project Explorer* view on the left, locate your created database table and right-click on it. Choose *Generate ABAP Repository Objects...* from the top section of the context menu. - This opens the *Generate ABAP Repository Objects* dialog box. - Select *OData UI Service*. Find information on the right about the RAP-specific repository objects to be created. These objects include CDS entities, BDEFs, ABPs, service definition and binding, among others. - Choose *Next*. - Select the package and choose *Next*. - The next screen in the dialog box lets you specify additional details for RAP repository objects, such as alias names. However, you can also leave it as is and choose *Next*. - The following screen displays a list of artifacts set to be created. Choose *Next*. - Then, select the transport request and choose *Finish*. - The creation of the repository objects may take some time. Once completed, the service binding will appear. Keep it open, but refrain from making any adjustments at this point. - Proceed to access the generated CDS entity. Note that two CDS entities are created. Access the one **without** the *with projection on* specification (the example entity name is `ZR_TDEMO_ABAP_XLSX`). The specification appears as follows. ```abap ... define root view entity ZR_TDEMO_ABAP_XLSX as select from ZTDEMO_ABAP_XLSX ... ``` - Adapt the CDS entity as follows. It is essential that the `@Semantics` annotations are specified and the provided names match. ```abap @AccessControl.authorizationCheck: #NOT_REQUIRED @Metadata.allowExtensions: true @EndUserText.label: 'Demo CDS Entity' define root view entity ZR_TDEMO_ABAP_XLSX as select from ztdemo_abap_xlsx { key id as Id, @Semantics.largeObject: { mimeType: 'FileMimetype', fileName: 'FileName', contentDispositionPreference: #ATTACHMENT } file_content as FileContent, file_name as FileName, @Semantics.mimeType: true file_mimetype as FileMimetype, @Semantics.user.createdBy: true @UI.hidden local_created_by as LocalCreatedBy, @Semantics.systemDateTime.createdAt: true @UI.hidden local_created_at as LocalCreatedAt, @Semantics.user.localInstanceLastChangedBy: true @UI.hidden local_last_changed_by as LocalLastChangedBy, @Semantics.systemDateTime.localInstanceLastChangedAt: true @UI.hidden local_last_changed_at as LocalLastChangedAt, @Semantics.systemDateTime.lastChangedAt: true @UI.hidden last_changed_at as LastChangedAt } ``` - Activate the CDS entity. - Return to the service binding located in your package under *Business Services -> Service Bindings* (e.g. `ZUI_TDEMO_ABAP_XLSX_O4`). - Choose the *Publish* button for the *Local Service Endpoint*. The publishing may take some time. - After publishing, locate the *Service Version Details* section on the right. Under *Entity Set and Association*, right-click the newly created entity set and select *Open Fiori Elements App Preview*. - This action opens the SAP Fiori Elements app in a new browser window. - Within the app, choose the *Create* button. - You should see a *Browse* button in the *FileContent* field. - Choose this button and select a local XLSX file. Note: You can use the example XLSX content provided below. Only with this content does the example class work properly. For your own explorations, adapt the class code accordingly. - After uploading the file, choose *Create* at the bottom to save the entry. - Refer to the comments in the example class below. You can either exit the app now, leaving one entry in the database with the XLSX content, or use the UUID value of the created entry in the `WHERE` clause of the `SELECT` statement at the beginning of the `main` method implementation below. > **💡 Note** > - If there are issues with the UI (e.g. you cannot upload), try out UI V2. > - Create a new service definition, e.g. right-click the *Service Definition* folder and choose *New Service Definition*. > - Provide a name (e.g. `ZUI_TDEMO_ABAP_XLSX_O2`) and description. Choose *Next*. > - The code should look as follows: > ```abap > @EndUserText.label: 'Service Definition' > define service ZUI_TDEMO_ABAP_XLSX_O2 > provider contracts odata_v2_ui { > expose ZC_TDEMO_ABAP_XLSX; > } > ``` > - Activate it and create a new service binding, e.g. by right-clicking the service definition and choosing *New Service Binding*. > - Create the binding (e.g. with the same name as the service definition `ZUI_TDEMO_ABAP_XLSX_O2`), and select *OData V2 - UI* as *Binding Type*. > - Activate and publish the local service endpoint. > - Access the preview app as described above. > **📝 Example XLSX content** >- Copy and paste the following data into your demo XLSX file. The example only uses simple character-like values. Note the information in the documentation about value transformation when processing the XLSX content. >- Your XLSX creation program may have a feature, such as *text to column*, that can help you divide the text into separate columns. In this case, the first four columns are filled. >- The delimiter is a comma, indicating that there are four columns to be filled with the demo data. >- Name the first worksheet (where you insert the demo data) `Sheet1`. > ``` >AA,American Airlines,USD,http://www.aa.com >AC,Air Canada,CAD,http://www.aircanada.ca >AF,Air France,EUR,http://www.airfrance.fr >BA,British Airways,GBP,http://www.british-airways.com >CO,Continental Airlines,USD,http://www.continental.com >DL,Delta Airlines,USD,http://www.delta-air.com >LH,Lufthansa,EUR,http://www.lufthansa.com >JL,Japan Airlines,JPY,http://www.jal.co.jp >NW,Northwest Airlines,USD,http://www.nwa.com >QF,Qantas Airways,AUD,http://www.qantas.com.au >SA,South African Air.,ZAR,http://www.saa.co.za >SQ,Singapore Airlines,SGD,http://www.singaporeair.com >SR,Swiss,CHF,http://www.swiss.com >UA,United Airlines,USD,http://www.ual.com >``` **Exploring the XCO XLSX Module** Assuming you have the XLSX content created and uploaded above on your system, you can explore the following example using the XCO classes/methods. Set up a demo class called `zcl_demo_abap` and use the code provided below. After activating it, choose *F9* in ADT to run the class. The example is designed to show output in the console. > **💡 Note** > - Refer to the comments in the code for information. > - If you have used different names than those in this example, make sure to replace those names in the code. > - If your artifacts have a different setup, names, or XLSX content, the example class will not function properly. You willl need to modify the class code to match your specific requirements. ```abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. "As a prerequisite, you have walked through the steps mentioned. RAP repository objects "were created, adapted as mentioned, and activated. You have at least one XLSX file imported "using the preview app. XLSX content is available in the database table as xstring. "--------------------------------------- NOTE ---------------------------------------- "------ This is only intended for demonstration purposes!! Do note the security ------ "------ aspects etc. when importing external content. The focus of this example ------ "------ is to explore the XCO XLSX module. ------------------------------------------ "The SELECT statement assumes there is one entry available. Otherwise, adapt the "statement accordingly, e.g. by adding a WHERE clause and providing the UUID you can "copy for a created entry in the Fiori Elements preview app. Note the XCO class with "which to transform the UUID. Replace the dummy UUID. SELECT SINGLE id, file_content FROM ztdemo_abap_xlsx "WHERE id = @( CONV sysuuid_c32( " xco_cp_uuid=>format->c32->from_uuid( xco_cp_uuid=>format->c36->to_uuid( 'a1a2a3a4-b1b2-c1c2-d3d4-e5e6e7e8e9e0' ) ) ) ) INTO @DATA(xlsx). IF sy-subrc <> 0 OR xlsx-file_content IS INITIAL. out->write( `No XLSX content available to work with` ). RETURN. ENDIF. out->write( `Exploring reading and writing XLSX content with the XCO library` ). out->write( |\n\n| ). out->write( `-------------------- Read access to XLSX content --------------------` ). out->write( |\n\n| ). "Note: Using method chaining, the following method calls can also be done in a more concise way. "As a first step (for reading and writing XLSX content), getting a handle to process "XLSX content, which is available as xstring. DATA(xlsx_doc) = xco_cp_xlsx=>document->for_file_content( xlsx-file_content ). "------------------------ Read access to XLSX content ------------------------ "Getting read access DATA(read_xlsx) = xlsx_doc->read_access( ). "Reading the first worksheet of the XLSX file DATA(worksheet1) = read_xlsx->get_workbook( )->worksheet->at_position( 1 ). "You can also specify the name of the worksheet "DATA(worksheet1) = read_xlsx->get_workbook( )->worksheet->for_name( 'Sheet1' ). "Using selection patterns "The XCO XLSX module works with selection patterns that define how the content "in a worksheet is selected (i.e. whether everything or a restricted set is selected). "Check the documentation for further information. "The following selection pattern respects all values. DATA(pattern_all) = xco_cp_xlsx_selection=>pattern_builder->simple_from_to( )->get_pattern( ). "The following selection pattern restricts the content used. Here, column A is left "out (starting from column B), and the first two rows are skipped (starting from row "number 3). DATA(pattern_restrict) = xco_cp_xlsx_selection=>pattern_builder->simple_from_to( )->from_column( xco_cp_xlsx=>coordinate->for_alphabetic_value( 'B' ) )->from_row( xco_cp_xlsx=>coordinate->for_numeric_value( 3 ) )->get_pattern( ). "--- Reading using row streams --- "The examples reads into an internal table of a known structure. "Declaring an internal table based on a local structure (representing "the 'known structure') TYPES: BEGIN OF carr_line_type, carrid TYPE c LENGTH 3, carrname TYPE c LENGTH 20, currcode TYPE string, url TYPE c LENGTH 255, END OF carr_line_type, carr_tab_type TYPE TABLE OF carr_line_type WITH EMPTY KEY. DATA carr_tab TYPE carr_tab_type. "Note that the content is written to a reference to an internal table "with the write_to method. worksheet1->select( pattern_all )->row_stream( )->operation->write_to( REF #( carr_tab ) )->execute( ). "Retrieving the table lines to compare the values with the next "example that uses a different selection pattern DATA(lines_tab1) = lines( carr_tab ). "Displaying the read result in the console out->write( |Lines in carr_tab: { lines_tab1 }| ). out->write( data = carr_tab name = `carr_tab` ). out->write( |\n\n| ). CLEAR carr_tab. "Compare the content/output of the previous internal table and "the following one. The CARRID field is not filled because of starting "the selection in the second column. The first two entries of the previous "internal table are not available in the other because of starting in "the third row. worksheet1->select( pattern_restrict )->row_stream( )->operation->write_to( REF #( carr_tab ) )->execute( ). DATA(lines_tab2) = lines( carr_tab ). out->write( |Lines in carr_tab: { lines_tab2 }| ). out->write( data = carr_tab name = `carr_tab` ). out->write( |\n\n| ). "--- Reading via a cursor --- "I.e. you specify the cursor position which represents the coordinate "values of column and row. Once specified, you can access the content based "on the cursor position in various directions using the MOVE* methods. "The following internal table is created for output purposes and includes "various pieces of cursor position information. TYPES: BEGIN OF cursor_info, string_value TYPE string, cursor_position_column_alphab TYPE string, cursor_position_column_num TYPE i, cursor_position_row_alphab TYPE string, cursor_position_row_num TYPE i, END OF cursor_info. DATA itab_cursor_info_move_down TYPE TABLE OF cursor_info WITH EMPTY KEY. DATA itab_cursor_info_move_right TYPE TABLE OF cursor_info WITH EMPTY KEY. DATA itab_cursor_info_move_left TYPE TABLE OF cursor_info WITH EMPTY KEY. DATA itab_cursor_info_move_up TYPE TABLE OF cursor_info WITH EMPTY KEY. DATA string_value TYPE string. "Positioning the cursor (starting in column B, third row) DATA(cursor) = worksheet1->cursor( io_column = xco_cp_xlsx=>coordinate->for_alphabetic_value( 'B' ) io_row = xco_cp_xlsx=>coordinate->for_numeric_value( 3 ) ). "Retrieving column and row information and storing it in a structure for "output purposes (to show where the cursor is positioned as specifed above) DATA(cursor_set) = VALUE cursor_info( cursor_position_column_alphab = cursor->position->column->get_alphabetic_value( ) cursor_position_column_num = cursor->position->column->get_numeric_value( ) cursor_position_row_alphab = cursor->position->row->get_alphabetic_value( ) cursor_position_row_num = cursor->position->row->get_numeric_value( ) ). "Getting the value "Note: String value transformation is done in the example. Note the information "in the documentation. cursor->get_cell( )->get_value( )->set_transformation( xco_cp_xlsx_read_access=>value_transformation->string_value )->write_to( REF #( string_value ) ). cursor_set-string_value = string_value. out->write( |Cursor information| ). out->write( |\n\n| ). out->write( data = cursor_set name = `cursor_set` ). out->write( |\n\n| ). "Looping across the cells and retrieving individual cursor position information and "the string values "--- Moving down --- WHILE cursor->has_cell( ) = abap_true AND cursor->get_cell( )->has_value( ) = abap_true. DATA(cell_cnt) = cursor->get_cell( ). "Storing column and row information in data objects DATA(cursor_position_column_alphab) = cursor->position->column->get_alphabetic_value( ). DATA(cursor_position_column_num) = cursor->position->column->get_numeric_value( ). DATA(cursor_position_row_alphab) = cursor->position->row->get_alphabetic_value( ). DATA(cursor_position_row_num) = cursor->position->row->get_numeric_value( ). "Getting the content of the cell by applying a value transformation to the "content cell_cnt->get_value( )->set_transformation( xco_cp_xlsx_read_access=>value_transformation->string_value )->write_to( REF #( string_value ) ). "Adding the column and row information and the string value to an internal table "for output purposes APPEND VALUE #( string_value = string_value cursor_position_column_alphab = cursor_position_column_alphab cursor_position_column_num = cursor_position_column_num cursor_position_row_alphab = cursor_position_row_alphab cursor_position_row_num = cursor_position_row_num ) TO itab_cursor_info_move_down. "Moving the cursor down TRY. cursor->move_down( ). CATCH cx_xco_runtime_exception. EXIT. ENDTRY. ENDWHILE. out->write( data = itab_cursor_info_move_down name = `itab_cursor_info_move_down` ). out->write( |\n\n| ). "--- Moving right --- "Repositioning the cursor cursor = worksheet1->cursor( io_column = xco_cp_xlsx=>coordinate->for_alphabetic_value( 'B' ) io_row = xco_cp_xlsx=>coordinate->for_numeric_value( 3 ) ). WHILE cursor->has_cell( ) = abap_true AND cursor->get_cell( )->has_value( ) = abap_true. cell_cnt = cursor->get_cell( ). cursor_position_column_alphab = cursor->position->column->get_alphabetic_value( ). cursor_position_column_num = cursor->position->column->get_numeric_value( ). cursor_position_row_alphab = cursor->position->row->get_alphabetic_value( ). cursor_position_row_num = cursor->position->row->get_numeric_value( ). cell_cnt->get_value( )->set_transformation( xco_cp_xlsx_read_access=>value_transformation->string_value )->write_to( REF #( string_value ) ). APPEND VALUE #( string_value = string_value cursor_position_column_alphab = cursor_position_column_alphab cursor_position_column_num = cursor_position_column_num cursor_position_row_alphab = cursor_position_row_alphab cursor_position_row_num = cursor_position_row_num ) TO itab_cursor_info_move_right. "Moving the cursor right TRY. cursor->move_right( ). CATCH cx_xco_runtime_exception. EXIT. ENDTRY. ENDWHILE. out->write( data = itab_cursor_info_move_right name = `itab_cursor_info_move_right` ). out->write( |\n\n| ). "--- Moving left --- "Repositioning the cursor cursor = worksheet1->cursor( io_column = xco_cp_xlsx=>coordinate->for_alphabetic_value( 'B' ) io_row = xco_cp_xlsx=>coordinate->for_numeric_value( 3 ) ). WHILE cursor->has_cell( ) = abap_true AND cursor->get_cell( )->has_value( ) = abap_true. cell_cnt = cursor->get_cell( ). cursor_position_column_alphab = cursor->position->column->get_alphabetic_value( ). cursor_position_column_num = cursor->position->column->get_numeric_value( ). cursor_position_row_alphab = cursor->position->row->get_alphabetic_value( ). cursor_position_row_num = cursor->position->row->get_numeric_value( ). cell_cnt->get_value( )->set_transformation( xco_cp_xlsx_read_access=>value_transformation->string_value )->write_to( REF #( string_value ) ). APPEND VALUE #( string_value = string_value cursor_position_column_alphab = cursor_position_column_alphab cursor_position_column_num = cursor_position_column_num cursor_position_row_alphab = cursor_position_row_alphab cursor_position_row_num = cursor_position_row_num ) TO itab_cursor_info_move_left. "Moving the cursor left TRY. cursor->move_left( ). CATCH cx_xco_runtime_exception. EXIT. ENDTRY. ENDWHILE. out->write( data = itab_cursor_info_move_left name = `itab_cursor_info_move_left` ). out->write( |\n\n| ). "--- Moving up --- "Repositioning the cursor cursor = worksheet1->cursor( io_column = xco_cp_xlsx=>coordinate->for_alphabetic_value( 'B' ) io_row = xco_cp_xlsx=>coordinate->for_numeric_value( 3 ) ). WHILE cursor->has_cell( ) = abap_true AND cursor->get_cell( )->has_value( ) = abap_true. cell_cnt = cursor->get_cell( ). cursor_position_column_alphab = cursor->position->column->get_alphabetic_value( ). cursor_position_column_num = cursor->position->column->get_numeric_value( ). cursor_position_row_alphab = cursor->position->row->get_alphabetic_value( ). cursor_position_row_num = cursor->position->row->get_numeric_value( ). cell_cnt->get_value( )->set_transformation( xco_cp_xlsx_read_access=>value_transformation->string_value )->write_to( REF #( string_value ) ). APPEND VALUE #( string_value = string_value cursor_position_column_alphab = cursor_position_column_alphab cursor_position_column_num = cursor_position_column_num cursor_position_row_alphab = cursor_position_row_alphab cursor_position_row_num = cursor_position_row_num ) TO itab_cursor_info_move_up. "Moving the cursor up TRY. cursor->move_up( ). CATCH cx_xco_runtime_exception. EXIT. ENDTRY. ENDWHILE. out->write( data = itab_cursor_info_move_up name = `itab_cursor_info_move_up` ). out->write( |\n\n| ). ********************************************************************** "------------------------ Write access to XLSX content ------------------------ "- The following example creates a new XLSX document. "- Two worksheets are created. "- New content is added (based on demo internal tables). "- The existing XLSX content is replaced by the new content. An ABAP SQL UPDATE " statement is included to update the file content. If you have implemented " the SAP Fiori Elements and access the entry, you can download the new " XLSX file to your local machine. "---------------------------------- NOTE ---------------------------------- "---- Do note that this is just for demonstration purposes to quickly ---- "---- explore the new XLSX content (without considering RAP-related ---- "--- things and other database table fields such as the time stamps). ---- out->write( `-------------------- Write XLSX content --------------------` ). out->write( |\n\n| ). "Creating a new XLSX document DATA(write_xlsx) = xco_cp_xlsx=>document->empty( )->write_access( ). "Note that the name of the created worksheet is Sheet1 "Accessing the first worksheet via the position DATA(ws1) = write_xlsx->get_workbook( )->worksheet->at_position( 1 ). "Poviding XLSX content "--- Writing data via a row stream --- "In this case, the structure is statically known. The content of an internal table "is used. DATA(itab) = VALUE carr_tab_type( ( carrid = 'WX' carrname = 'Air WZ' currcode = 'GBP' url = 'some_url_wx' ) ( carrid = 'XY' carrname = 'XY Airlines' currcode = 'EUR' url = 'some_url_xy' ) ( carrid = 'YZ' carrname = 'YZ Airways' currcode = 'USD' url = 'some_url_yz' ) ). "As is the case with the read access, a pattern is used. "The following pattern uses the entire content. DATA(pattern_all4write) = xco_cp_xlsx_selection=>pattern_builder->simple_from_to( )->get_pattern( ). "Writing the internal table lines to the worksheet using the write_from method ws1->select( pattern_all4write )->row_stream( )->operation->write_from( REF #( itab ) )->execute( ). "--- Writing data via a cursor --- "To demonstrate this writing method, a new worksheet is created using the "add_new_sheet method. A name is provided, too. DATA(create_new_worksheet) = write_xlsx->get_workbook( )->add_new_sheet( `Sheet2` ). "Accessing the second worksheet via the position DATA(ws2) = write_xlsx->get_workbook( )->worksheet->at_position( 2 ). "Checking if the new worksheet exists at position 2 using the exists method DATA(ws2_pos_exists) = write_xlsx->get_workbook( )->worksheet->at_position( 2 )->exists( ). IF ws2_pos_exists = abap_true. out->write( `The newly created worksheet exists at position 2` ). ELSE. out->write( `The newly created worksheet does not exist at position 2` ). ENDIF. out->write( |\n\n| ). "Another internal table to have different demo data in the two worksheets DATA(itab2) = VALUE carr_tab_type( ( carrid = 'ZA' carrname = 'Air ZA' currcode = 'CAD' url = 'some_url_za' ) ( carrid = 'YB' carrname = 'YB Airlines' currcode = 'JPY' url = 'some_url_yb' ) ( carrid = 'XC' carrname = 'XC Airways' currcode = 'ZAR' url = 'some_url_xc' ) ). "Example implementation: Looping across the internal table to put individual "component values in the worksheet LOOP AT itab2 INTO DATA(wa). DATA(tabix) = sy-tabix. "Positioning the cursor "The idea is to write all the content starting in the top left "corner of the worksheet. You can imagine other positions when "specifying actual parameters for io_column and io_row. "More methods are available. See the documentation. "Note: The cursor is repositioned with every loop pass here starting "with the first column. The row value is represented by the table "index (sy-tabix value), i.e. the second data set of the internal table "available in the work area in the second loop pass table goes in the "second row, and so on. DATA(cursor4write) = ws2->cursor( io_column = xco_cp_xlsx=>coordinate->for_alphabetic_value( 'A' ) io_row = xco_cp_xlsx=>coordinate->for_numeric_value( tabix ) ). cursor4write->get_cell( )->value->write_from( wa-carrid ). "Moving right to populate other columns cursor4write->move_right( )->get_cell( )->value->write_from( wa-carrname ). cursor4write->move_right( )->get_cell( )->value->write_from( wa-url ). "Note: The example skips one component. ENDLOOP. "Once content has been provided, getting the file content (both worksheets of "the example) DATA(file_content) = write_xlsx->get_file_content( ). "In this example, the uploaded XLSX content is replaced by the newly created "XLSX content by just updating the file_content field. It is just for demonstration "purposes as commented above. "If you have created the SAP Fiori Elements preview app, you can download the XLSX file. "To do so, access the app via the service binding as described. Find the entry with the "provided ID (it is output in the console), and choose it. In the detail view of the app, "you can choose the button next to the file content. It should download an XLSX file, "now having the created content. UPDATE ztdemo_abap_xlsx SET file_content = @file_content WHERE id = @xlsx-id. IF sy-subrc = 0. out->write( |The database table was updated. If implemented, check the file with id { xlsx-id }| ). ELSE. out->write( `The database table was not updated.` ). ENDIF. ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_ABAP_ZIP |
The following example creates a zip file and adds three txt files with sample content. Note that the example snippet for `CL_WEB_HTTP_CLIENT_MANAGER` and `CL_HTTP_DESTINATION_PROVIDER` (calling services) also includes the use of `CL_ABAP_ZIP`. ```abap "Creating a zip file DATA(zip) = NEW cl_abap_zip( ). "Adding 3 files to the zip file DO 3 TIMES. DATA(some_content) = |Some text content for file number { sy-index }.|. TRY. DATA(conv_xstring) = cl_abap_conv_codepage=>create_out( codepage = `UTF-8` )->convert( some_content ). CATCH cx_sy_conversion_codepage. ENDTRY. "Adding xstring as file content to zip zip->add( EXPORTING name = |file{ sy-index }.txt| content = conv_xstring ). ENDDO. "Saving the zip file DATA(zipped_file) = zip->save( ). "Unzipping a zip file DATA unzipped_content_tab TYPE string_table. DATA(unzip) = NEW cl_abap_zip( ). unzip->load( zipped_file ). LOOP AT unzip->files INTO DATA(file). unzip->get( EXPORTING name = file-name IMPORTING content = DATA(unzipped_content) ). "Converting xstring to string TRY. DATA(conv_string) = cl_abap_conv_codepage=>create_in( )->convert( unzipped_content ). CATCH cx_sy_conversion_codepage. ENDTRY. APPEND conv_string TO unzipped_content_tab. ENDLOOP. *Content of unzipped_content_tab: *Some text content for file number 1. *Some text content for file number 2. *Some text content for file number 3. ``` |
| Class | Details/Code Snippet |
CL_ABAP_UNIT_ASSERT |
Provides methods to verify test expectations in ABAP Unit tests. For more information, see the [ABAP Unit Tests](14_ABAP_Unit_Tests.md) cheat sheet. ```abap "Code in a test class ... DATA(result) = 100. ... cl_abap_unit_assert=>assert_equals( act = result exp = 100 msg = `The value does not match the expected result` quit = if_abap_unit_constant=>quit-no ). ``` |
CL_ABAP_TESTDOUBLECL_OSQL_TEST_ENVIRONMENTCL_CDS_TEST_ENVIRONMENTCL_BOTD_TXBUFDBL_BO_TEST_ENVCL_BOTD_MOCKEMLAPI_BO_TEST_ENV |
- The classes can be used in the context of ABAP Unit to create test doubles in a standardized way. - The test doubles replace dependent-on components (DOC) during unit tests. - DOCs: - Classes and interfaces: - `CL_ABAP_TESTDOUBLE`: ABAP OO Test Double Framework - Database (e.g. database tables or CDS view entities) - `CL_OSQL_TEST_ENVIRONMENT`: ABAP SQL Test Double Framework; to test ABAP SQL statements that depend on data sources such as database tables or CDS view entities - `CL_CDS_TEST_ENVIRONMENT`: ABAP CDS Test Double Framework; to test logic implemented in CDS entities - RAP business objects - `CL_BOTD_TXBUFDBL_BO_TEST_ENV`: Creating transactional buffer test doubles - `CL_BOTD_MOCKEMLAPI_BO_TEST_ENV`: Mocking ABAP EML APIs - Note that more classes are available for other use cases. - For more information, see the [ABAP Unit Tests](14_ABAP_Unit_Tests.md) cheat sheet and the [documentation](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/managing-dependencies-with-abap-unit). |
| Class | Details/Code Snippet |
CL_UOM_DIM_MAINTENANCE |
- Handling dimensions
- Find more information [here](https://help.sap.com/docs/ABAP_ENVIRONMENT/250515df61b74848810389e964f8c367/8961c2c4cebf457f95fb080a736babdc.html?locale=en-US) and in the class documentation.
- The example code snippet includes reading dimensions. See the link above for the methods to create, change and delete dimensions.
```abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. DATA(dimension_inst) = cl_uom_dim_maintenance=>get_instance( ). TRY. dimension_inst->read( EXPORTING dimid = 'TEMP' IMPORTING dim_st = DATA(dimension_details) ). DATA(id) = dimension_details-dimid. DATA(text) = dimension_details-txdim. out->write( data = id name = `id` ). out->write( data = text name = `text` ). CATCH cx_uom_error INTO DATA(read_error). out->write( read_error->get_text( ) ). ENDTRY. out->write( repeat( val = `-` occ = 50 ) ). ********************************************************************** "Reading dimensions based on entries in the released view I_UnitOfMeasureDimension "Various components and values from the returned structure are output for demonstration purposes. SELECT UnitOfMeasureDimension FROM I_UnitOfMeasureDimension INTO TABLE @DATA(dimensions) UP TO 10 ROWS. LOOP AT dimensions INTO DATA(wa). DATA(dim_inst) = cl_uom_dim_maintenance=>get_instance( ). TYPES c6 TYPE c LENGTH 6. TRY. dim_inst->read( EXPORTING dimid = CONV c6( wa ) IMPORTING dim_st = DATA(dim_details) ). LOOP AT CAST cl_abap_structdescr( cl_abap_typedescr=>describe_by_data( dim_details ) )->components INTO DATA(co). "Applying string conversion to name and values for output purposes "Note that many of the components have numeric types. DATA(comp) = CONV string( co-name ). DATA(value) = CONV string( dim_details-(comp) ). "Outputting only those entries that do not have an initial value IF value IS NOT INITIAL AND value NP `0*`. out->write( data = value name = comp ). ENDIF. ENDLOOP. CATCH cx_uom_error INTO DATA(read_err). out->write( read_err->get_text( ) ). ENDTRY. out->write( repeat( val = `-` occ = 20 ) ). ENDLOOP. ENDMETHOD. ENDCLASS. ``` |
CL_UOM_MAINTENANCE |
- Handling units of measurement
- Find more information [here](https://help.sap.com/docs/ABAP_ENVIRONMENT/250515df61b74848810389e964f8c367/238be94930874ed9ba3a3dc6469e99b3.html?locale=en-US) and in the class documentation.
- The example code snippet includes reading units of measurement. See the link above for the methods to create, change and delete dimensions.
```abap DATA(unit_mea_inst) = cl_uom_maintenance=>get_instance( ). TRY. unit_mea_inst->read( EXPORTING unit = 'S' IMPORTING unit_st = DATA(unit_mea) ). DATA(unit) = unit_mea-unit. DATA(comm) = unit_mea-commercial. DATA(tech) = unit_mea-technical. DATA(iso) = unit_mea-isocode. DATA(id) = unit_mea-dimid. DATA(text) = unit_mea-long_text. CATCH cx_uom_error INTO DATA(unit_read_error). DATA(error_msg) = unit_read_error->get_text( ). ENDTRY. "Note: Released view for units of measurement: I_UNITOFMEASURE. ``` |
CL_UOM_CONVERSION |
- Converting units of measurement
- Find more information [here](https://help.sap.com/docs/ABAP_ENVIRONMENT/250515df61b74848810389e964f8c367/73109c66f397494abfa2bf3608740c12.html?locale=en-US) and in the class documentation.
- The example code snippet explores unit of measurement conversion. See the link above for more methods available.
```abap DATA output TYPE decfloat34. DATA(conv_unit_inst) = cl_uom_conversion=>create( ). conv_unit_inst->unit_conversion_simple( EXPORTING input = CONV decfloat34( '1' ) round_sign = 'X' unit_in = 'KG' unit_out = 'G' IMPORTING output = output EXCEPTIONS conversion_not_found = 01 division_by_zero = 02 input_invalid = 03 output_invalid = 04 overflow = 05 units_missing = 06 unit_in_not_found = 07 unit_out_not_found = 08 ). IF sy-subrc = 0. "1000.000 DATA(outp) = output. ELSE. DATA(subrc) = sy-subrc. ENDIF. TYPES: BEGIN OF s, input TYPE decfloat34, round_sign TYPE c LENGTH 1, unit_in TYPE cl_uom_conversion=>ty_msehi, unit_out TYPE cl_uom_conversion=>ty_msehi, END OF s, tab_type TYPE TABLE OF s WITH EMPTY KEY. DATA(tab4conv) = VALUE tab_type( ( input = '1.9876543210' round_sign = '+' "rounding up unit_in = 'KG' unit_out = 'G' ) ( input = '1.9876543210' round_sign = '-' "rounding down unit_in = 'KG' unit_out = 'G' ) ( input = '1987.6543210' round_sign = ' ' "no rounding unit_in = 'G' unit_out = 'KG' ) ( input = '60' round_sign = 'X' "commercial unit_in = 'MIN' unit_out = 'H' ) ( input = '1' round_sign = 'X' unit_in = 'TAG' unit_out = 'H' ) ( input = '1' round_sign = 'X' unit_in = 'JHR' unit_out = 'TAG' ) ( input = '123456' round_sign = 'X' unit_in = 'ABC' unit_out = 'H' ) ). LOOP AT tab4conv INTO DATA(conversion). DATA(conv_inst) = cl_uom_conversion=>create( ). conv_inst->unit_conversion_simple( EXPORTING input = conversion-input round_sign = conversion-round_sign unit_in = conversion-unit_in unit_out = conversion-unit_out IMPORTING output = output EXCEPTIONS conversion_not_found = 01 division_by_zero = 02 input_invalid = 03 output_invalid = 04 overflow = 05 units_missing = 06 unit_in_not_found = 07 unit_out_not_found = 08 ). IF sy-subrc = 0. outp = output. ELSE. subrc = sy-subrc. ENDIF. ENDLOOP. *Results: *1987.655 *1987.654 *1.98765 *1.0 *24.0 *365.0 *7 (error, sy-subrc value) "Retrieving mass- and time-related units of measurement using "a released API SELECT * FROM i_unitofmeasure WHERE unitofmeasuredimension = `TIME` OR unitofmeasuredimension = `MASS` INTO TABLE @DATA(umea). ``` |
| Class | Details/Code Snippet |
CL_SATC_API |
- The class provides access to the ABAP Test Cockpit (ATC) API.
- Find more information about checking the quality of ABAP Code with ATC [here](https://help.sap.com/docs/ABAP_Cloud/bbcee501b99848bdadecd4e290db3ae4/4ec5711c6e391014adc9fffe4e204223.html?locale=en-US).
- The example code snippet ...
- explores the API by creating a factory object, creating and starting an ATC run, and checking the information returned.
- includes some statements that are found by ATC runs such as a deprecated statement, and a literal in the code.
- includes check variants. You may want to comment out the one, and comment in the other. For example, find check variants as follows: Right-click in the code -> Run as -> 3 ABAP Text Cockpit With... -> Choose Browse in the pop-up -> Insert `*` for *Select your check variant* and find available check variants in the system. You can also create your own ATC check variant, for example, by right-clicking your package -> New -> Other ABAP Repository Object -> Filter for *ATC Check Variant*, select it and proceed with the wizard.
```abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. DATA num TYPE i VALUE 1. GET REFERENCE OF num INTO DATA(ref). DATA(current_time) = sy-uzeit. out->write( `Some text` ). ********************************************************************** TRY. "Creating a factory object DATA(atc) = cl_satc_api=>create_api_factory( ). "Creating an ATC run and starting it "The ATC run result is stored in a variable. DATA(atc_result) = atc->create_run( atc->create_run_configuration( atc->create_object_set_for_list( VALUE #( ( obj_type = 'CLAS' obj_name = 'ZCL_DEMO_ABAP' ) ) ) )->set_check_variant( atc->get_check_variant_by_name( 'ABAP_CLOUD_READINESS' "'ABAP_CLOUD_DEVELOPMENT_DEFAULT' ) ) )->run( ). CATCH cx_satc_api INTO DATA(exc). out->write( |Error: { exc->get_text( ) }| ). RETURN. ENDTRY. "Returning the result ID DATA(result_id) = atc_result->get_result_id( ). out->write( |Result ID: { result_id }| ). "Returning all information of the findings reported during the run DATA(findings) = atc_result->get_findings_with_text( ). IF findings IS INITIAL. out->write( `No findings` ). ELSE. out->write( findings ). ENDIF. ENDMETHOD. ENDCLASS. ``` |
| Class | Details/Code Snippet |
CL_NUMBERRANGE_OBJECTSCL_NUMBERRANGE_INTERVALSCL_NUMBERRANGE_RUNTIME |
- Find more information in the SAP Help Portal, section [Number Range Solution](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/0335201e35bb433eab298bf8f389ea11.html), and in the class documentation.
- The code snippets rudimentarily show methods of the classes to retrieve information. You can find more snippets in the documentation linked above and check the various parameters.
```abap "Use a valid number range object DATA(numberrange_object) = 'Z.........'. "Retrieving attributes of number range objects TRY. cl_numberrange_objects=>read( EXPORTING object = numberrange_object IMPORTING attributes = DATA(attr) interval_exists = DATA(intv_exists) obj_text = DATA(obj_text) ). CATCH cx_nr_object_not_found cx_number_ranges. ENDTRY. "Retrieving intervals of number range objects TRY. cl_numberrange_intervals=>read( EXPORTING object = numberrange_object IMPORTING interval = DATA(intv) ). CATCH cx_nr_object_not_found cx_nr_subobject cx_number_ranges. ENDTRY. "Retrieving numbers from number range object intervals TRY. cl_numberrange_runtime=>number_get( EXPORTING nr_range_nr = '01' object = numberrange_object IMPORTING number = DATA(number) returncode = DATA(rc) returned_quantity = DATA(quan) ). CATCH cx_nr_object_not_found cx_number_ranges. ENDTRY. ``` |
| Class | Details/Code Snippet |
CL_ABAP_API_STATE |
- You can use the class to release APIs programmatically. Note that you can also achieve this using ADT tools.
- Find more information in the class documentation.
- The code snippets uses various methods offered by the class and illustrates the following aspects: creating an instance of the API state handler for a specified API (a demo class is inserted), releasing the API for ABAP for Cloud Development (by also specifying a transport request), retrieving release information, and deleting the release state for the specified API again.
```abap TRY. DATA(api_state) = cl_abap_api_state=>create_instance( api_key = VALUE #( object_type = 'CLAS' object_name = 'ZCL_DEMO_TEST' ) ). api_state->release( use_in_cloud_development = abap_true use_in_key_user_apps = abap_false request = 'SOME_TR_REQ' ). DATA(rel_info) = api_state->get_release_info( ). DATA(is_released) = api_state->is_released( use_in_cloud_development = abap_true use_in_key_user_apps = abap_false ). IF is_released = abap_true. api_state->delete_release_state( request = 'SOME_TR_REQ' ). rel_info = api_state->get_release_info( ). is_released = api_state->is_released( use_in_cloud_development = abap_true use_in_key_user_apps = abap_false ). ENDIF. CATCH cx_abap_api_state INTO DATA(error). DATA(error_text) = error->get_text( ). ENDTRY. ``` |
| Class | Details/Code Snippet |
CL_APJ_DT_CREATE_CONTENTCL_APJ_RT_API |
- `cl_apj_dt_create_content`: Used to create and delete class-based application job catalog entries and templates programmatically.
- `cl_apj_rt_api`: Provides methods to schedule and manage application jobs programmatically.
- A prerequisite for application jobs is a class implementing the `if_apj_rt_run` interface, with its `execute` method run by the background job.
- Find more information [here](https://help.sap.com/docs/btp/sap-business-technology-platform/application-jobs).
- The example, which you can copy into a demo class (e.g. `zcl_demo_abap`) and run using F9 in ADT, covers methods of both classes and explores:
- Creating an application job catalog entry
- Creating an application job template
- Scheduling an application job
- Getting the application job status
- Retrieving and canceling application jobs
- Deleting an application job template
- Deleting an application job catalog entry
🟢 Click to expand for more information and example codeNotes on the example: - It rudimentarily explores class methods and is not intended as a best practice implementation. Check the class documentation and the [SAP Help Portal](https://help.sap.com/docs/btp/sap-business-technology-platform/application-jobs) for detailed information. - It uses a demo database table from the ABAP cheat sheet repository. - The `execute` method, run by the background job, creates several random entries in a database table to demonstrate the effect of application job runs. - The example class is self-contained, including the classrun interface so it can be executed, and the implementation of the `if_apj_rt_run` interface. After scheduling the application job, a `WAIT` statement interrupts the program flow. The application job is scheduled to start immediately and run every minute, potentially starting during the wait. The `SELECT` statement following the `WAIT` statement retrieves data from the demo database table into an internal table, possibly including demo data inserted during the job run. If there are no entries, try running the class again and/or change the value of `wait_seconds` constant. - Due to program interruption, the class run takes time to complete and display output in the console. The example does not cover several aspects (check the documentation for more information), including: - Error handling in the `execute` method - Implementing other available interfaces, like `if_apj_dt_defaults` - Setting up authorization - Using ADT to create job catalog entries and templates Before running the example class, check the values of the constants in the public section of the class. In particular, ensure you have valid values for these constants: - `class_name`: Provide the class name where you have copied the code (if it is not `zcl_demo_abap`). - `transport_request`: Enter a valid transport request. - `package`: Enter a valid package name. - Check the *constants related to the example class execution*. Changes to these values affect the program flow. ```abap CLASS zcl_demo_abap DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. INTERFACES if_apj_rt_run. "Public attribute supplied with a value in the job run DATA text TYPE c LENGTH 10. "--------------------------------------------------------------------- "Constants related to the catalog CONSTANTS catalog_name TYPE cl_apj_dt_create_content=>ty_catalog_name VALUE 'ZDEMO_ABAP_JCAT'. CONSTANTS catalog_text TYPE cl_apj_dt_create_content=>ty_text VALUE 'Demo application job catalog'. CONSTANTS class_name TYPE cl_apj_dt_create_content=>ty_class_name VALUE 'ZCL_DEMO_ABAP'. "Constants related to the template CONSTANTS template_name TYPE cl_apj_dt_create_content=>ty_template_name VALUE 'ZDEMO_ABAP_JTEMPLATE'. CONSTANTS template_text TYPE cl_apj_dt_create_content=>ty_text VALUE 'Demo application job template'. "Constants related to the transport request and package CONSTANTS transport_request TYPE cl_apj_dt_create_content=>ty_transport_request VALUE '...'. CONSTANTS package TYPE cl_apj_dt_create_content=>ty_package VALUE '...'. "Constant related to the application job CONSTANTS appl_job_text TYPE cl_apj_rt_api=>ty_job_text VALUE 'DEMO_APPL_JOB'. "Constants related to the example class execution CONSTANTS delete_entries TYPE abap_boolean VALUE abap_false. CONSTANTS demo_attribute_value LIKE text VALUE 'TEST'. CONSTANTS delete_demo_dbtab_entries TYPE abap_boolean VALUE abap_true. "The following constant specifies the duration in seconds the executing class should wait before "continuing the processing. Depending on the value, you can expect none or multiple entries in "an internal table that is displayed after running the class. CONSTANTS wait_seconds TYPE i VALUE 40 "80 "120 . PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_demo_abap IMPLEMENTATION. METHOD if_oo_adt_classrun~main. DATA(timestamp) = utclong_current( ). IF delete_demo_dbtab_entries = abap_true. DELETE FROM zdemo_abap_tabca. ENDIF. *&---------------------------------------------------------------------* *& Creating an application job catalog entry *&---------------------------------------------------------------------* "Creating an instance to create an application job catalog entry and template DATA(jcat) = cl_apj_dt_create_content=>get_instance( ). "Checking whether the application job catalog exists DATA(jcat_exists) = jcat->exists_job_cat_entry( catalog_name ). IF jcat_exists <> 'Y'. TRY. DATA(jcat_flag) = jcat->create_job_cat_entry( iv_catalog_name = catalog_name iv_class_name = class_name iv_text = catalog_text iv_catalog_entry_type = cl_apj_dt_create_content=>class_based iv_transport_request = transport_request iv_package = package ). IF jcat_flag = abap_true. out->write( |Job catalog entry { catalog_name } creation: Ok!| ). ENDIF. CATCH cx_apj_dt_content INTO DATA(error_jcat). DATA(jcat_error_msg) = error_jcat->get_longtext( ). out->write( jcat_error_msg ). ENDTRY. ELSE. out->write( |Job catalog entry { catalog_name } already available.| ). ENDIF. *&---------------------------------------------------------------------* *& Creating an application job template *&---------------------------------------------------------------------* "Checking whether the application job template exists DATA(jtempl_exists) = jcat->exists_job_template_entry( template_name ). IF jtempl_exists <> 'Y'. TRY. DATA(jtempl_flag) = jcat->create_job_template_entry( iv_template_name = template_name iv_catalog_name = catalog_name iv_text = template_text iv_transport_request = transport_request iv_package = package ). IF jtempl_flag = abap_true. out->write( |Job template { template_name } creation: Ok!| ). ENDIF. CATCH cx_apj_dt_content INTO DATA(error_jtempl). DATA(jtempl_error_msg) = error_jtempl->get_longtext( ). out->write( jcat_error_msg ). ENDTRY. ELSE. out->write( |Job template { template_name } already available.| ). ENDIF. *&---------------------------------------------------------------------* *& Scheduling an application job *&---------------------------------------------------------------------* "Note: "- Using the generate_jobkey method, you can create the job key (i.e. " job name and count). The values can be passed to the optional parameters " iv_jobname and iv_jobcount of the schedule_job method. This example does " not use the method. The job key is created when calling the schedule_job " method. "- The schedule_job method has numerous mandatory and optional parameters. " Make sure that you check the class documentation for more information. GET TIME STAMP FIELD DATA(ts). TRY. cl_apj_rt_api=>schedule_job( EXPORTING iv_job_template_name = template_name iv_job_text = appl_job_text "The example specifies the start condition as starting immediately. "You can also provide a time stamp. is_start_info = VALUE #( start_immediately = abap_true ) "Providing information about periodicity "The example assigns values to several components of the structure, "including the granularity, which is assigned 'MI' (minutes). is_scheduling_info = VALUE #( test_mode = abap_false periodic_granularity = 'MI' periodic_value = '1' timezone = 'UTC' ) "Providing information about when to end the application job execution "The example specifies some components of the structure. Among them is "a time stamp that specifies to stop the execution in half an hour. is_end_info = VALUE #( type = 'DATE' "End by timestamp = cl_abap_tstmp=>move_to_short( cl_abap_tstmp=>add( tstmp = ts secs = 1800 ) ) "Half an hour in seconds ) "Providing the public attribute of the class with a concrete value it_job_parameter_value = VALUE #( ( name = 'TEXT' t_value = VALUE #( ( sign = 'I' option = 'EQ' low = demo_attribute_value ) ) ) ) IMPORTING ev_jobname = DATA(jobname) ev_jobcount = DATA(jobcount) ). out->write( |Job name: "{ jobname }"| ). out->write( |Job count: "{ jobcount }"| ). CATCH cx_apj_rt INTO DATA(error_jschedule). DATA(jschedule_error_msg) = error_jschedule->get_longtext( ). out->write( jschedule_error_msg ). out->write( `Program execution terminated` ). RETURN. ENDTRY. *&---------------------------------------------------------------------* *& Getting the application job status *&---------------------------------------------------------------------* TRY. cl_apj_rt_api=>get_job_status( EXPORTING iv_jobname = jobname iv_jobcount = jobcount IMPORTING ev_job_status = DATA(jobstatus) ev_job_status_text = DATA(jobtext) ). out->write( |Job status: "{ jobstatus }"| ). out->write( |Job text: "{ jobtext }"| ). CATCH cx_apj_rt INTO DATA(error_jstatus). DATA(jstatus_error_msg) = error_jstatus->get_longtext( ). out->write( jstatus_error_msg ). ENDTRY. *&---------------------------------------------------------------------* *& Evaluating the result of the job run *&---------------------------------------------------------------------* "Note: "- The example job run includes the creation of database table entries. "- The WAIT statement is used to interrupt the program flow of the " self-contained example class so that the application jobs can run " in the meantime. "- Depending on the waiting time, you can expect entries in the internal " table. Otherwise, you may increase the value for the seconds after WAIT " UP TO as the example is designed to run the application job minute-wise. WAIT UP TO wait_seconds SECONDS. SELECT * FROM zdemo_abap_tabca INTO TABLE @DATA(applj_result). out->write( |\n| ). out->write( `Application job result` ). out->write( |Time stamp when the class was executed: "{ timestamp }"| ). out->write( |\n| ). IF applj_result IS INITIAL. out->write( `No table entries have been created yet. You may want to run the class again.` ). ELSE. out->write( applj_result ). ENDIF. *&---------------------------------------------------------------------* *& Retrieving and cancelling aplication jobs *&---------------------------------------------------------------------* "Note: "- In the example, application jobs are first retrieved based on the " the specified job catalog. An internal table is returned containing " details of the application jobs, such as the job name and count. "- The intenral table is looped across. Using the cancel_job method, " the application jobs are cancelled (if currently running) or deleted. TRY. DATA(jlist) = cl_apj_rt_api=>find_jobs_with_jce( catalog_name ). out->write( |\n| ). out->write( `Application job list:` ). out->write( jlist ). CATCH cx_apj_rt INTO DATA(error_jfind). DATA(jfind_error_msg) = error_jfind->get_longtext( ). out->write( jfind_error_msg ). ENDTRY. LOOP AT jlist INTO DATA(j). TRY. cl_apj_rt_api=>cancel_job( EXPORTING iv_jobname = j-jobname iv_jobcount = j-jobcount ). CATCH cx_apj_rt INTO DATA(error_jcancel). DATA(jcancel_error_msg) = error_jcancel->get_longtext( ). out->write( jcancel_error_msg ). ENDTRY. ENDLOOP. TRY. jlist = cl_apj_rt_api=>find_jobs_with_jce( catalog_name ). out->write( |\n| ). IF jlist IS INITIAL. out->write( `Application jobs for the demo job catalog cancelled.` ). ELSE. out->write( `Cancel the demo application jobs` ). ENDIF. CATCH cx_apj_rt INTO error_jfind. jfind_error_msg = error_jfind->get_longtext( ). out->write( jfind_error_msg ). ENDTRY. *&---------------------------------------------------------------------* *& Deleting an application job template *&---------------------------------------------------------------------* IF delete_entries = abap_true. TRY. DATA(jtempl_del_flag) = jcat->delete_job_template_entry( iv_template_name = template_name iv_transport_request = transport_request ). IF jtempl_del_flag = abap_true. out->write( |Job template { template_name } deletion: Ok!| ). ENDIF. CATCH cx_apj_dt_content INTO DATA(error_jtempl_del). DATA(jtempl_del_error_msg) = error_jtempl_del->get_longtext( ). out->write( jtempl_del_error_msg ). ENDTRY. *&---------------------------------------------------------------------* *& Deleting an aplication job catalog entry *&---------------------------------------------------------------------* TRY. DATA(jcat_del_flag) = jcat->delete_job_cat_entry( iv_catalog_name = catalog_name iv_transport_request = transport_request ). IF jcat_del_flag = abap_true. out->write( |Job catalog entry { catalog_name } deletion: Ok!| ). ENDIF. CATCH cx_apj_dt_content INTO DATA(error_jcat_del). DATA(jcat_del_error_msg) = error_jcat_del->get_text( ). out->write( jcat_del_error_msg ). ENDTRY. ENDIF. ENDMETHOD. METHOD if_apj_rt_run~execute. "Adding sample entries to a demo database table DATA itab TYPE TABLE OF zdemo_abap_tabca WITH EMPTY KEY. DATA(random_num) = cl_abap_random_int=>create( seed = cl_abap_random=>seed( ) min = 1 max = 10000 )->get_next( ). DO 3 TIMES. APPEND INITIAL LINE TO itab ASSIGNING FIELD-SYMBOL( |