Documentation

Creatio development guide
PDF
This documentation is valid for Creatio version 7.12.0. We recommend using the newest version of Creatio documentation.

Manifest. Application interface properties

Glossary Item Box

General information

The conditional property group of the configuration object manifest contains properties that form the mobile application interface. By using the properties of this group, you can form application sections, main menus, custom images, etc. Read more about the mobile application manifest and its properties in the "Mobile application manifest" article.

ModuleGroups property

Application module groups. Describes the upper-level group setting of the mobile application main menu. The ModuleGroups property sets a list of named configuration objects for each menu group with the only possible Position property (see table 1).

Table 1 The configuration object property for the menu group setup.

Property Value
Position Group position in the main menu. Strats with 0.

Example

Setting up the mobile application menu with two groups — the main group and the [Sales] group.

// Mobile application module groups.
"ModuleGroups": {
    // Main menu group setup.
    "main": {
        // Group position in the main menu.
        "Position": 0
    },
    // [Sales] menu group setup. 
    "sales": {
        // Group position in the main menu.
        "Position" 1
    }
}

Modules property

Mobile application modules. A module is an application section. Each module in the [Modules] configuration object manifest describes a configuration object with properties given in table 2. The name of the configuration section object must match the name of the model that provides section data.

Table 2 Section configuration object properties.

Property Value
Group The application menu group that contains the section. Set by the string containing the menu section name from the ModuleGroups property of the manifest configuration object.
Model Model name that contains the section data. Set by the string containing the name of one of the models included in the Models property of the manifest configuration object.
Position Section position in the main menu group. Set by a numeric value starting with 0.
Title Section title. String with the section title localized value name. Section title localized value name should be added to the [LocalizableStrings] manifest schema block.
Icon This property designed to import custom images to the version 1 user interface menu section.
IconV2 This property designed to import custom images to the version 2 user interface menu section.
Hidden Checkbox that defines a section is displayed in the menu (true — hidden, false — displayed). Optional property. By default — false.

Example

Set up the application sections:

  1. Main menu sections: [Contacts], [Accounts].
  2. The application starting page: the [Contacts] section.

Strings containing the section titles should be created in the [LocalizableStrings] manifest schema block:

  • ContactSectionTitle with the "Contacts" value.
  • AccountSectionTitle with the "Accounts" value.
// Mobile application modules.
"Modules": {
    // "Contact" section.
    "Contact": {
        // The application menu group that contains the section.
        "Group": "main",
        // Model name that contains the section data.
        "Model": "Contact",
        // Section position in the main menu group.
        "Position": 0,
        // Section title.
        "Title": "ContactSectionTitle",
        // Custom image import to section.
        "Icon": {
            // Unique image ID.
            "ImageId": "4c1944db-e686-4a45-8262-df0c7d080658"
        },
        // Custom image import to section.
        "IconV2": {
            // Unique image ID.
            "ImageId": "9672301c-e937-4f01-9b0a-0d17e7a2855c"
        },
        // Menu display checkbox.
        "Hidden": false
    },
    // "Account" section.
    "Account": {
        // The application menu group that contains the section.
        "Group": "main",
        // Model name that contains the section data.
        "Model": "Account",
        // Section position in the main menu group.
        "Position": 1,
        // Section title.
        "Title": "AccountSectionTitle",
        // Custom image import to section.
        "Icon": {
            // Unique image ID.
            "ImageId": "c046aa1a-d618-4a65-a226-d53968d9cb3d"
        },
        // Custom image import to section.
        "IconV2": {
            // Unique image ID.
            "ImageId": "876320ef-c6ac-44ff-9415-953de17225e0"
        },
        // Menu display checkbox.
        "Hidden": false
    }
}

Icons property

This property is designed to import custom images to the mobile application.

It is set by the configuration objects array, each containing properties from the table 3.

Table 3 The configuration object properties for the custom image import.

Property Value
ImageListId Image list ID.
ImageId Custom image ID from the ImageListID list.

Example

// Custom images import.
"Icons": [
    {
        // Image list ID.
        "ImageListId": "69c7829d-37c2-449b-a24b-bcd7bf38a8be",
        // Imported image ID.
        "ImageId": "4c1944db-e686-4a45-8262-df0c7d080658"
    }
]

DefaultModuleImageId and DefaultModuleImageIdV2 properties

Properties are designed to set unique default image IDs for newly created sections or sections that don't contain IDs of the images in the Icon or IconV2 properties of the Modules property of the configuration object manifest.

Example

// Custom interface V1 default image ID.
"DefaultModuleImageId": "423d3be8-de6b-4f15-a81b-ed454b6d03e3",
// Custom interface V2 default image ID.
"DefaultModuleImageIdV2": "1c92d522-965f-43e0-97ab-2a7b101c03d4"
© 2011 - 2019 BPMonline. All rights reserved.

Did you find this information useful?

How can we improve it?