SAP Data Modeler - Working with the entity "ANY"

SAP Data Modeler - Working with the entity "ANY"

Introduction

This document provides a step-by-step guide for creating and configuring an entity within Onibex's SAP Modeler using transaction ZONT_ONECM. It outlines the essential processes, including selecting the appropriate domain and data type, defining entity attributes, assigning tables and relationships, configuring field and table aliases, and setting entity filters.

By following the outlined procedures, users can effectively structure and optimize entities for efficient data management and business process integration within SAP. This ensures consistency, accuracy, and proper utilization of system resources while maintaining compliance with organizational standards.

Creating the Entity 

Access SAP in transaction ZONT_ONECM.

Click on "Create".


After clicking "Create", you will be taken to the entity configuration screen. The first section to configure is the following:


In the "Entity" field, enter the name of the entity, this entity should be named "ANY".


In the "Tag Data" and "Tag Metadata" sections, check each box as needed to include the data contained in the tags located in the specified rows of the configuration.
Select these options only if your use case requires sending either the tag values or their associated metadata. (It is recommended to check them to easily track information)

  1. Tag 1 is mandatory.
    It should contain the Domain: "ANY"
    You can directly type it or select it from the available dropdown list.
           
  1. Tags 2 and 3 contain prefilled values that are configured in the parameter tables (as explained in the following manual).
    These values are used to identify the SAP version and instance from which this entity is sending data.
         
  1. Tags 4 and 5 are optional.
    They can contain any type of information that is relevant to the entity and may help further identify or describe it in more detail.
         

For this entity, there is no need to select tables in the Build Join function or columns in the Column Definition function.

Configuring Main Customizing Data 

Just before saving our entity we need to define certain customizations to extract the data selected in the entity. We can find it in the "Main Customizing Data" section.

Here is a general overview of each segment:
  1. Data Type – Select Transactional Data (T).


  1. Description – Provide a general description of the entity and its contents. This section is for informational purposes only.


  1. Number of Records - Select the number of records the entity will send per request. We recommend setting this value to 100 for optimal performance and stability during data transmission.


  1. Event ID - Check this box if the information being sent requires an Event ID to identify the executed event. We recommend enabling this option to ensure traceability and proper event identification.


  1. Auth Object - Here, you can assign an authorization object to the specific entity.

This ensures that only SAP users with the defined authorization object can modify or delete the entity.

To configure it:

  1. Enter the Authorization Object in the corresponding field.

  2. Click on "Set Values".

  3. In the Value field, type the required value for the authorization object.



Log - Here, you can choose where to store the process log of this entity.

There are two available options:

  • Standard Log: Saves all logs in the standard OneConnect log table.

  • Server File: Stores all logs in a .txt file located in an application server directory (this option requires a valid directory path to be specified).


Save Entity Customization

After finishing the configuration of the entity, to save all the changes go to "Save Customizing" in the header of the entity configuration.

After clicking "Save", the system will begin processing the entity and it will be created in your entity list.


Executing the "ANY" Entity

After the entity was created, it now can be executed.
Double click on the ANY entity and select "Execute"

Select the parameters for data transmission:
    • Output Format: Select between KDOC (Kafka document, structured as an IDOC-like XML string), Table format (structured with records and columns in a table format), or both (sending KDOC and table structure).
    • Endpoint Connection: Select the previously created RFC connection from transaction SM59.
    • Table Name: Select the technical name of the table that you want to send.
Click "Execute" at the bottom of the popup or press F8

In the next screen, you will be prompted to select the following information:
  1. Table Alias: Here you can type the alias of the table that you wish to use (if previously you selected to send the alias fields)
  2. Fields Selection: In this section, you select the specific fields from the table that you want to transfer. Review the list of available fields and check the "Include JSON" box next to each field you wish to include in the data transfer.
  3. If you wish to use a field as a selection criterion for sending information in batch mode, check the box labeled "Selection" next to the corresponding field.

After finishing the selection and configuration, click on "Execute" on the top of the screen, or press F8.

Batch Sending Criteria Selection

On the next page, all possible batch selection criteria will appear on the left side. These are columns marked as “Selection” in the past screen .
Double-click the field to be set as the sending criterion to display the selection options.
Select the criterion for sending the entity.
Once criteria are defined, click "Save"


Choosing Execution Mode

Select the execution mode for data sending:
  • Online: Recommended when the data volume is small, or the process does not exceed the available SAP user memory.
  • Background: Recommended for large data volumes to prevent memory issues. Also useful for scheduling execution at a specific date and time.


If executed in Online mode, a summary log will appear at the end, displaying:

  • GV_ENTITY: Should indicate ANY, meaning the entity that was executed
  • TOTAL_SIZE_SENT: Total bytes sent
  • TOTAL_NUMBER_OF_REQUEST: Number of requests made
  • TOTAL_NUMBER_OF_RECORDS: Number of records sent for the entity

Check the destination system to verify if the information was received correctly.


    • Related Articles

    • SAP Data Modeler - Entity Creation and Main Customizing

      Introduction This document provides a step-by-step guide for creating and configuring an entity within Onibex's SAP Modeler using transaction ZONT_ONECM. It outlines the essential processes, including selecting the appropriate domain and data type, ...
    • Onibex SAP Data Modeler - Functionalities

      Introduction The following table outlines key functionalities offered by the SAP Data Modeler, highlighting features designed to enhance data extraction, customization, and integration within SAP environments. No Function Description 1 Direct Data ...
    • SAP Data Modeler - Working with prepackaged entities (Excel)

      Uploading prepackaged Entities Onibex offers prepackaged entities that include predefined structures with tables and relationships designed for multiple SAP business processes. Uploading a prepackaged entity helps save time during the entity creation ...
    • SAP Data Modeler - Execute an entity in batch mode

      Batch Mode Entity Sending Pre-execution Requirements Before executing an entity and sending information in batch mode, ensure that the entity is correctly created and configured. Likewise, confirm that the endpoint configuration is properly set up ...
    • SAP Data Modeler – Identifying CDS Views Compatible with OneConnect Modeler

      The purpose of this manual is to provide a simple and practical guide to identifying CDS views within SAP that are compatible with the OneConnect Data Modeler. It outlines the necessary steps in a clear and concise manner, allowing users to quickly ...