Expressions

Jigx Variables

16min

﻿
﻿ has a set of variables that can be used in expressions to manipulate data specific to a  
﻿, for example, determining the logged-in user, or the 
﻿ organization and solution. 
Organization
The organization variable is used to get information about the actual organization in 
﻿, such as your 
﻿organization's id.
Configuration
Result
Expression
id
[email protected]
﻿Examples and code snippets ﻿
Organization expression
﻿
This example returns the organization's id . Each organization configured in Organization Settings﻿ in 
﻿and will have a unique id. 
See the full code sample in GitHub. 
YAML
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Organization ID
            value: [email protected]
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Organization ID
            value: =@ctx.organization.id
﻿
System
The system variable in an expression is used to get information about devices, for example, you can find information about the internet connection of the device, the language preference, the device's timezone and location details. System expressions are configured by [email protected]. followed by the specific variable name. 
Configuration
The supported variables for the system variable are:
Variable
Expression
Results
deviceType
[email protected]
The variable returns the current user's device type, such as tablet or handset.
geocodes
[email protected]
﻿
isOffline
[email protected]
Boolean
isOnline
[email protected]
Boolean
isPortrait
[email protected]
The variable is set with a boolean and is used to configure the behavior of components in either portrait or landscape mode.
locale
[email protected]
﻿
timezone
[email protected]
Get the information about the device's timezone, it can be:
-name: e.g. Europe/Prague
-offset: e.g. +200
geolocation
Accuracy: 
[email protected]
Altitude:
[email protected]
Altitude Accuracy: [email protected]
Location - Heading: [email protected]
Location - Latitude:
[email protected]
Location - Longitude:
[email protected]
Location - Speed:
[email protected]
Location - Timestamp:
[email protected]
Location - Entire array (All details):
=$string(@ctx.system.geolocation)
﻿
isLocationSharingEnabled
[email protected]
Boolean
solution
[email protected]
XXXXXXXX-XXX-XXXX-XXXX-XXXXXXXXXXXX
user
[email protected]
or
[email protected]
[email protected]
or
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Examples and code snippets 
System isOffline
System expression
﻿
With this expression, you can disable the action button to prevent it from being pressed if the device is offline.
See the full code sample in GitHub. 
isOffline.jigx
actions:
  - children:
      - type: action.go-to
        options:
          style:
            isDisabled: [email protected] = true
          title: Go to action
          linkTo: advanced-expressions
actions:
  - children:
      - type: action.go-to
        options:
          style:
            isDisabled: =@ctx.system.isOffline = true
          title: Go to action
          linkTo: advanced-expressions
﻿
﻿
﻿
System timezone
 This example uses system.timezone to get the information about the device's timezone, it can be the name of the timezone or the offset. Use it further to convert date/time using Date & Time﻿ expressions into the format that you require.
See the full code sample in GitHub.
YAML
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Timezone name
            value: [email protected]
        - type: component.entity-field
          options:
            label: Timezone offset
            value: [email protected]
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Timezone name
            value: =@ctx.system.timezone.name
        - type: component.entity-field
          options:
            label: Timezone offset
            value: =@ctx.system.timezone.offset
﻿
﻿
System timezone expression
﻿
System geolocation
system geolocation expression
﻿
﻿
This example shows how you can use system.geolocation to get the device's location (details).
See the full code sample in GitHub.
YAML
children: 
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: System Location - Accuracy
            value: [email protected]
        - type: component.entity-field
          options:
            label: System Location - Altitude
            value: [email protected]
        - type: component.entity-field
          options:
            label: System Location - Altitude Accuracy
            value: [email protected]
        - type: component.entity-field
          options:
            label: System Location - Heading
            value: [email protected]
        - type: component.entity-field
          options:
            label: System Location - Latitude
            value: [email protected]
        - type: component.entity-field
          options:
            label: System Location - Longitude
            value: [email protected]
        - type: component.entity-field
          options:
            label: System Location - Speed
            value: [email protected]
        - type: component.entity-field
          options:
            label: System Location - Timestamp
            value: [email protected]
            contentType: time
        - type: component.entity-field
          options:
            label: System Location - Entire array (All details)
            value: =$string(@ctx.system.geolocation)

children: 
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: System Location - Accuracy
            value: =@ctx.system.geolocation.coords.accuracy
        - type: component.entity-field
          options:
            label: System Location - Altitude
            value: =@ctx.system.geolocation.coords.altitude
        - type: component.entity-field
          options:
            label: System Location - Altitude Accuracy
            value: =@ctx.system.geolocation.coords.altitudeAccuracy
        - type: component.entity-field
          options:
            label: System Location - Heading
            value: =@ctx.system.geolocation.coords.heading
        - type: component.entity-field
          options:
            label: System Location - Latitude
            value: =@ctx.system.geolocation.coords.latitude
        - type: component.entity-field
          options:
            label: System Location - Longitude
            value: =@ctx.system.geolocation.coords.longitude
        - type: component.entity-field
          options:
            label: System Location - Speed
            value: =@ctx.system.geolocation.coords.speed
        - type: component.entity-field
          options:
            label: System Location - Timestamp
            value: =@ctx.system.geolocation.timestamp
            contentType: time
        - type: component.entity-field
          options:
            label: System Location - Entire array (All details)
            value: =$string(@ctx.system.geolocation)
﻿
System isLocationSharingEnabled
See the example using dynamic data in GitHub.  
YAML
  onFinish: 
            type: action.confirm
            options:
              isConfirmedAutomatically: false
              onConfirmed: 
                type: action.go-back
              modal:
                title: Enjoy your pizza
      # Add the ability to stop sharing your location 
      - type: action.stop-location-sharing
        when: [email protected]
        options:
          title: Stop sharing
  onFinish: 
            type: action.confirm
            options:
              isConfirmedAutomatically: false
              onConfirmed: 
                type: action.go-back
              modal:
                title: Enjoy your pizza
      # Add the ability to stop sharing your location 
      - type: action.stop-location-sharing
        when: =@ctx.system.isLocationSharingEnabled
        options:
          title: Stop sharing
﻿
﻿
User
Examples and code snippets 
The user is used to get information about the logged-in user, for example, name, and email.
Configuration
Result
Expression
Name
[email protected]
Email
[email protected]
id
[email protected]
User expression
﻿
See the full code sample in GitHub.
user.jigx
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: User Display Name
            value: [email protected]
        - type: component.entity-field
          options:
            label: User Email
            value: [email protected]
        - type: component.entity-field
          options:
            label: User Id
            value: [email protected]
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: User Display Name
            value: =@ctx.user.displayName
        - type: component.entity-field
          options:
            label: User Email
            value: =@ctx.user.email
        - type: component.entity-field
          options:
            label: User Id
            value: =@ctx.user.id
﻿
Solution
The solution variable is used to get information about the specific 
﻿ solution, for example, name, and id. Custom variables﻿ can be set in Solution Settings﻿ in 
﻿, and the variable value referenced in the solution expression.
Configuration
Result
Expression
name
[email protected]
id
[email protected]
variable value
[email protected]
Examples and code snippets 
Solution Id and name
Solution expression
﻿
This example shows how to get the solution's id and name using the solution variable.
See the full code sample in Github. 
YAML
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Solution ID
            value: [email protected]
        - type: component.entity-field
          options:
            label: Solution Name
            value: [email protected]
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Solution ID
            value: =@ctx.solution.id
        - type: component.entity-field
          options:
            label: Solution Name
            value: =@ctx.solution.name
﻿
Solution settings - custom variable
Setting Custom Variables
﻿
Showing variable value
﻿
YAML
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            rightIcon: cursor-click-computers
            label: Click to view the report in SharePoint
# Reference the custom variable set in Management in the expression            
            value: [email protected]_URL
children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            rightIcon: cursor-click-computers
            label: Click to view the report in SharePoint
# Reference the custom variable set in Management in the expression            
            value: =@ctx.solution.settings.custom.SharePoint_URL
﻿
﻿

Result	Expression
id	[email protected]

Variable	Expression	Results
deviceType	[email protected]	The variable returns the current user's device type, such as tablet or handset.
geocodes	[email protected]
isOffline	[email protected]	Boolean
isOnline	[email protected]	Boolean
isPortrait	[email protected]	The variable is set with a boolean and is used to configure the behavior of components in either portrait or landscape mode.
locale	[email protected]
timezone	[email protected]	Get the information about the device's timezone, it can be: -name: e.g. Europe/Prague -offset: e.g. +200
geolocation	Accuracy: [email protected] Altitude: [email protected] Altitude Accuracy: [email protected] Location - Heading: [email protected] Location - Latitude: [email protected] Location - Longitude: [email protected] Location - Speed: [email protected] Location - Timestamp: [email protected] Location - Entire array (All details): =$string(@ctx.system.geolocation)
isLocationSharingEnabled	[email protected]	Boolean
solution	[email protected]	XXXXXXXX-XXX-XXXX-XXXX-XXXXXXXXXXXX
user	[email protected] or [email protected]	[email protected] or XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX