Skip to main content

 

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

Mobile Module

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Applies to Mobile and Reactive Web Apps.

    An OutSystems App consists of one or more Modules joined by an Application Template. Click the module name (1) in any of the main Service Studio tabs (Process, Interface, Logic, or Data) to see the module properties pane (2).

    Module properties

    Create a new module

    To create a new in an app, follow these steps in Service Studio:

    1. Go to the application list, search your app, and click on it. The application details screen opens.

      App details screen

    2. In the application details screen enter Module name and select module type from the Choose module type list.

      App details screen

    3. Click Create module. Your new module opens for editing.

    Properties

    Name Description Mandatory Default value Observations
    Name Identifies the module. Yes
    Description Text that documents the element. Useful for documentation purpose.
    The maximum size of this property is 2000 characters.
    DBMS Defines the DataBase Management System type considered by developers when writing SQL. The development environment executes some validations regarding your queries regarding compliance with the selected DBMS. Yes (All) The possible values are: Oracle, SqlServer, (All).
    This property allows the development environment to execute some validations on SQL queries to check if the SQL is compliant with the DBMS type specified in this property.
    It must be set according to the OutSystems Platform Server Database, otherwise a warning message is presented and you should either specify the exact database type or select (All).
    Though this property is merely informative, it is important for communication and knowledge transfer between developers.
    Is User Provider Set to Yes to make this a module which provides users. Yes No When this property is set to Yes, the Users entity (System) is set as public and the module becomes available as an option as a user source in modules User Provider Module property.
    User Provider module Specifies a source for the user records to be used by this module. Users By default it shows the following possible values: (Current eSpace), ServiceCenter, Users.
    Icon Identifies the module in the element tree of the development environment. Yes Default Icon Identifies the module in the element tree of the development environment.
    Note: This icon will not be used as the mobile app icon; to change the app icon check Modify the App Icon.
    Defaults
    Default Theme Main theme defining the look and feel to apply to the screens and blocks of the module.
    Default Screen Start screen of the application. MainFlow\HomeScreen
    Splash Screen Splash screen of the application. Common\Splash
    Global Exception Handler Specifies the 'OnException' handler to be used by all the flows of this module. Common\OnException
    Default Transition Transition effect applied when navigating to another screen. Yes Slide from Right
    Server Request Timeout Maximum time in seconds to wait for server requests to complete before triggering a Communication Exception. The default is 10 seconds. You can override this value for specific Run Server Actions, Aggregates and Data actions. 10
    Validation Messages
    Mandatory Input Default message displayed whenever a mandatory input field is left empty. "Required field!"
    Invalid Integer Default message displayed whenever a provided value is not of Integer type as expected by an input field. "Integer expected!"
    Invalid Decimal Default message displayed whenever a provided value is not of Decimal type as expected by an input field. "Decimal expected!"
    Invalid Currency Default message displayed whenever a provided value is not of Currency type as expected by an input field. "Currency expected!"
    Invalid Date Default message displayed whenever a provided value is not of Date type as expected by an input field. "Date expected!"
    Invalid Time Default message displayed whenever a provided value is not of Time type as expected by an input field. "Time expected!"
    Invalid DateTime Default message displayed whenever a provided value is not of DateTime type as expected by an input field. "DateTime expected!"
    Invalid Text Default message displayed whenever a provided value is not of Text type as expected by an input field. "Text expected!"
    Invalid Phone Default message displayed whenever a provided value is not of Phone type as expected by an input field. "Phone Number expected!"
    Invalid Email Default message displayed whenever a provided value is not of Email type as expected by an input field. "Email expected!"
    Upgrade Messages
    Upgrade Complete "Your application has been updated to the latest version."
    Upgrade Failed "An error occurred while trying to update the app. If you want to retry the update, restart the app."
    Upgrade Failed on Resources "An error occurred while trying to update the app. If you want to retry the update, restart the app."
    Upgrade Failed on Data Model "An error occurred while trying to update the app. If you want to retry the update, restart the app. If the problem persists you can reinstall, but all local data will be lost."
    Upgrade Required "Your application needs to be updated. Tap here to update."
    Upgrade Required with Data Loss "Your application needs to be updated. Unsaved data will be lost. Tap here to update."
    Advanced
    Is Multi-tenant Set to Yes to enable multi-tenancy for this module. Yes No
    Web Services Namespace Namespace of the WSDL generated by this module.
    Extensibility Configurations JSON configuration data used for integrating functionality such as Cordova plug-ins.
    Required Scripts
    Required Script Script(s) required by the element.
    • Was this article helpful?