Workflow Activity Pack Documentation

⌘K
  1. Home
  2. Docs
  3. Workflow Activity Pack Do...
  4. Conversion Activity Refer...
  5. Save File

Save File

Description

The Save File activity takes BLOB object, prompts the user to download a file, downloads the file to their computer, and returns a success message.

Offline Support

Supported. Please contact us directly to license for offline support and installation instructions.

Example Workflow and Output Files

To open the sample workflow in Workflow Designer:
    • In Workflow Designer, click File in the sidebar
    • Click Open by URL and paste in the following url: https://www.arcgis.com/home/item.html?id=f94f4c6112f34d54a100de2c57bda994
    • To Save, click File in the Workflow Designer sidebar, and click Save.

Inputs

Blob

Required
Type: Object

A JavaScript File object (e.g., from the File Picker form widget).

File Name

Optional
Type: String

The default file name (not including the file extension).

File Extension

Optional
Type: String

The format of the file. Check which extensions are supported by each goeWidgets Activity.

Localization

Optional
Type: String

Add or update the localization JSON string if you want localized text. See doumentation for localization and JSON formatting.    Example:   [{“en”: {“panel.title”: “Save File”, “panel.message”: “Enter the File Name”, “panel.button.save”: “Save”, “panel.button.cancel”: “Cancel” }}, { “es”: { “panel.title”: “Guardar Archivo”, “panel.message”: “Introduzca un nombre de fichero”, “panel.button.save”: “Guardar”, “panel.button.cancel”: “” }}] 

CSS URL

Optional
Type: String

A remote reference to a CSS file that will be used to style the “Save File” dialog.  The default CSS is:  .save-file-custom-form { display: flex; flex-direction: column; padding: 10px; } .save-file-descriptor { margin-left: 5px; font-size: 14px; font-weight: bold; color: #555555; } .save-file-input-container { position: relative; display: inline-block; } .save-file-input { margin-top: 10px; width: 100%; padding: 5px 8px; font-size: 13px; border: 1px solid #cccccc; border-radius: 1px; } .save-file-input.empty:focus { border: 1px solid #db2828; outline: 2px solid rgba(219, 40, 40, 0.40); } .save-file-input.empty { border: 1px solid #db2828; } .save-file-extension { z-index: 1; position: absolute; right: 7px; bottom: 7px; font-size: 12px; font-weight: 600; cursor: default; } .save-file-button-container { margin-top: 20px; display: flex; justify-content: flex-end; } .save-file-button { margin-left: 7px; padding: 6px 10px; outline: none; background: #f5f5f5; border: 1px solid #cccccc; border-radius: 2px; font-size: 13px; color: #1a72c4; } .save-file-button:hover { background-color: #1a72c4; color: #ffffff; text-decoration: none; } 

Button Order

Optional
Type: String

Sets the order of the Save File buttons. Default is [Save][Cancel]. Reversed is [Cancel][Save] 

 

Outputs

Result

Type: Object

Properties:

  • filename Type: String
  • fileExt Type: String
  • cancelled Type: String
  • error Type: String

A result object containing download details for errors regarding the download.

Properties

ID

Optional

The activity’s ID, which is used in other activities to access the activity’s output. The ID must be unique across the entire workflow and it’s subworkflows – two activities cannot have the same ID.

You might want to change the ID to shorten it. Shorter IDs make expressions more compact.

Display Name

Optional

The activity’s name in Workflow Designer. The display name appears at the top of the activity on the design surface. The default display name for this activity is Save File.

You might want to change the display name to a name that describes what the activity does in the context of your workflow. Description names make workflows easier to understand and maintain.

Description

Optional

A description of what the activity does. The description appears below the activity’s display name.

Use the description to record what the activity does in the context of the workflow. Descriptions make workflows easier to understand and maintain.