Actions

execute-entities

8min

Execute-entities is used to modify, create, and delete multiple rows in a specific table in a database. 
Execute-entities can't be used if you're using Static Data﻿. 
﻿Configuration options﻿
An execute-entities action can be used in multiple areas:
Under action button
In action list
In onPress/onChange events (if the component has these options)
In onRefresh/onFocus
Reference data properties and values as a group
With the execute-entities action, you can reference data properties and values as a group instead of listing them individually to be saved or created. See the data-grouped example below:
data-grouped
data-individual-listed
actions:
  - children:
      - type: action.execute-entities
        options:
          title: Create Record(s)
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/hikers
          method: create
          data: [email protected]
          onSuccess: 
            type: action.go-back
actions:
  - children:
      - type: action.execute-entities
        options:
          title: Create Record(s)
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/hikers
          method: create
          data: =@ctx.datasources.items
          onSuccess: 
            type: action.go-back
﻿
Offline remote data handling
Dealing with offline remote data is fundamental to ensuring data synchronization and consistency between the mobile app and the remote data source, allowing users to continue using the app and performing actions without interruption. Offline remote data handling﻿ explains how to configure solutions to deal with data when the device is offline using the queueOperations property available in execute-entities, and provides examples and code samples.
﻿Examples and code snippets ﻿
Execute entities
﻿
Example:
See the full example of execute-entities as an action in GitHub. 
execute-entities-action
actions:
  - children:
    - type: action.execute-entities
      options:
        title: Add user
        provider: DATA_PROVIDER_DYNAMIC
        method: create
        entity: default/form
        data:
          firstname: [email protected]-detail-dynamic.firstname
          lastname: [email protected]-detail-dynamic.lastname
actions:
  - children:
    - type: action.execute-entities
      options:
        title: Add user
        provider: DATA_PROVIDER_DYNAMIC
        method: create
        entity: default/form
        data:
          firstname: =@ctx.datasources.employee-detail-dynamic.firstname
          lastname: =@ctx.datasources.employee-detail-dynamic.lastname
﻿
Example:
See the full example of execute-entities in an action list in GitHub. 
execute-entities-action-list
actions:
  - children:
      - type: action.action-list
        options:
          isSequential: true
          title: Add user
          actions:
            - type: action.execute-entities
              options:
                provider: DATA_PROVIDER_DYNAMIC
                method: create
                entity: default/form
                data:
                  firstname: [email protected]-detail-dynamic.firstname
                  lastname: [email protected]-detail-dynamic.lastname
            - type: action.info-modal
              options:
                modal:
                  title: User successfully added  
                  buttonText: See user list
                  element: 
                    type: icon
                    icon: add-circle-bold-alternate
                    color: element
                onConfirmed: 
                  type: action.go-to
                  options:
                    linkTo: execute-entities-onPress
actions:
  - children:
      - type: action.action-list
        options:
          isSequential: true
          title: Add user
          actions:
            - type: action.execute-entities
              options:
                provider: DATA_PROVIDER_DYNAMIC
                method: create
                entity: default/form
                data:
                  firstname: =@ctx.datasources.employee-detail-dynamic.firstname
                  lastname: =@ctx.datasources.employee-detail-dynamic.lastname
            - type: action.info-modal
              options:
                modal:
                  title: User successfully added  
                  buttonText: See user list
                  element: 
                    type: icon
                    icon: add-circle-bold-alternate
                    color: element
                onConfirmed: 
                  type: action.go-to
                  options:
                    linkTo: execute-entities-onPress
﻿
Here is the example of execute-entities in onPress/onChange event in list-item﻿.
Execute-entities
﻿
Example:
See the full example of execute-entities in action onPress in GitHub. 
See the full example of execute-entities in action onChange in GitHub. 
onPress
onChange
onChange: 
  type: action.execute-entities
  options:
    provider: DATA_PROVIDER_LOCAL
    method: update
    entity: default/employees
    data: 
      id: [email protected]
      modify: =$number(@ctx.current.item.modify) + 1
onChange: 
  type: action.execute-entities
  options:
    provider: DATA_PROVIDER_LOCAL
    method: update
    entity: default/employees
    data: 
      id: =@ctx.current.item.id
      modify: =$number(@ctx.current.item.modify) + 1
﻿
Execute-entites
﻿
Example:
See the full example of execute-entities in onRefresh in GitHub. 
See the full example of execute-entities in onFocus in GitHub. 
execute-entities-onRefresh
execute-entities-onFocus
onFocus: 
  type: action.execute-entities
  options:
    provider: DATA_PROVIDER_LOCAL
    method: update
    entity: default/employees
    data: [email protected]-detail-dynamic.{'id':id, 'modify':$number(modify)+1}
onFocus: 
  type: action.execute-entities
  options:
    provider: DATA_PROVIDER_LOCAL
    method: update
    entity: default/employees
    data: =@ctx.datasources.employee-detail-dynamic.{'id':id, 'modify':$number(modify)+1}
﻿
 To delete multiple data records in a Dynamic data table use the execute entities action with an expression as shown below.
This code example is not in the jigx.samples solution in GitHub.
Example:
Execute-entities-multiple
actions:
  - children:
      - type: action.execute-entities
        options: 
          title: Delete employees
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/employees
          method: delete
          data: [email protected].{"id" :id}[]
actions:
  - children:
      - type: action.execute-entities
        options: 
          title: Delete employees
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/employees
          method: delete
          data: =@ctx.datasources.employee.{"id" :id}[]
﻿
Updating multiple data records using execute-entities
 To update multiple data records in a Dynamic data table use the execute entities action with an expression as shown below.
This code example is not in the jigx.samples solution in GitHub.
Example:
YAML
actions:
  - children:
      - type: action.execute-entities
        options:
          title: Update Records
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/penguin_species
          method: update
          data: [email protected]-species ~> | $ | {"endangered":"Yes"} |    
actions:
  - children:
      - type: action.execute-entities
        options:
          title: Update Records
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/penguin_species
          method: update
          data: =@ctx.datasources.penguin-species ~> | $ | {"endangered":"Yes"} |    
﻿
Updating multiple data records in a single REST call
See Update multiple records in a single REST call﻿ for an example of using execute-entities with REST.