Set up the mobile portal

Level: beginner

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

Add base package schema to the user-made package

If you are yet to perform the setup using the Mobile Application Wizard, the base package schema might not be available in the user-made package.

To add base package schema to the user-made 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.

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 the workplace.

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 your Creatio application includes the mobile portal functionality.

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. Learn more in user documentation: Object operation permissions.

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 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. Go to the System setup block → Mobile application wizard.
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.
• Make a case list column searchable.
• Hide the column title from the case list.
• Change 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 the New column button 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.

As a result, Creatio will add a column to the case list. However, the column will not be searchable. To make the case list column searchable, follow the instructions in different section: Add a searchable column to the case list.

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

Make a case list column searchable

Number and Description columns of the case list are searchable. You can make other columns searchable as well. To do this, add the columns to the MobileCaseGridPageSettingsPortal schema.

To make a case list column searchable:

1. Go to the Configuration section.

2. Open the MobileCaseGridPageSettingsPortal schema in the user-made 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 user-made package. To add the MobileCaseGridPageSettingsPortal schema to the user-made package, follow the instructions in a different section: Add a base package schema to the user-made package.

3. Make a case list column searchable.

   For Creatio version 8.0.2 and later

   For Creatio version 8.0.2 and later, add a merge operation of the diffV2 property. This will let you add any operation that modifies metadata to the property as a string.

   The example below makes the [Subject] column of the case list searchable in Creatio version 8.0.2 and later.

   Example of the searchExpressions property setup

   8.0.2 and later

   [
       {
           "operation": "merge",
           "name": "settings",
           "values": {"diffV2":"[{\"operation\":\"insert\",\"name\":\"Case_Controller_SearchExpression_Subject\",\"parentName\":\"Case_Controller\",\"propertyName\":\"searchExpressions\",\"values\":{\"leftCondition\":\"Subject\"}}]"
           }
       }
       ...
   ]

   This example adds the [Subject] column settings to the current search settings in the searchExpressions property.

   For Creatio version 7.18.4-8.0.1

   For Creatio version 7.18.4-8.0.1, add the alias of the column to make searchable to the alias property of the diff array of modifications.

   The example below makes the [Subject] column of the case list searchable in Creatio version 7.18.4-8.0.1.

   Example of the searchExpressions property setup

   7.18.4-8.0.1

   [
       {
           "operation": "merge",
           "name": "settings",
           "values": {"modelViewConfig":"{\"controllers\":{\"Case\":{\"model\":{\"config\":{\"columns\":[{\"alias\":\"Case.RegisteredOn\",\"expression\":{\"columnPath\":\"RegisteredOn\",\"expressionType\":0},\"orderDirection\":2,\"orderPosition\":0}]}},\"config\":{\"searchExpressions\":[{\"alias\":\"Case.Number\",\"leftCondition\":\"Number\"},{\"alias\":\"Case.Symptoms\",\"leftCondition\":\"Symptoms\"},{\"alias\":\"Case.Subject\",\"leftCondition\":\"Subject\"}]}}}}"
           }
       }
       ...
   ]

   This example adds the [Subject] column settings to the current search settings in the searchExpressions property.

4. Click Save on the Module Designer’s toolbar.

As a result, Number, Description, and Subject columns of the case list will be searchable.

Hide the column title from the case list

1. Go to the Configuration section.

2. Open the MobileCaseGridPageSettingsPortal schema in the user-made 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 user-made package. To add the MobileCaseGridPageSettingsPortal schema to the user-made package, follow the instructions in a different section: Add base package schema to the user-made package.

3. Hide the column title from the case list.

   For Creatio version 8.0.2 and later

   For Creatio version 8.0.2 and later, add the configuration object of the column whose title to hide to the beginning of the diffV2 array of modifications.

   1. Specify the column in the name property. Column name template: ObjectName_ListItem_Subtitle_ColumnName.
   2. Set the visible property to false. The visible property specifies whether to display the column title.

   The example below hides the [Status] column title in Creatio version 8.0.2 and later.

   Example of the values property setup

   8.0.2 and later

   [
       {
           "operation": "merge",
           "name": "settings",
           "values": {"diffV2":"[{\"operation\":\"merge\",\"name\":\"Case_ListItem_Subtitle_Status\",\"values\":{\"label\":{\"visible\":false}}}]"
           }
       }
       ...
   ]

   Case_ListItem_Subtitle_Status is the value of the name property of the [Status] column in the Case object in Creatio version 8.0.2 and later.

   For Creatio version 7.18.4-8.0.1

   For Creatio version 7.18.4-8.0.1, add the configuration object of the column whose title to hide to the beginning of the diff array of modifications.

   3. Specify the column in the value property. Column name template: $ColumnName.
   4. Set the visible property to false. The visible property specifies whether to display the column title.

   The example below hides the [Status] column title in Creatio version 7.18.4-8.0.1.

   Example of the values property setup

   7.18.4-8.0.1

   [
       {
           "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 Module Designer’s toolbar.

As a result, Creatio will hide the column title from the case list.

Change the case sorting order in the list

1. Go to the Configuration section.

2. Open the MobileCaseGridPageSettingsPortal schema in the user-made 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 user-made package. To add the MobileCaseGridPageSettingsPortal schema to the user-made package, follow the instructions in a different section: Add base package schema to the user-made package.

3. Change the sorting order in the case list.

   For Creatio version 8.0.2 and later

   For Creatio version 8.0.2 and later, add the configuration object that contains the list display settings to the beginning of the diffV2 array of modifications.

   1. Specify the column to use for sorting in the name property. Column name template: ObjectName_Model_Column_ColumnName.
   2. Specify the sorting order in the orderDirection property: 1 for ascending, 2 for descending.
   3. Use the orderPosition property to specify the index of the column in the column collection to use for sorting.

   The example below changes the case list sorting in Creatio version 8.0.2 and later. The cases in the list are sorted by the [RegisteredOn] column in ascending order.

   Example of the values property setup

   8.0.2 and later

   [
       {
           "operation": "merge",
           "name": "settings",
           "values": {"diffV2":"[{\"operation\":\"merge\",\"name\":\"Case_Model_Column_RegisteredOn\",\"values\":{\"orderDirection\":1}}]"
           }
       }
       ...
   ]

   Case_Model_Column_RegisteredOn is the value of the name property for the [RegisteredOn] column in the Case object in Creatio version 8.0.2 and later.

   For Creatio version 7.18.4-8.0.1

   For Creatio version 7.18.4-8.0.1, add a configuration object that contains the list of display settings to the beginning of the diff array of modifications.

   4. Use the columnPath property to specify the name of the column to use for sorting.
   5. Use the alias property to specify the alias of the column to use for sorting.
   6. Use the orderDirection property to specify the sorting order: 1 for ascending, 2 for descending.
   7. Use the orderPosition property to specify the index of the column in the column collection to use for sorting.

   The example below changes the case list sorting in Creatio version 7.18.4-8.0.1. The cases in the list are sorted by the [RegisteredOn] column in ascending order.

   Example of the values property setup

   7.18.4-8.0.1

   [
       {
           "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 Module Designer’s toolbar.

As a result, Creatio will display cases sorted in the specified order in the list.

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

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. Create a schema of the case page module.

   1. Go to the Configuration section.

   2. Open the MobileCaseMiniPagePortal schema of the CaseMobile package and copy its contents.

   3. select a user-made package to add the schema.

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

      

   5. Fill out the schema properties.

      • Enter the schema name in the Code property. Required. The name must start with the prefix specified in the Prefix for object name (SchemaNamePrefix code) system setting, Usr by default. Can contain Latin characters and digits. When you create a configuration element schema, Creatio adds the prefix specified in the Prefix for object name (SchemaNamePrefix code) system setting to the current field automatically. Creatio checks whether the prefix exists and matches the system setting when you save the schema properties. If the prefix does not exist or does not match, Creatio sends a corresponding user notification.
      • Enter the localizable schema title in the Title property. Required. The title of the configuration element schema is generated automatically and matches the value of the Code property without a prefix.

      

   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.

      For Creatio version 8.0.2 and later

      1. Specify the column in the value property of the viewConfig configuration object. Column name template: $ColumnName.

         The example below adds the [$ConfItem] column in Creatio version 8.0.2 and later.

         Example that adds the column to the viewConfig property

         8.0.2 and later

         {
             "operation": "insert",
             "name": "CaseAddCardConfItem",
             "values": {"type": "EditField", "properties": {"value": "$ConfItem"}},
             "parentName": "CaseAddCardBody",
             "propertyName": "items",
             "index": 2
         },

         $ConfItem is the column name in Creatio version 8.0.2 and later.

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

         The example below adds the description of the [ConfItem] column in Creatio version 8.0.2 and later.

         Example that adds the column to the controllers property

         8.0.2 and later

         {
             "operation": "insert",
             "name": "CaseModelConfItemColumn",
             "values": {"expression": {"columnPath": "ConfItem", "expressionType": 0}},
             "parentName": "CaseModel",
             "propertyName": "columns",
             "index": 3
         },
      For Creatio version 7.18.4-8.0.1

      3. Specify the column in the value property of the viewConfig configuration object. Column name template: $ColumnName.

         The example below adds the [$ConfItem] column in Creatio version 7.18.4-8.0.1.

         Example that adds the column to the viewConfig property

         7.18.4-8.0.1

         "viewConfig": {
             ...
             "editCard": {
                 ...
                 "body": {
                     ...
                     "items": [
                         ...
                         {
                             "type": "EditField",
                             "properties": {
                                 "value": "$ConfItem"
                             }
                         }
                     ]
                 }
             }
         }

         $ConfItem is the name of the column in Creatio version 7.18.4-8.0.1.

      4. Add the description of the required column to the controllers property. Use the columnPath property to specify the name of the schema column of the Case object.

         The example below adds the description of the [ConfItem] column in Creatio version 7.18.4-8.0.1.

         Example that adds the column to the controllers property

         7.18.4-8.0.1

         "controllers": {
             ...
             "model": {
                 ...
                 "columns": [
                 ...
                     {
                         "expression": {
                             "columnPath": "ConfItem",
                             "expressionType": 0
                         }
                     }
                 ]
             }
         }

   9. Click Save on the Module Designer’s toolbar.

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

   1. Open the MobileApplicationManifestPortal schema in the user-made package. If you are yet to set up the app using the Mobile Application Wizard, the MobileApplicationManifestPortal schema will not be available in the user-made package. To add the MobileApplicationManifestPortal schema to the user-made package, follow the instructions in a different section: Add base package schema to the user-made package.

   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.

      The example below registers the UsrMobileCaseMiniPagePortal schema.

      Example of the Modules and Models property setup

      {
          ...
          "Modules": {
              "Case": {
                  ...
                  "screens": {
                      ...
                      "add": {
                          "schemaName": "UsrMobileCaseMiniPagePortal"
                      }
                      ...
                  }
                  ...
              }
              ...
          },
          "Models": {
              "Case": {
                  ...
                  "PagesExtensions": [
                      "UsrMobileCaseMiniPagePortal"
                  ]
              }
              ...
          }
          ...
      }

3. Click Save on the Module Designer’s toolbar.

---

See also

Set up mobile app workplaces (user documentation)

Set up mobile application section page (user documentation)

Set up mobile application section list (user documentation)

Creatio IDE

Packages basics

Object operation permissions (user documentation)