Official Content

One of the differences between a Native mobile Mini App and a Web Mini App is that in the latter case, the metadata is created automatically. In the second latter case, you must create it yourself.

To define the metadata of a Web Mini App you have to create a file named webminiapp.json, and compress it into a zip file with the .gxsd extension.

The properties to be included in the webminiapp.json must be written in the following format: 

{
    "EntryPointURL": String,
    "SuperAppObjectName": String,
    "MiniAppObjectName": String
}

Entry point URL: Defines the HTTPS URL that loads when you start the Web Mini App. Refers to the main entry URL for the Web Mini App. It is the starting point or main access to the application.
SuperApp Object Name (Optional): Indicates the name of the property on the window object that the Web Mini App will use to interoperate with the Super App through a Js bridge. The default value is gxsuperapp.
MiniApp Object Name (Optional): Indicates the name of the property on the window object that the Web Mini App will use to interoperate with the Mini App through a Js bridge. For example, to Exit the Mini App. The default value is gxminiapp.

If the SuperAppObjectName and/or MiniAppObjectName properties are not completed, their default values will be used.

Sample

{
    "EntryPointURL": "https://your_miniapp_services_url",
    "SuperAppObjectName": "GxSuperAppApi",
    "MiniAppObjectName": "MiniAppAPI"
}

These definitions indicate how the Web Mini App communicates with the Super App. The property EntryPointURL is the gateway to the Web Mini App. At the same time, SuperAppObjectName and MiniAppObjectName are used to interact with the Super App and handle the internal operations of the Web Mini App.

After the Web Mini App is created in the Mini App Center, go to the Mini Apps section and click on the Web Mini App to upload the metadata (webminiapp.gxsd file) created.

HowTo: Define the metadata of a Web Mini App - sample 1

Click on the NEW VERSION button. 

HowTo: Define the metadata of a Web Mini App - sample 2

Next, upload the webminiapp.json file with the metadata.

HowTo: Define the metadata of a Web Mini App - sample 3

Lastly, click on the CONFIRM button.
 

Last update: February 2024 | © GeneXus. All rights reserved. GeneXus Powered by Globant