Skip to content

Input Modules

The various input modules Slingshot can use to detect new, incoming files.

aspera

Checks an Aspera on Cloud workspace for newly received packages.

input:
    module: aspera
    workspaces: # (1)!
        - Workspace Name
    regexes: # (2)!
        - package_regex: \d+_(?P<vendor>[a-z]+)_\d+ # (3)!
          pipeline: vendor_in # (4)!
    include_dropbox_packages: true # (5)!
  1. A list of Aspera on Cloud workspaces to monitor for packages. Workspace Name
  2. A list of regular expressions to match the package name to, evaluated top down.

  3. The package name will test against this regular expression. If it's a match, it will be added to the ingest queue.

    Info

    You can capture template variables here for later use in the pipeline.

  4. The ingest pipeline to use for this specific package_regex match.

  5. If False, Slingshot will only trigger on packages sent directly to the Slingshot aspera-client account.

    If True, it will also trigger on packages sent to any shared inbox the Slingshot aspera-client account is a part of.

Package Name

Items' package name will be set to the full Aspera package name that the vendor types in when sending.

Unlike some other modules, you do not need a package_name capture group inside of package_regex.

aws_sqs

box

watchfolder

Monitors a folder on disk for new files.

Each time it runs, it takes a snapshot of the watch_path, compares it to the previous snapshot to calculate the difference, and then adds any newly created files to the queue.

While there is no hard limit to the number of files it can compare at once, it's good practice to delete or move files out of the watchfolder once they've been ingested using the cleanup action module.

input:
    module: watchfolder
    watch_path: /Volumes/VFX_postoffice/_slingshot_in # (1)!
    pipeline: vendor_in # (2)!
    package_regex: null # (3)!
    extra_data: # (4)!
        vendor: INH # (5)!

  1. The local path to monitor.

    Note: the package_name will be set to the top most subfolder in the watch path.

  2. The ingest pipeline to use for files added to this path.

  3. Optional: a regular expression to capture values from the package name.

    Note

    The package will be added even if it doesn't match this regex. It's only used to capture values for templating, not for filtering.

  4. Optional: a dictionary of metadata that will be injected onto every created item.

  5. In this example, all items created from this input will have their vendor set to "INH"

test