Create a customer list with data

8min
Overview
In this section, you learn how to create a jig.list﻿ type that uses the dynamic data provider﻿ to return and display a list of records. You specify the fields that must be returned in the list 
﻿ and add an onPress list action﻿ that opens a 
﻿ used to view the selected list item record. 
Steps
Create a list jig
Open the Hello-
﻿ solution in 
﻿ in 
﻿, right-click on the 
﻿s node in Explorer, and select New file.
Name the file list-customer. The file opens and shows the 
﻿'s auto-complete popup listing the five types of 
﻿s you can select. Click on List to open the skeleton YAML created by the 
﻿.    
Give the 
﻿ a title called List customers and provide a description like List my customers. 
Change the icon to icon: list.This icon displays on the widget on the 
﻿.
Delete the header and onfocus nodes.
Add the data source to return data in the list
Under the datasource node specific the data provider where the customer records are stored. The name of the table that the information is being returned from. All 
﻿ Dynamic Data-based tables are saved in the "default" database.  Use a SQLite query to specify the fields to be returned in the list, in this case, we want the customer's first and last name as well as their email address.  You can add your own datasource entries or use the code example below.
YAML
datasources:
  customerList: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
      entities:
        - entity: default/customers  
      query: SELECT id, '$.firstName', '$.lastName', '$.email' FROM [default/customers] 
datasources:
  customerList: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
      entities:
        - entity: default/customers  
      query: SELECT id, '$.firstName', '$.lastName', '$.email' FROM [default/customers] 
﻿
Add controls and actions to the list item
 All list output controls are placed on the list-item component.  Use the swipeable: action to configure a left or right swipe and the method to call. For example, in this step, we use a left swipe to delete the customer using the delete method. You can add your own controls or use the code example below.
YAML
data: [email protected]
item:
  type: component.list-item
  options:
    title: [email protected] & " " & @ctx.current.item.lastName 
    subtitle: [email protected]
    swipeable:
      left:
        - label: Delete
          icon: delete
          color: warning
          onPress: 
            type: action.execute-entity
            options:
              provider: DATA_PROVIDER_DYNAMIC
              entity: default/customers
              method: delete
data: =@ctx.datasources.customerList
item:
  type: component.list-item
  options:
    title: =@ctx.current.item.firstName & " " & @ctx.current.item.lastName 
    subtitle: =@ctx.current.item.email
    swipeable:
      left:
        - label: Delete
          icon: delete
          color: warning
          onPress: 
            type: action.execute-entity
            options:
              provider: DATA_PROVIDER_DYNAMIC
              entity: default/customers
              method: delete
﻿
2. Configure the action to take once the list item has been deleted by going back to the list, by using the code below.
YAML
goBack: previous
data: 
  id: [email protected]
goBack: previous
data: 
  id: =@ctx.current.item.id
﻿
Add a navigation action
Add a navigation action that is performed when a single item is clicked in the list, and referenced by using the custId parameter. In this step clicking on a customer in the list opens the view-customer 
﻿ to view the customer's details. Use the onPress action with an action.go-to type and the linkTo option as shown below. 
YAML
 onPress: 
      type: action.go-to
      options:
        linkTo: view-customer       
        parameters:
          custId: [email protected]
 onPress: 
      type: action.go-to
      options:
        linkTo: view-customer       
        parameters:
          custId: =@ctx.current.item.id
﻿
2. Your list-customer.jigx file should resemble the code below.
list-customer.jigx
# The system name that uniquely identifies the jig
title: List customers
# Description of the jig. This is not a required field and can be omitted.
description: List of our customers
# The jig type used to list data values and elements
type: jig.list
# icon that displays on the widget on the home hub
icon: list

# The type of datasource used to store the created data in the jig
datasources:
  customerList: 
    type: datasource.sqlite
    options:
    # The data provider being used. In this case, the Jigx Dynamic Data provider
      provider: DATA_PROVIDER_DYNAMIC
      # The name of the table that the information is being returned from. All Dynamic Data-based tables are saved in the "default" database.
      entities:
        - entity: default/customers
      # The SQLite query used to specifiy the data to return  
      query: SELECT id, '$.firstName', '$.lastName', '$.email' FROM [default/customers] 

data: [email protected]
item:
  # All list output controls are placed on the list-item component
  type: component.list-item
  options:
    title: [email protected] & " " & @ctx.current.item.lastName 
    subtitle: [email protected]
    # The list-item action that defines what to do when swiping left or right on the item
    swipeable:
      left:
        - label: Delete
          icon: delete
          color: warning
          onPress: 
            type: action.execute-entity
            options:
              provider: DATA_PROVIDER_DYNAMIC
              entity: default/customers
              method: delete
              goBack: previous
              data: 
                id: [email protected]
    # The navigation action that is performed when an individual item is tapped in the list, in this instance to view the customer details
    onPress: 
      type: action.go-to
      options:
        linkTo: view-customer       
        parameters:
          custId: [email protected]
# The system name that uniquely identifies the jig
title: List customers
# Description of the jig. This is not a required field and can be omitted.
description: List of our customers
# The jig type used to list data values and elements
type: jig.list
# icon that displays on the widget on the home hub
icon: list

# The type of datasource used to store the created data in the jig
datasources:
  customerList: 
    type: datasource.sqlite
    options:
    # The data provider being used. In this case, the Jigx Dynamic Data provider
      provider: DATA_PROVIDER_DYNAMIC
      # The name of the table that the information is being returned from. All Dynamic Data-based tables are saved in the "default" database.
      entities:
        - entity: default/customers
      # The SQLite query used to specifiy the data to return  
      query: SELECT id, '$.firstName', '$.lastName', '$.email' FROM [default/customers] 

data: =@ctx.datasources.customerList
item:
  # All list output controls are placed on the list-item component
  type: component.list-item
  options:
    title: =@ctx.current.item.firstName & " " & @ctx.current.item.lastName 
    subtitle: =@ctx.current.item.email
    # The list-item action that defines what to do when swiping left or right on the item
    swipeable:
      left:
        - label: Delete
          icon: delete
          color: warning
          onPress: 
            type: action.execute-entity
            options:
              provider: DATA_PROVIDER_DYNAMIC
              entity: default/customers
              method: delete
              goBack: previous
              data: 
                id: =@ctx.current.item.id
    # The navigation action that is performed when an individual item is tapped in the list, in this instance to view the customer details
    onPress: 
      type: action.go-to
      options:
        linkTo: view-customer       
        parameters:
          custId: =@ctx.current.item.id
﻿
The list-customer.jigx file will display in red and cannot be saved yet as it references the view-customer.jigx file that you will be creating in the Create a view of the customer record﻿ step.  
﻿
Updated 31 Oct 2023
Did this page help you?
Create a new customer form
Create a view of the customer record
Docs powered by Archbee
TABLE OF CONTENTS
Overview
Steps
Create a list jig
Add the data source to return data in the list
Add controls and actions to the list item
Add a navigation action