SAP Data Modeler - Entity Creation and Main Customizing

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, defining entity attributes, assigning tables and relationships, configuring field and table aliases, and setting entity filters.

The guide helps users distinguish between Master Data (which remains relatively unchanged) and Transactional Data (which captures specific events within a business process). It also explains how to establish relationships between tables, modify field aliases, and apply filters to ensure data integrity and relevance.

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.

Create an 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 name must be unique and must not match any entity that has been previously loaded into the system.

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, which represents the SAP business process associated with the entity.
    Select the most appropriate option from the available dropdown list that best describes the business context of this entity.
           
  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.
         


Assigning Tables and Relationships

After configuring the entity’s Name and Tags, you can proceed to assign its tables and define the relationships between them.

Click on "Build Join".

To add a table, click on the indicated symbol or use the shortcut SHIFT+F1.

A pop-up window will appear where you must enter the table name (you can also add Z Tables and CDS views). For this example, use VBAK and click "Continue".


The table will be added to the entity and displayed with its list of fields/columns, identifying key fields within each table.


If another table related to the first one is added, a relationship between key fields will be automatically established. For example, adding the VBAP table will create a relationship through the VBELN fields.


To change the relationship type between fields, right-click the relationship and select "Inner Join" or "Left Outer Join" as needed. Relationships can also be deleted.


To manually create a relationship between two fields, click on the desired field and drag the cursor to link it to another field. It will be identified with a dotted line and colored points (red and blue) to mark connection points.


If no existing relationships are found between two tables, click "Join conditions" to let the modeler generate relationships automatically.


Once table additions and relationship configurations are complete, click "Back" to continue.



Adding Columns to Selected Tables

After adding the desired tables, the next step is to select the required columns from each selected table.
Review each table on the left side of the screen, expand it to view all available columns, and then choose the specific columns you want to include in your entity configuration.

Click on "Column Definition"

Within this screen, you will see two main sections:
  • Left Side: Available Fields
    Displays the selected tables. When you expand a table from the list, you will see all available columns for that table.

  • Right Side: Selected Fields
    Also shows the selected tables, but in this section, only the columns you have selected for each table will be visible. This allows you to review and manage the specific data fields that will be used.



To select a column, simply locate it in the expanded list on the left side of the screen and double-click on it. This action will add the column to your selection, and it will appear in the corresponding table on the right side.


To remove a column from your selection, simply double-click on it in the list on the right side, and it will be removed from the selected fields.

Once the columns additions configuration are complete, click "Back" to continue.


Configuring Table and Field Aliases

After completing your table and column selection, you can now proceed to configure the alias for each table.

Aliases are used to simplify table references and improve readability during the modeling process.

They are especially useful when you prefer to work with friendly and easily identifiable names instead of technical table names. Aliases will also be reflected in the target subscriber, allowing for more intuitive interpretation of the data structure.

In the entity configuration, go to the "Table Relations" and "Field List and Customizing" sections (identified by expand/collapse buttons).

The first list displays tables loaded into the entity with their technical name, alias, description, and key field relationships.


The "ID" column with a warning icon (if present) indicates that the table is being used in another entity with the same alias. Modifying fields in one entity will affect the other.

To change the alias and description, click on the text field and enter the new alias.


Similarly, field/column aliases can be modified in the second list. Click on the "Field Alias" text field and enter the desired alias. "Field Description" can also be modified this way.


Key field aliases cannot be modified if their table alias is being used in another entity.

The "KeyFlag" column indicates whether a field is a key field for the table by default.

The "Selection" column allows selecting a field as a batch data submission criterion (explained in another manual).


Configuring Entity Filters

If the entity should send data meeting specific criteria based on selected tables and fields, filters can be applied.

At the top of the entity configuration, click "Define Filters".


This section displays folders representing the added tables. Expanding them reveals the selected fields/columns.


To select and filter a field, double-click it to open options for individual values or ranges on the right side.

Multiple filters can be enabled as needed by double-clicking each field.


After selecting the filters, click "Save" at the bottom.

For this example, the entity is configured to send only sales order data created between 01.01.2024 and 31.12.2024, transactions in USD, and organization 1710


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 whether the data is Master (D) or Transactional (T). The difference between these types has been explained previously.


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


  1. Output Type – Choose the output type associated with this entity. This selection is necessary if the data will be transmitted in real time and if the corresponding output type has already been configured. Details on this configuration can be found in the following manual.


  1. Change Document Object and Object Type – If data transmission occurs in real time, in addition to being sent via the Output Type, it can also be triggered by an event. In this case, the Change Document Object and Object Type must be defined. (This configuration should be prepackaged in the OneConnect transport, if some data is missing, please contact our team)

  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.


If changes were detected the system will let us know.
Select the package where the configuration will be located


Clic on "Save"

After saving the configuration in the selected package, the system will prompt you to provide a Workbench request.
This request is required to store the created structures within the SAP system and ensure they are properly transported and version-controlled.


After clicking "Save", the system will begin processing the entity.
Depending on the number of tables and fields included, this process may take several minutes. Please be patient and do not close SAP during this time. Allow the system to complete the saving operation.

Once the process is finished, you will be automatically redirected to the OneConnect main menu, and a confirmation message will appear at the bottom of the screen. At this point, the entity will have been successfully created and will be available for execution in the Entities list.






    • Related Articles

    • 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, ...
    • SAP Data Modeler - Mass Updating Entity Fields (Excel)

      This manual explains the steps to correctly prepare and upload an Excel file to mass configure fields/columns for the tables used in specific entities in your system. Follow these instructions carefully to avoid errors. Make sure to ask the Onibex ...
    • SAP Data Modeler - Customizing Parameters

      OneConnect Parameter Adjustments The OneConnect solution includes a parameter table used for sending information—especially real-time data. It is important to configure this table beforehand, prior to sending any data, to ensure proper communication ...
    • 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 - Configuring and Reviewing Logs

      OneConnect Working with Logs The OneConnect solution offers two options for reviewing entity logs: Standard OneConnect Log – Logs are stored in the standard OneConnect logging table. TXT File in a Server Directory – Logs are saved as a .txt file in a ...