Index settings

In the index.jigx file, you set solution settings, including the primary information about the solution, the Home Hub set up, and properties reusable throughout the solution.

Name, title, category, description

Name - Your internal solution name.
Title - This name will be displayed in your app and management.
Category - The category can be customized and is overwritten when the description property is added.
Description - A description you provide for your solution. This will replace the selected category.
Icon - Customize the solutions icon. A list of icons is available.
Color - Apply a color to the selected icon.

name: global-solutions
title: global solutions
category: consulting

Tabs

Tabs are properties used to build your navigation bar that displays at the bottom of the Home Hub.
You can configure multiple tabs. The first four tabs are displayed in the Home Hub bottom navigation. Additional tabs appear when the More (ellipsis) button is tapped.
Each tab is associated with a jig that is displayed when pressed. The first tab by default displays when the app is opened.
Setting the grid jig as the first tab's jig creates a visually appealing and easy-to-navigate home screen.

Core Structure

tabs

The top level property under which the various tabs are configured.

icon

The icon to be shown on the navigation bar for the tab, for example a home icon.

jigId

The name/ unique identifier of the jig that will open when the tab is pressed.

Other options

badge

Optional property - Enhance your tab with a customizable badge for instance showing the number of events this week or the number of new orders. Add the badge property to the tabs section with an expression.

label

Give the tab a title. This title appears below the icon in the navigation bar. Use the label property for translating tab names or when the tab name includes spaces.

when

The condition when the tab will be displayed or hidden (optional). Use an that evaluates to a boolean.

index.jigx

name: jigx-samples
title: Jigx Samples
category: business

# Configure one or more tabs, shown in the navigation bar at the bottom of the 
# app.
tabs:
  # Give each tab a name. First tab.
  home:
    # Optional - provide a label to display under the tab icon.
    label: home
    # This jig is the home screen and is visible when the app opens.
    jigId: grid-home
    # Select an icon of your choice.
    icon: home-apps-logo
  # Second tab.
  Services:
    # Reference the jig that will open when the tab icon is pressed.
    jigId: grid-components
    icon: cleaning-bucket-bubble
  # Third tab
  Bookings:
    jigId: grid-booking
    icon: calendar
    # Configure a badge showing a dot or a numbered dot on the top right of 
    # the icon. Use a expression or number to set the badge.
    badge: =$count(@ctx.datasources.guests)
  # Fourth tab
  Reviews:
    jigId: feedback
    icon: online-class-student

OnLoad, OnFocus, OnRefresh, onTableChanged

These properties allow you to configure Actions executed in various scenarios.

OnLoad - when the solution loads for the first time the configured actions execute. This is recommended for best performance when working with data, sync the data when the solution loads and ensures the data is available from the beginning and throughout the rest of the solution.
OnFocus - when the Home Hub receives focus the configured actions execute.
OnRefresh - when pulling down on the Home Hub the action configured for onRefresh executes. The onRefresh spinner is persistently visible while an action is executing, preventing users from triggering a redundant pull-to-refresh gesture.
onTableChanged - This event enables a remote system like Acumatica to call into Jigx and trigger changes on a mobile device by monitoring data updates. It detects changes in specific data tables (entities) and executes the configured actions accordingly.

onLoad:
  type: action.set-state
  options:
    state: [email protected]
    value: =$now()

onRefresh:
  type: action.execute-entity
  options:
    provider: DATA_PROVIDER_DYNAMIC
    entity: default/test
    method: update
    goBack: previous
    data:
      id: [email protected]
      action: "Execute-entity onRefresh"

onTableChanged:
  # Specify the remote table to monitor.
  - table: employees
    action:
      # Configure the action to execute when a change is detected.
      type: action.reset-solution-state
      options:
        changes:
          - dataStatus

Global Expressions

Use the expressions property to set expressions that are reusable throughout the solution in various jigs.

expressions:
  user: [email protected]
  timezone: [email protected]
  altitude: [email protected]

title: Shared expressions example

children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Current User
            value: [email protected]
        - type: component.entity-field
          options:
            label: Current Timezone
            value: [email protected]
        - type: component.entity-field
          options:
            label: Current Altitude
            value: [email protected]

For more details and examples refer to the Shared Expressions section in Expressions.

Dependencies

In the dependencies property, you can define the mobile app build version compatible with the YAML configuration.

If the current mobile app build version does not meet the criteria, the Out of date screen will appear, with a message that an update is required. Tapping the Update button redirects you to your app settings to update the version of the app.