SAP Modeler - Entity Creation and Main Customizing

SAP 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".

In "Domain", choose the desired SAP business process from the available dropdown list.


In "Type of Data", choose either Master Data or Transactional Data.
Info

Consider the following information to select the appropriate data type:

  • Master data: This data type undergoes minimal changes throughout the business process and is not considered transactional. Examples include material master, customer details, and accounts.
  • Transactional data: 
    These are temporal data points that hold importance within specific timeframes. They form part of a document flow, encompassing transactions like sales records, invoices, and others.



In "Entity", enter the entity name. This name must be unique and should not match any previously loaded entity.

In "Description", provide a general description of the entity for easy identification.

Once the information is confirmed, click on "Continue".



Assigning Tables and Relationships

After creating the entity, enter its configuration.

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. 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.



Configuring Table and Field Aliases

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, enter the new alias, and press "ENTER".


Similarly, field/column aliases can be modified in the second list. Click on the "Field Alias" text field, enter the desired alias, and press "ENTER". "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.

Info

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:

Data Type – Select whether the data is Master (D) or Transactional (T). The difference between these types has been explained previously.

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

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.

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)

Info

Please refer to the following manual to get a deeper look into the elements involved in real time information sending.

Number of Records – A customizable field that defines the number of records from the main table to be included in a single transmission (JSON). This is particularly useful in batch processing when sending large volumes of data. We recommend setting this value to 100 to optimize performance and ensure efficient data handling.

Event ID– A unique identifier used to track and distinguish a set of tables transmitted within a specific entity. This identifier is constructed using a combination of the domain object, the record’s key, and a timestamp value, ensuring accurate grouping and traceability of the sent data. We recommend checking the box.



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, we click con "Continue"

Select the package where the configuration will be located


Clic on "Save"

After clicking "Save", depending on the amount of tables and fields in the entity, the process will take several minutes; please be patient and let the system finish the saving process, do not close SAP. 
When the process is done, you will be redirected to the OneConnect main menu and a confirmation message will appear at the bottom of the screen, the entity then will be correctly created and available in the entities list:






    • Related Articles

    • SAP Data Modeler - Graphic User Interface and Prepackaged Entities

      Graphic User Interface and Prepackaged Entities NOTE: PRIOR TO THIS STEP, IT IS NECESSARY TO HAVE INSTALLED THE LATEST ONECONNECT TRANSPORT PROVIDED DIRECTLY BY THE ONIBEX TEAM. IF YOU DO NOT HAVE THIS TRANSPORT, PLEASE CONTACT OUR TEAM. Access the ...
    • Updating Entity Fields

      This manual explains the steps to correctly prepare and upload an Excel file to mass configure fields/columns for an entity in your system. Follow these instructions carefully to avoid errors. Make sure to ask the Onibex team to provide you with the ...
    • SD and MM Events - Information for Real Time Configuration

      The following presents relevant information related to pre-packaged entities from the SD and MM modules; this information is essential for real-time data configuration within each of the entities (This process is explained in more detail in the ...