Kontakt

Ansicht
Dokumentation

SUBST_APPLANA_STORE - API to Create and Store Apllication-Specific Analytics Data

SUBST_APPLANA_STORE - API to Create and Store Apllication-Specific Analytics Data

RFUMSV00 - Advance Return for Tax on Sales/Purchases   Addresses (Business Address Services)  
This documentation is copyright by SAP AG.
SAP E-Book

Functionality

The function module (FM) SUBST_APPLANA_STORE allows the storage of application-specific analytics data for a process that runs after a completed SUM procedure.

The stored analytics data

  • will be retrieved by the Early Watch Alert (EWA) together with other
    SUM analytics data that is available in the respective customer system.
  • is later on be stored in the CLM Analytics Database.

The development team of the application that calls this function module must ensure that the analytics data

  • does not contain any personalized data and
  • does not violate data privacy laws.

For input parameter IV_EVALUATION_TYPE, only 'registered' evaluation types are allowed. For registering a new evaluation type, a development team must contact the SUM development team (application component BC-UPG-TLS-TLA).

Unregistered evaluation types and their provided analytics data are rejected, and the function module raises an exception.

The input parameters IV_PROCESS_START_DATE and IV_PROCESS_START_TIME

  • must contain the overall start date and start time of the respective process.
  • must be the same for ALL calls of this function module for storing data that is related to the same process of type IV_EVALUATION_TYPE.

The start date and time of this overall process are used to identify all analytics data of the given evaluation type and to connect them to the related SUM procedure.

An application can call this function module as often as necessary to store analytics data for the given process, e.g. to store analytics data from different clients.

Application-specific analytics data must be entered using the importing parameter IT_APPLANA_DATA. The number of allowed entries in this internal table is limited to 10.000 entries per function module call.

The parameter IV_TEST_MODE_NO_DATA_STORED can be used for testing purposes to validate the input data provided in internal table IT_APPLANA_DATA.

Specifying IV_TEST_MODE_NO_DATA_STORED = 'X' means:

  • the authority check for the specified evaluation type is not executed,
  • no analytics data is stored in the database,
  • only the created XML data is returned in parameter ET_XML_DATA for further checking,
  • errors and inconsistencies in the input data are returned in parameters EV_MESSAGE_TEXT and/or ET_MESSAGES.

Note that for client-specific analytics data, the respective client value must be specified on the top level of each process item entry in IT_APPLANA_DATA..

The client value has to be 'empty' (= ' ') for a client-independent process.

The created APPLANA.XML file contains the type of each specified client, such as productive, customizing, testing, etc.

Example

Notes

Further information





Parameters

ET_MESSAGES
ET_XML_DATA
EV_MESSAGE_TEXT
IT_APPLANA_DATA
IV_EVALUATION_TYPE
IV_PROCESS_START_DATE
IV_PROCESS_START_TIME
IV_TEST_MODE_NO_DATA_STORED

Exceptions

DATA_NOT_SAVED_TO_DB
INPUT_DATA_ERROR
INPUT_DATA_MISSING
INVALID_EVAL_TYPE_SPECIFIED
NO_AUTHORISATION
TOO_MANY_APPLANA_DATA_ENTRIES

Function Group

S_APPLICATION_ANALYTICS

PERFORM Short Reference   Fill RESBD Structure from EBP Component Structure  
This documentation is copyright by SAP AG.

Length: 3920 Date: 20240523 Time: 090310     sap01-206 ( 57 ms )