Actions

generate-file

5min

This action generates files such as PDFs, CSVs, or text files. It accepts content to be written to the file, along with an optional encoding parameter. Once generated, the file's URI is returned and included in the action instance output.
﻿Configuration options﻿
Some properties are common to all components, see Common component properties﻿ for a list and their configuration options.
﻿
Core structure
﻿
content
The content to be included in the file. You can use datasources, expressions, or text.
fileName
Give the file a name, this name is used as the local file name, and is referenced as part of the uri, which can be accessed via the action's instance output (=@ctx.actions.generateFile.outputs.uri). The action output uri is only available in the sequential action-list.
The file extension must be included in the fileName, e.g., Application.txt.
instanceId
Provide a unique identifier for the action, which provides access to the action's state.
title
Provide the action button with a title, for example, Create Application.
Other options
﻿
encoding
The encoding parameter specifies how an already encoded file should be interpreted when it is read. It does not encode the file itself but rather determines how the provided file content is decoded.
Accepted encoding options:
utf8 - default
ascii
base64
All three encoding types are supported and will return errors if the provided file content is incompatible with the selected encoding.
If a plain text string (e.g., "Hello World") is supplied with base64 encoding, the file will appear empty because it is not a valid base64-encoded string.
When a valid base64 string (e.g., "SGVsbG8sIFdvcmx" for "Hello World") is provided, it will be decoded correctly, resulting in a readable file with the expected content.
After reading the file, conversion﻿ can be configured if needed.
Considerations
You can reference the local file using the action's output uri in other actions or components, =@ctx.actions.generateFile.outputs.uri. For example, generate the file then share﻿ the file. The outputs is only supported in a sequential action-list, meaning within the context of that action. To use the outputs in components, either use the saved value or persist it to state.
Depending on where you save and use the saved file, you might need to use conversions﻿. 
The file extension must be included in the fileName, e.g., FormA.docx. 
﻿Examples and code snippets ﻿
Generate and share the file
Generate text file
﻿
In this example, an action list contains two actions: the first generates a text file, the second shares the file via a sharing app on the device.   
action-generate-file.jigx
title: Contact Details
description: Provide your details
type: jig.default

header:
  type: component.jig-header
  options:
    height: small
    children: 
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1450101499163-c8848c66ca85?w=900&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTR8fGludm9pY2luZ3xlbnwwfHwwfHx8MA%3D%3D    
  
children:
  - type: component.section
    options:
      title: Details
      children: 
        - type: component.form
          instanceId: inputValues
          options:
            children:
              - type: component.text-field
                instanceId: firstName
                options:
                  initialValue: John Smith
                  label: First name
                  isRequired: false
              - type: component.email-field
                instanceId: email
                options:
                  initialValue: john.smith@global.com
                  label: Email address
              - type: component.number-field
                instanceId: phoneNumber
                options:
                  initialValue: 23445634556
                  label: Mobile number
# Create an action list that will first create the text file,
# secondly share the text file via one of the devices sharing apps.     
actions:
  - children:
      # Use the action.list so that the file is accessible as an action output.   
      - type: action.action-list
        options:
          title: Share contact
          isSequential: true
          actions:
            - type: action.generate-file
            # Provide the unique identifier used in the action output callback. 
              instanceId: file-contact
              options:
              # Specify the content to display in the file.
                content: >
                  =(
                    @ctx.components.firstName.state.value 
                    & ' ' 
                    & @ctx.components.email.state.value 
                    & ' ' 
                    & @ctx.components.phoneNumber.state.value
                  )
                # Give the file a name, the extenstion must be supplied.  
                fileName: contactDetails.txt
            # Share the file using the device's apps.    
            - type: action.share
              options: 
               # Use the action instance output to reference the file.
                fileUri: =@ctx.actions.file-contact.outputs.uri
                message: =@ctx.components.firstName.state.value & ' ' & 'Details'
                subject: =@ctx.components.firstName.state.value & ' ' & 'Details'
title: Contact Details
description: Provide your details
type: jig.default

header:
  type: component.jig-header
  options:
    height: small
    children: 
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1450101499163-c8848c66ca85?w=900&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTR8fGludm9pY2luZ3xlbnwwfHwwfHx8MA%3D%3D    
  
children:
  - type: component.section
    options:
      title: Details
      children: 
        - type: component.form
          instanceId: inputValues
          options:
            children:
              - type: component.text-field
                instanceId: firstName
                options:
                  initialValue: John Smith
                  label: First name
                  isRequired: false
              - type: component.email-field
                instanceId: email
                options:
                  initialValue: john.smith@global.com
                  label: Email address
              - type: component.number-field
                instanceId: phoneNumber
                options:
                  initialValue: 23445634556
                  label: Mobile number
# Create an action list that will first create the text file,
# secondly share the text file via one of the devices sharing apps.     
actions:
  - children:
      # Use the action.list so that the file is accessible as an action output.   
      - type: action.action-list
        options:
          title: Share contact
          isSequential: true
          actions:
            - type: action.generate-file
            # Provide the unique identifier used in the action output callback. 
              instanceId: file-contact
              options:
              # Specify the content to display in the file.
                content: >
                  =(
                    @ctx.components.firstName.state.value 
                    & ' ' 
                    & @ctx.components.email.state.value 
                    & ' ' 
                    & @ctx.components.phoneNumber.state.value
                  )
                # Give the file a name, the extenstion must be supplied.  
                fileName: contactDetails.txt
            # Share the file using the device's apps.    
            - type: action.share
              options: 
               # Use the action instance output to reference the file.
                fileUri: =@ctx.actions.file-contact.outputs.uri
                message: =@ctx.components.firstName.state.value & ' ' & 'Details'
                subject: =@ctx.components.firstName.state.value & ' ' & 'Details'
﻿
﻿

Core structure
content	The content to be included in the file. You can use datasources, expressions, or text.
fileName	Give the file a name, this name is used as the local file name, and is referenced as part of the uri, which can be accessed via the action's instance output (=@ctx.actions.generateFile.outputs.uri). The action output uri is only available in the sequential action-list. The file extension must be included in the fileName, e.g., Application.txt.
instanceId	Provide a unique identifier for the action, which provides access to the action's state.
title	Provide the action button with a title, for example, Create Application.

Other options
encoding	The encoding parameter specifies how an already encoded file should be interpreted when it is read. It does not encode the file itself but rather determines how the provided file content is decoded. Accepted encoding options: utf8 - default ascii base64 All three encoding types are supported and will return errors if the provided file content is incompatible with the selected encoding. If a plain text string (e.g., "Hello World") is supplied with base64 encoding, the file will appear empty because it is not a valid base64-encoded string. When a valid base64 string (e.g., "SGVsbG8sIFdvcmx" for "Hello World") is provided, it will be decoded correctly, resulting in a readable file with the expected content. After reading the file, conversion can be configured if needed.

execute-entity

generate-pdf

generate-file

﻿Configuration options﻿

Core structure

Other options

Considerations

﻿Examples and code snippets ﻿

Generate and share the file

Configuration options

Examples and code snippets