Skip to content

Entity Details

The Entity Details page displays all Entities defined per Application. It can also be used by Administrators to add custom attributes to an Entity. These can be existing fields in the Logical Unit that are not currently synchronized with the mobile app or Custom Attributes.

For Push and Batch Entities, there is also a possibility to increase performance by changing the push data structure and what change detection that should be used for the data.

The Entity Details page consists of the following groups

  • Entity Details Group
  • Push Synchronization (only Push and Batch entities)
  • Grouped Push Synchronization (only Grouped Push entities)
  • Attributes

What groups as well as what information in each group that is shown, depends of what type of entity it is.

Entity Details Group

All Entity Details Group are read-only and for information purposes only.

For Push and Batch Entity there are however two Boolean fields that can be changed:

  • Push Structure On Modify that controls the behavior of the push data structure when a pushed record is modified. By switching off the flag, admin can stop sending push data as a structure when push record get modified to improve the performance. The push synchronization always sends master and detail records (structure) when the data is available to the user for the first time. It comes by default on.
  • Row Level Change Detection that controls what data that will trigger a push to the device. By default, push data entities enable row-level change detection unless the synchronization rule in the app model sets it to off. If this is turned on, the push trigger acts on row-level changes using the row version column. When it is turned off, it uses a column-level change detection, allowing you to decide which data should trigger a push to the device, improving push data performance. The data to select when it is turned off is done in the Attribute section.

The Default Where statement shows the Where clause that is applied to the view when synchronizing the data to the mobile app. Although this Where clause cannot be modified, it is possible to add an additional Where clause by creating Filters for the Security Group Grants associated with the Entity as displayed in Synchronization Rules.

Create Permission Set Filter

Additional row level filtering can be added to any Entity that is synchronized with an mobile app by adding Filters to the Security Group Grants. See Security and Filters for more information how to set up the Permissions Sets against Security Groups and how to add Filters to Security Group Grants.

When this is done and is granted to the end user it will take effect on the next Sync whether that is Push, Batch or manually triggered via Sync Now.

Note 1: It is important to remember that large data sets should be filtered to ensure the synchronization processes (Push, Batch on the server & Initialize on the client)

Note 2: It is important to ensure that any permission set filter that is added to an entity is efficient and does not impact the synchronization process.

Push Synchronization

Push Synchronization is only shown for the Push and Batch Entities. It has the following fields.

  • Ownership Query, which is used to identify the user(s) that the data should be synchronized to via the Push process.
  • Guard Condition which will prevent the unnecessary creation of Push Queue records when no data should be pushed to a mobile app.

Grouped Push Synchronization

Grouped Push Synchronization is only shown for the Grouped Push Entities. It has the following fields.

  • User Filter Name, filter that provides dynamic, row-level security by restricting data access based on the User Id. This ensures that each user sees only the relevant data mapped to them through a configurable data set.
  • User Filter Attr Names, refers to the column names from an entity that are used to determine access control when applying User Filters. These attributes define which fields in the dataset are checked against the user's access configuration to enforce row-level security dynamically.

Attributes

The Entity Details and Attributes represent the tables and columns that will be created as tables and columns within the mobile apps local database. Only the Entity Details and Attributes displayed in this page that are Published will be synchronized with the mobile app.

All Attribute Details are read-only and for information purposes only (with the exception of Boolean True Value and Boolean False Value for Boolean Custom Attributes).

The Change Detection column is only available for Push and Batch Entities and is shown if the Boolean flag for Row Level Change Detection is turned off. It shows which attributes will trigger a push to the device, if they are changed in IFS Cloud.

There are different Action Commands as well as different tabs depending on which type of entity it is

Action Commands

Add Custom Attributes

It is possible to Add new Attributes that will be synchronized with the mobile app via the command Add Custom Attributes. This will allow the addition of any field that exists in the Application Projection that is not currently being synchronized with the mobile app or any Custom Attributes created against the Logical Unit. This command is available for all types of Entities.

On selecting the command Add Custom Attributes a dialog will be displayed showing all attributes that can be added to the Entity.

Once new attributes have been added they must be published via the command Publish Custom Attributes.

If multiple changes are to be made to entity attributes then the publishing can wait until all entity attribute changes have been made.  This will minimize the impact on the mobile app users as publishing will notify all users of the mobile app that an Initialization is required to synchronize the new table configuration and data.

Note 1: It is only possible to Publish Custom Attributes against an Active Application Version.

Note 2: It is possible to delete Custom Attributes.

Note 3: When adding a Custom Attribute that is a Boolean, the Boolean True Value and Boolean False Value fields must be set if the values used in the Boolean Attribute are different to the standard "TRUE" and "FALSE".

Note 4: Persistent Custom Attributes with the data type Reference are not supported by the Mobile Framework.

Note 5: Read-only Custom Attributes of type Reference, Select and Expression are not supported by the Mobile Framework.

Note 6: Custom Attributes of type Enumeration with Enumeration Format "Multi" are not supported by the Mobile Framework.

Note 7: In order to do UI changes see Apps for Page Designer and Client Side Configurations - IFS Cloud Web Page Designer.

Update Change Detection Attributes

Update Change Detection Attributes is only available for Push and Batch Entities and is shown if the Boolean flag for Row Level Change Detection is turned off. With this command it is possible to select the data that should trigger a push to the device.

Reset Change Detection

Reset Change Detection is only available for Push and Batch Entities and is shown if the Boolean flag for Row Level Change Detection is turned off. With this command it is possible to reset all changes made and go back to the default settings of change detection.

Grouped Push Detection Block

Grouped Push Detection Block is only available if the Entity is defined with a Grouped Push Synchronization Rule Delivery Method. Then the tables used to maintain the Grouped Push data will be shown in the Change Detection Blocks tab. This lists all Tables and Columns that are used in the Grouped Push synchronization process to maintain the Entity data for the mobile app users.

For details on the Grouped Push Synchronization Process can be found on the Mobile App Framework Synchronization Guide

Action Commands

Publish Custom Attributes

Once the Custom Attributes have been amended they must be Published so that they become available to the Users of the mobile app. To do this the command Publish Custom Attributes must be used. This will mark all custom attributes as Published and all Users of the mobile app will be notified that an Initialization is required to synchronize the new table configuration and data.

See the Mobile App Framework Synchronization Guide and/or the Troubleshooting Mobile Apps for more information.