Constructor

To utilize the functionality provided by this class, it is required to instantiate and initialize the corresponding object prior to its use.

Parameter	Type	Mandatory	Default Value	Description
controller	Controller	✅ Yes		Instance of the consuming application's controller. Used internally to access models (ODataModel, ResourceModel) and the owner component context.
entitySet	string	✅ Yes		Exact name of the OData EntitySet to operate on, as defined in the service metadata. Must not include leading slash.
modelRef	string | ODataModel	❌ No		Reference to the ODataModel instance or its name in the consuming app. If omitted, defaults to the unnamed ODataModel from the owner component.
resourceModelRef	string | ResourceModel	❌ No	i18n	Reference to the resource (i18n) model for label generation, either by name or instance. Defaults to i18n resource model from owner component.
deferredGroupId	string	❌ No	ui5AntaresPro	OData deferred batch group ID to be used for create operations, overriding the default ui5AntaresPro.
index	number	❌ No		Insertion position index for the generated form within its parent container. Defaults to insertion as the first element if unspecified.
dialogTitle	string	❌ No	Localized title	Overrides the default localized title of the generated dialog with a custom string.
formType	FormType	❌ No	SmartForm	Specifies the form variant to generate: SmartForm or SimpleForm. Defaults to SmartForm.
formTitle	string	❌ No		Optional title text displayed above the generated form. No title is shown by default.
submitButtonText	string	❌ No	Localized text	Text label for the submit button in the dialog. Defaults to localized standard text.
submitButtonType	ButtonType	❌ No	Emphasized	Visual type of the submit button control. Defaults to Emphasized.
closeButtonText	string	❌ No	Localized text	Text label for the dialog close button. Defaults to localized standard text.
closeButtonType	ButtonType	❌ No	Default	Visual type of the close button control. Defaults to Default.
keyEnforcementEnabled	boolean	❌ No	true	If enabled, key properties are enforced by including and positioning them at the top of the form. Disable to exclude or reorder key fields.
metadataLabelEnabled	boolean	❌ No	false	Enable automatic label generation from OData metadata annotations (@Common.Text) or sap-label property extensions.
guidGenerationMode	GuidMode	❌ No	Key	Determines which Edm.Guid properties receive generated GUID values on entity creation. Options: All, Key, NonKey, None.
guidVisibilityMode	GuidMode	❌ No	NonKey	Controls visibility of Edm.Guid properties in the form. Options: All, Key, NonKey, None.
requiredPropertyError	string	❌ No	Localized error message	Custom error message shown when required fields are empty. Triggers on form submission, when the user leaves the input field (focus out), or presses enter. Only applies to SimpleForm. Supports {property} placeholder.
validationErrorMessage	string	❌ No	Localized error message	Error message displayed in a MessageBox when form validation fails on submit.
selectRowError	string	❌ No	Localized error message	Message shown when a navigation operation requires row selection but none is selected in the table.
showErrorMessageBox	boolean	❌ No	true	Flag to enable or disable display of error MessageBox on submission errors. Defaults to enabled (true).
booleanFalseByDefault	boolean	❌ No	true	If true, Edm.Boolean properties default to false on new entities if no initial value is set; otherwise they remain null.
autoCloseOnSuccess	boolean	❌ No	true	Determines whether the dialog closes automatically after a successful submission. Defaults to true.
dateTimeSettings	DateTimeSettings	❌ No		Configuration allowing consumers to define formatting patterns for date, time, and datetime properties. If not specified, formatting defaults to the user’s locale settings based on OData types.
numberSettings	NumberSettings	❌ No		Settings for numeric formatting including decimal separator, grouping separator, grouping size, and grouping enablement.
contentWrapper	ContentWrapper	❌ No		Custom layout container wrapping the generated content. Defaults to standard Dialog or VBox container depending on context.
propertySettings	PropertySettings[]	❌ No		Array of property-level configurations to mark individual properties as required, read-only, or excluded from the form or table.
propertyOrder	string[]	❌ No		Custom sequence of property names to define display order in the form. Properties that are not listed in this array follow the metadata order.
navigationProperties	NavigationProperty[]	❌ No		Array of navigation property configurations to be included within the generated dialog or component. The library supports both 1:1 and 1:N cardinalities: for 1:1 associations, it generates an additional form representing the target entity; for 1:N associations, it creates a table displaying the related entities. Each navigation property should be an instance of ui5.antares.pro.v2.metadata.NavigationProperty, where its specific settings are defined during instantiation.
validationLogics	ValidationLogic[]	❌ No		Collection of validation logic instances executed prior to entity submission to enforce complex business or data integrity rules on user input. Each ui5.antares.pro.v2.validation.ValidationLogic instance encapsulates a particular validation rule, configured via its constructor. This enables modular, reusable, and composable validation checks that minimize data entry errors and improve UX consistency.
valueLists	ValueList[]	❌ No		Definitions of value help dialogs applied to Edm.String or Edm.Guid typed properties. Managed through instances of the ui5.antares.pro.v2.valuelist.ValueList class, consumers specify the target entity set for lookup, properties to display, and filter/search behavior. The library internally manages selection and filtering logic based on this configuration, providing consistent and flexible value help UI integration.
formLayout	FormLayout	❌ No		Enables overriding the default form layout used within the generated dialog or component. By default, a standard form layout is applied; specifying a custom FormLayout instance allows consumers to define alternate visual structures and arrangement of form elements, facilitating tailored UX designs to meet specific project requirements.
customElements	CustomElement[]	❌ No		Allows the injection of custom SAPUI5 controls to replace the default controls generated automatically for specific entity properties. Each ui5.antares.pro.v2.custom.CustomElement instance specifies the property to override and the control to insert (e.g., a slider instead of an input field). When provided, the library skips default generation for that property, enabling advanced UI customization while maintaining integration with the form lifecycle.
customContents	CustomContent[]	❌ No		Additional custom SAPUI5 controls to be added anywhere within the generated dialog or component's UI. These controls must be wrapped in ui5.antares.pro.v2.custom.CustomContent instances, which specify placement and grouping. The consumer is responsible for managing the lifecycle, event handling, and behavior of these controls. The library solely handles positioning, allowing flexible extension of the generated UI without losing control over custom elements.

---

Example

TypeScriptJavaScript

import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, // Controller instance
            entitySet: "Products" // EntitySet name
        }); 
    }
}

sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry" // Import the class
], (Controller, CreateEntry) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, // Controller instance
                entitySet: "Products" // EntitySet name
            });
        }
    });
});