Mobile portal

Guide
Beginner

The mobile portal functionality is available for Creatio version 7.18.4 and later.

Mobile portal (mobile application for portal users) is a mobile workplace. The purpose of the mobile portal is to enable the mobile portal users to create cases and communicate with customer support.

A mobile portal has configurable:

  • mobile portal user workplace
  • case list
  • case page
  • page that adds cases

Set up the workplace of a mobile portal user 

You can set up the workplace of a mobile portal user in the following ways:

  • Add a new workplace.
  • Hide a workplace.
  • Delete a workplace.

Add a workplace of a mobile portal user 

To check if the Portal workplace is available:

  1. Click to open the System Designer.
  2. Go to the System setup block → Mobile application wizard.

The Portal workplace is in the Mobile application wizard section. By default, all mobile portal users can access it.

If the Portal workplace is not available in the Mobile application wizard section, add the workplace.

To add a workplace of a mobile portal user:

  1. Make sure that you are using Creatio version 7.18.4 or later.
  2. Click to open the System Designer.
  3. Go to the System setup block → Mobile application wizard.
  4. Click New workplace in the Mobile application wizard section toolbar.

  5. Fill out the workplace properties.

    • Set Name to the workplace name.
    • Set Code to "Portal."
  6. Configure the access permissions to the workplace for users or user groups on the Roles detail.
  7. Click Set up sections on the toolbar. By default, the workplace of a mobile portal user includes the Cases section.
  8. Save the settings of the Mobile application wizard section.

As a result, Creatio will add a workplace of a mobile portal user.

Learn more about adding a workplace to a mobile application in the user documentation: Set up mobile app workplaces.

Hide the workplace of a mobile portal user 

  1. Click to open the System Designer.
  2. Go to the System setup block → Mobile application wizard.
  3. Open the Portal workplace in the section list.
  4. Delete users or user groups of the Portal workplace. To do this, click and select Delete on the Roles detail.

As a result, Creatio will hide the workplace of a mobile portal user.

Delete the workplace of a mobile portal user 

  1. Click to open the System Designer.
  2. Click Mobile application wizard in the System setup block.
  3. Select the Portal workplace in the section list and click Delete.

As a result, Creatio will delete the workplace of a mobile portal user.

Set up the case list 

You can set up the case list of a mobile portal in the following ways:

  • Add a column to the case list.
  • Hide the column title from the case list.
  • Configure the case sorting order in the list.

Add a column to the case list 

  1. Click to open the System Designer.
  2. Go to the System setup block → Mobile application wizard.
  3. Open the Portal workplace in the section list.
  4. Click Set up sections on the toolbar.
  5. Select the Cases section in the section list and click List setup.
  6. Click New column in the Subtitle or Additional columns block and select the required column.
  7. Save the list settings in the Cases section.
  8. Save the settings of the Mobile application wizard section.

Learn more about adding a column to the section list in the user documentation: Set up mobile application section list .

Hide the column title from the case list 

  1. Go to the Configuration section.

  2. Open the MobileCaseGridPageSettingsPortal schema in the custom package. If you are yet to set up the case list using the Mobile Application Wizard, the MobileCaseGridPageSettingsPortal schema will not be available in the custom package.

    To add the MobileCaseGridPageSettingsPortal schema to the custom package:

    1. Click to open the System Designer.
    2. Go to the System setup block → Mobile application wizard.
    3. Open the Portal workplace in the section list.
    4. Click Set up sections on the toolbar.
    5. Select the Cases section in the section list and click Page setup.
    6. Save the settings of the Cases section page.
    7. Save the settings of the Mobile application wizard section.

  3. Hide the column title from the case list. To do this, add a configuration object of the column whose title must be hidden to the beginning of the diff array of modifications.

    1. Specify the column in the value property. Column name template: $ColumnName.
    2. Set the visible property (whether to display the column title) to false.

    View an example that hides the [Status] column title below.

    Example of the values property setup
    [
    {
        "operation": "merge",
        "name": "settings",
        "values": {
            "modelViewConfig": "{\"viewConfig\":{\"properties\":{\"body\":{\"properties\":{\"name\":\"CaseEntityList\",\"itemLayout\":{\"properties\":{\"subtitles\":[{\"alias\":\"Case.Status\",\"label\":{\"visible\":false},\"value\":\"$Status\"}]}}}}}}}"
        }
    }
    ...
]
  4. Click Save on the Designer’s toolbar.

Configure the case sorting order in the list 

  1. Go to the Configuration section.

  2. Open the MobileCaseGridPageSettingsPortal schema in the custom package. If you are yet to set up the case list using the Mobile Application Wizard, the MobileCaseGridPageSettingsPortal schema will not be available in the custom package.

    To add the MobileCaseGridPageSettingsPortal schema to the custom package:

    1. Click to open the System Designer.
    2. Go to the System setup block → Mobile application wizard.
    3. Open the Portal workplace in the section list.
    4. Click Set up sections on the toolbar.
    5. Select the Cases section in the section list and click Page setup.
    6. Save the settings of the Cases section page.
    7. Save the settings of the Mobile application wizard section.

  3. Set up the sorting order in the case list. To do this, add a configuration object that has the list display settings to the beginning of the diff array of modifications.

    1. Specify the name of the column to use for sorting in the columnPath property.
    2. Specify the alias of the column to use for sorting in the alias property.
    3. Specify the sorting order in the orderDirection property: 1 for ascending, 2 for descending.
    4. Specify the index of the column in the column collection to use for sorting in the orderPosition property.

    View an example that configures the sorting in the case list below. The cases in the list are sorted by the [RegisteredOn] column in ascending order.

    Example of the values property setup
    [
    {
        "operation": "merge",
        "name": "settings",
        "values": {
            "modelViewConfig": "{\"controllers\":{\"Case\":{\"model\":{\"config\":{\"columns\":[{\"alias\":\"Case.RegisteredOn\",\"expression\":{\"columnPath\":\"RegisteredOn\",\"expressionType\": 0},\"orderDirection\":1,\"orderPosition\":0}]}}}}}"
        }
    }
    ...
]
  4. Click Save on the Designer toolbar.

Set up the case page 

Set up the case page to add a column to the Details tab.

To add a column to the Details tab of the case page:

  1. Click to open the System Designer.
  2. Go to the System setup block → Mobile application wizard.
  3. Open the Portal workplace in the section list.
  4. Click Set up sections on the toolbar.
  5. Select the Cases section in the section list and click Page setup.
  6. Click New column in the General information block and select the Number column.
  7. Save the settings of the Cases section page.
  8. Save the settings of the Mobile application wizard section.

Note. All columns of the Details tab are read-only.

Set up the page that adds cases 

You can add a column to the page that adds cases.

To add a column to the page that adds cases:

  1. Go to the Configuration section.
  2. Open the MobileCaseMiniPagePortal schema of the CaseMobile package and copy its contents.
  3. Select a custom package to add the schema.

  4. Click Add → Module on the section list toolbar.

  5. Fill out the schema properties.

    • Set Code to the schema name. Required. Must contain the prefix (by default, Usr) specified in the Schema name prefix (SchemaNamePrefix code) system setting.
    • Set Title to the localizable schema title. Required.
  6. Add the copied contents of the MobileCaseMiniPagePortal schema of the CaseMobile package to the custom module.
  7. Move the localized strings of the MobileCaseMiniPagePortal schema of the CaseMobile package to the custom module.

  8. Add a column.

    1. Add the element to use for editing the required column to the viewConfig property. Specify the column in the value property. Column name template: $ColumnName.

      View an example that adds the [$ConfItem] column below.

      Example of the viewConfig property setup
      "viewConfig": {
    ...
    "editCard": {
        ...
        "body": {
            ...
            "items": [
                ...
                {
                    "type": "EditField",
                    "properties": {
                        "value": "$ConfItem"
                    }
                }
            ]
        }
    }
}

      $ConfItem is the column name.

    2. Add the description of the required column to the controllers property. Specify the name of the schema column of the Case object in the columnPath property.

      View an example that describes the [ConfItem] column below.

      Example of the controllers property setup
      "controllers": {
    ...
    "model": {
        ...
        "columns": [
        ...
            {
                "expression": {
                    "columnPath": "ConfItem",
                    "expressionType": 0
                }
            }
        ]
    }
}
  9. Click Save on the Designer’s toolbar.

  10. Register the earlier created UsrMobileCaseMiniPagePortal custom schema in the portal workplace manifest.

    1. Open the MobileApplicationManifestPortal schema in the custom package. If you are yet to set up the app using the Mobile Application Wizard yet, the MobileApplicationManifestPortal schema will not be available in the custom package.

      To add the MobileApplicationManifestPortal schema to the custom package:

      1. Click to open the System Designer.
      2. Go to the System setup block → Mobile application wizard.
      3. Open the Portal workplace in the section list.
      4. Click Set up sections on the toolbar.
      5. Select the Cases section in the section list and click Page setup.
      6. Save the settings of the Cases section page.
      7. Save the settings of the Mobile application wizard section.

    2. Register the schema.

      1. Specify the schema used to add the schema record of the Case object in the Modules property.
      2. Specify the schema used to extend the schema of the Case object in the Models property.

      View an example that registers the UsrMobileCaseMiniPagePortal schema below.

      Example of the Modules and Models property setup
      {
    ...
    "Modules": {
        "Case": {
            ...
            "screens": {
                ...
                "add": {
                    "schemaName": "UsrMobileCaseMiniPagePortal"
                }
                ...
            }
            ...
        }
        ...
    },
    "Models": {
        "Case": {
            ...
            "PagesExtensions": [
                "UsrMobileCaseMiniPagePortal"
            ]
        }
        ...
    }
    ...
}
See also
Set up mobile app workplaces
Set up mobile application section page
Set up mobile application section list
Develop in Creatio IDE
Packages basics