4. /IQX/GET_FORM_DATA

Attributes:

Function Group - /IQX/FAB_API

Description - Get FAB Form Definition and Instance Data

Remote Enabled Function Module

Import Parameters

Parameter
Type
Default
Optional
Pass by Value
Short Text
IV_FORM_NAME/IQX/FORM_NAME

   Yes

        YesForm Name (eForms)
IV_INSTANCE/IQX/INSTANCE

YesUI5 Forms Data Instance GUID 
IV_REVISION/IQX/REVISION
YesYesUI5 Form Data Revision Number
IV_UNAMESY-UNAME
YesYesABAP System Field: Name of Current User

Export Parameters

Parameter
Type
Pass by Value
Short Text
ES_HEADER_INSTANCE/IQX/FORMHD_INST        YeseForm Header Instance Data (run-time values)
ET_ELEMENTS/IQX/FORMS_ELEM_TT        Yes/IQX/FORMS_ELEM Table Type
ET_DATA/IQX/FORMS_INSTANCE_DATA_TTYes/IQX/FORMS_INSTANCE_DATA_STRUC Table Type
ET_RELATED_DATA/IQX/FORMS_REL_I_TTYes/IQX/FORMS_REL_I Table Type
ET_COMBINED_DATA/IQX/FORMS_COMBINED_DATA_TTYes/IQX/FORMS_COMBINED_DATA Table Type
ET_ATTACHMENTS/IQX/ATTACHMENT_TTYes/IQX/ATTACHMENT Table Type
ET_ALLOWED_ACTIONS/IQX/STATUS_ACTIONS_TTYesFAB Actions Table Type

Changing Parameters

None

Tables

None

Exceptions

None

Documentation

  • This FM gets all the form related data based on the form name and the instance number. User name and version can also be passed as a parameter to fetch the data.
  • The header related data is fetched from the  table ' iqx/formhd' .
  • AUTHORITY-CHECK OBJECT '/IQX/FAB'
    I'BEGRU' FIELD auth_group
    ID '/IQX/ACTIV' FIELD '04'.
  • An authorization check is made to check if the user has access to retrieve the form data. If yes, data is retrieved from the table '/iqx/forms_data' for the highest iteration of the form.
  • AUTHORITY-CHECK OBJECT '/IQX/FAB'
    ID 'BEGRU' FIELD ls_header-auth_group
    ID '/IQX/ACTIV' FIELD '01'.   "Create
  • An authorization check is made to check if the user has access to create the data. If yes, then the form data is retrieved from the implementation class created upon the base class  '/IQX/CL_FORMS_BASE_CLASS'.
  • Using the method  /iqx/cl_forms_assist-data_model_create_data, the form data and entity details are retrieved into tables.
  • The other details such as attachments, allowed actions etc.,are fetched from the relevant tables.