rap-data-services-for-print-forms-a104660.md

RAP Data Services for Print Forms

The XML data for print form rendering can be obtained from the RAP Business Services. The data model can be defined just as well as the RAP Service Definition. For more information, see Service Definition.

The CL_FP_FDP_SERVICES class provides the ABAP API to receive the following:

• data in xml format for the use in print forms

• XML Schema Definition (XSD) used for the design of print forms in the Adobe LiveCycle Designer.

Initiate Business Data Reader

To supply the rendering operation with business data, a reuse service can be applied. Beforehand, a service definition needs to be created.

Note:

The service definition doesn't need a binding for RAP Data Services for print forms.

1. Initiate the reuse utility by specifying the service definition: data(lo_fdp_api) = cl_fp_fdp_services=>get_instance( FP_FDP_AUNIT_SO ).

2. Specify the key parameters. This is required to read the data for a specific item. The reuse utility offers the following functionality to retrieve all key fields for the service definition: data(lt_keys) = lo_fdp_api->get_keys( ).

3. Once you have retrieved the array with key values, assign the keys that fit to the document you want to output: lt_keys[ name = 'UUID' ]-value = 'FA163EE47BDD1ED9A682A2E6F1ECF696'.

Sample Code:

DATA(lo_fdp_api) = cl_fp_fdp_services=>get_instance( `FP_FDP_SERVICE_EX1` ).
DATA(lt_keys)    = lo_fdp_api->get_keys( ).

  lt_keys[ name = 'UUID' ]-value = 'FA163EE47BDD1ED9A682A2E6F1ECF696'.

Retrieve XML Data from Service Definition

The READ_TO_XML_V2 method retrieves the data structure of the service definition for a specific item. It has the following Importing parameters:

Importing Parameters

Parameter	Definition
IT_SELECT	Key parameters
IV_LANGUAGE (Optional)	Overwrites the locale language (useful if you want to control how dynamic values (such as unites) are resolved

The READ_TO_XML_V2 method has the following returning parameters:

Returning Parameters

Parameter	Definition
RV_XML	Resulting XML as XSTRING

Sample Code:

TRY.
    DATA(lt_keys)    = lo_fdp_api->get_keys(  ).
    lt_keys[ name = 'UUID' ]-VALUE = 'FA163EE47BDD1ED9A682A2E6F1ECF696'.
    DATA(lv_data) = lo_fdp_api->read_to_xml_v2( lt_keys ).
 CATCH cx_fp_fdp_error INTO DATA(lo_exception).
ENDTRY.

Retrieve XML Schema Definition from Service Definition

The GET_XSD_V2 method retrieves the XML Schema Definition (XSD) for the service definition. It has the following returning parameters:

Returning Parameters

Parameter	Definition
RV_XML	Resulting XSD as XSTRING

Sample Code:

TRY.
   DATA(lv_xml)     = lo_fdp_api->get_xsd_v2(  ).
 CATCH cx_fp_fdp_error INTO DATA(lo_exception).
ENDTRY

Read XML Data for a Service Definition Using Draft Functionality

By default, for draft-enabled services, the IsActiveEntity property is exported implicitly, which describes if the active or the draft data should be read. Because this property is always false, by default, it needs to be overwritten during a service call to read the active data from the service definition.

You can use the following sample code. Mind that you need to initiate the business data reader first (see above).

Sample Code:

TRY.
    DATA(lt_keys)    = lo_fdp_api->get_keys(  ).
    lt_keys[ name = 'UUID' ]-VALUE = 'FA163EE47BDD1ED9A682A2E6F1ECF696'.
    DATA(lv_data) = lo_fdp_api->read_to_xml_v2( 
        it_select     = lt_keys
        it_select_add = VALUE if_fp_fdp_api=>tt_select_keys( name = 'IsActiveEntity' value = 'X' data_type = 'ABAP_BOOL' )                                                                                        
    ).
 CATCH cx_fp_fdp_error INTO DATA(lo_exception).
ENDTRY.