Building Apps with Jigx
Best practice

9min
When to use solution state (global state)
﻿State﻿ manages the state of the app, including the UI's data and the user's interactions, and is best used in scenarios with a one-to-one relationship; for example, a field services person selects one job or task to complete, or a pilot selects one mission to fly. 
Design Pattern: Singletons
﻿
Setup:
Set the ID to be stored in the solution state, using the set-state action. The ID is the least amount of data required to identify each job uniquely. The ID is used throughout the solution to reference the necessary data in each of the solution's 
﻿s. 
In the datasource queries use the ID to return the required data.
 In a global datasource query reference the data required. The global datasource is referenced in each 
﻿ where the data is required.
In the individual 
﻿ 's datasource query. The query is configured to only return the exact data required for that 
﻿ using the ID as the unique identifier.
set-solution-state (action)
use-solution-state (datasource)
actions:
  - children:
      - type: action.set-state
        options:
          title: Task A
          state: [email protected]
          value: [email protected]
actions:
  - children:
      - type: action.set-state
        options:
          title: Task A
          state: =@ctx.solution.state.id
          value: =@ctx.solution.state.id
﻿
State resources and code samples:
﻿Solution (Global) State﻿ 
﻿Set-state﻿ 
﻿Reset-state﻿ 
﻿Examples of state﻿ 
When to use inputs
﻿Inputs﻿ are used in complex apps to pass multiple variables between 
﻿s using parameters, and is best used in scenarios where there is a one-to-many relationship, for example, a manager needs to check on the progress of each field service worker. 
Design Pattern: Mediator
﻿
Setup:
Set up parameters in the 
﻿ that needs to pass data, then in the 
﻿ needing to receive the data set up inputs. Multiple parameters and inputs can be configured on a single 
﻿.
In the components of the 
﻿ use expressions to reference the data passed in, for example, [email protected].
set-parameters
use-input
actions:
  - children:    
      - type: action.go-to
        options:
          title: Team Progress
          linkTo: team-progress
# Define what data the parameters must use
# The parameters name is used in the receiving jig's input expression            
          parameters:
            taskId: [email protected]
            taskStatus: [email protected]
            taskCost: [email protected]
            taskAssignee: [email protected] 
actions:
  - children:    
      - type: action.go-to
        options:
          title: Team Progress
          linkTo: team-progress
# Define what data the parameters must use
# The parameters name is used in the receiving jig's input expression            
          parameters:
            taskId: =@ctx.components.taskId.state.value
            taskStatus: =@ctx.components.taskStatus.state.value
            taskCost: =@ctx.components.taskCost.state.value
            taskAssignee: =@ctx.components.taskAssignee.state.value 
﻿
Input resources and code samples:
﻿Passing data using inputs﻿ 
﻿Input examples﻿ 
When to use outputs
﻿Outputs﻿ are used to combine multiple 
﻿s into one 
﻿. Outputs pass variables from each 
﻿ into the next 
﻿, and is best used in scenarios where there is a many-to-one relationship, for example, a manager needs to report on the progress of the team. Creating a master detail form is another usecase for outputs.
Design Pattern: Observer
﻿
Setup:
In the 
﻿ that will pass the data define the output property with an expression that will pass the variable, such as an ID. 
 In the composite 
﻿, which combines multiple 
﻿s, define the input property on the 
﻿ that must receive the variable. 
team-progress (output)
team
team-report (input)
title: Team progress
type: jig.list
icon: contact

datasources:
  team-update: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
  
      entities:
        - default/tasks
  # Define a query parameter to use the output property,
  # when it is passed into the jig.
      query: |
        SELECT
         id,
         '$.taskId',
         '$.taskAssignee',
         '$.taskCost',
         '$.taskStatus',
         '$.taskProfile' 
        FROM [default/tasks] 
        WHERE id = @statId
      queryParameters:
        statId: [email protected]
      
data: [email protected]-update
item:
  type: component.list-item
  options:
    title: [email protected]
    subtitle: [email protected]
    leftElement: 
      element: avatar
      text: [email protected]
      uri: [email protected]
    rightElement: 
      element: value
      text: [email protected]
title: Team progress
type: jig.list
icon: contact

datasources:
  team-update: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
  
      entities:
        - default/tasks
  # Define a query parameter to use the output property,
  # when it is passed into the jig.
      query: |
        SELECT
         id,
         '$.taskId',
         '$.taskAssignee',
         '$.taskCost',
         '$.taskStatus',
         '$.taskProfile' 
        FROM [default/tasks] 
        WHERE id = @statId
      queryParameters:
        statId: =@ctx.solution.state.teamId
      
data: =@ctx.datasources.team-update
item:
  type: component.list-item
  options:
    title: =@ctx.current.item.taskId
    subtitle: =@ctx.current.item.taskCost
    leftElement: 
      element: avatar
      text: =@ctx.current.item.taskAssignee
      uri: =@ctx.current.item.taskProfile
    rightElement: 
      element: value
      text: =@ctx.current.item.taskStatus
﻿
Output resources and code samples:
﻿Passing data using outputs﻿ 
﻿Output examples﻿ 
Performance optimization
Using an id in your datasource enhances performance, particularly when handling large volumes of records.
datasource
datasources:
  team-update: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
      entities:
        - default/tasks
      query: |
        SELECT
         id,
         '$.taskId',
         '$.taskAssignee',
         '$.taskCost',
         '$.taskStatus',
         '$.taskProfile' 
        FROM [default/tasks] 
        WHERE id = @statId
      queryParameters:
        statId: [email protected]
datasources:
  team-update: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
      entities:
        - default/tasks
      query: |
        SELECT
         id,
         '$.taskId',
         '$.taskAssignee',
         '$.taskCost',
         '$.taskStatus',
         '$.taskProfile' 
        FROM [default/tasks] 
        WHERE id = @statId
      queryParameters:
        statId: =@ctx.solution.state.teamId
﻿
﻿
Updated 16 Sep 2024
Did this page help you?
Notifications
Management Overview