Use the DownloadAttachment component

  • Release version: Zurich
  • Updated July 31, 2025
  • 1 minute to read
  • Download the attachments from the ServiceNow table record to the local drive by using the DownloadAttachment component in the RPA Desktop Design Studio.

    Before you begin

    You must have access to the ServiceNow table record.

    Role required: none

    About this task

    The maximum size of the attachments is 1024 MB.

    You can configure the properties for the DownloadAttachment component. For more information about these properties, see Properties of the Attachment components.

    Procedure

    1. In the Toolbox pane, navigate to ServiceNow > Attachments.
    2. Drag the DownloadAttachment component to the Design surface.
    3. To configure the input fields, see Configure port properties.
    4. Connect the data and control ports of the DownloadAttachment component to the corresponding ports of the other components.
      Port name Purpose of connection Data Port type Data type
      attachmentSysID The sys ID of the record that has the attachment. You can pass this value from a previously executed component.
      You can get the sys ID of a record following these steps:
      1. Select the record in the connected ServiceNow instance and right-click the header bar.
      2. Select Copy URL.
      3. In the URL, you can find the sys ID after the parameter sys_id=. For example, 9d385017c611228701d22104cc95c371.
      Data In String
      folderPath The path in the local drive where the attachment will be downloaded. Data In String
      Overwrite Returns a true or false value that indicates whether the file was successfully downloaded.

      If the download location already has a file with the same name, the operation fails.

      Data In Boolean
      Return Returns the details of the downloaded file as an object and passes it to another component. Data Out Boolean
    5. Optional: To test the component, under the DESIGN tab, click Run.