Add a File or Image to Omniscript (Managed Package)

For the managed package runtime, add and configure a File or Image element to enable the upload of files and images. Files and images upload to Content Documents by default.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Note
Note

The Image and File elements don't work in preview because they use SFDC components. When Image and File elements are required in a Step, the Preview cannot advance past the Step. Vlocity recommends marking File and Image elements as Required only before activating the Omniscript.

Omniscripts and Flexcards support all image file types by default. If set, the lightning-file-upload accept attribute filters file types in the user's file browser. If set, the Don't allow HTML uploads as attachments or document records security setting disallows .svg image files. See Lightning Web Component File Upload.

  1. From Omniscript, under Available Components, drag the File or Image element from the Inputs section into a Step in the Structure panel.
  2. To attach the Content Document to a parent record, enter a content parent object ID or comma-separated list of object IDs. When left blank, the Content Document does not attach to a parent record.
    Note
    Note

    In the LWC Omniscript Designer files and images upload to Content Documents by default. By default, the LWC File and LWC Image elements accept a file size of up to 2GB.

  3. (Optional) When configuring the Image element, allow uploads of multiple images by selecting Allow Multiple Images.
  4. (Optional) Use one of the JSON node names from Image and File to apply a condition to another element:
    "yourFileElementName": [
              {
                "data": "0693g000000T1ZFAA0",
                "filename": "isolated-on-png.png",
                "vId": "0683g000000T11iAAC",
                "size": 8234
              }
            ]

What’s next: When a file is attached to a File element in Omniscript, it adds this JSON to the Data JSON of the form. To map the file's JSON to a Salesforce record, see Mapping File Attachments From an Omniscript to Salesforce (Managed Package).