Skip to main content

Import Asset Files from Investorflow

Overview​

This pipeline is designed to import specific asset files from Investorflow based on Asset IDs and Asset File IDs provided by a Source Entity. The imported file data is then stored or referenced in a Target Entity within your BuiltAPI Workspace. This is useful for scenarios where you need to fetch individual files associated with market assets for local processing, archiving, or integration with other systems.

Pipeline Parameters​

Name​

  • Type: String
  • Description: A user-defined name for this pipeline instance.
  • Example: "Import Investorflow Asset Contracts"

Source Entity Settings​

Configuration options for specifying the source of the Investorflow Asset IDs and Asset File IDs. The question mark icon (?) next to the section title in the UI suggests more details are available there.

  • Source Entity ("*")

    • Type: Entity
    • Description: The BuiltAPI entity that contains the Investorflow Asset IDs and Asset File IDs for which files will be fetched. The question mark icon (?) in the UI provides more information.
    • Configuration: Select the appropriate entity from the dropdown menu. The asterisk (*) indicates this is a required field.

  • Source Entity Filter ("*")

    • Type: JSON (Mongo Query)
    • Description: Defines conditions under which records (containing Asset IDs and File IDs) are selected from the Source Entity. Only files identified by these records will be imported. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Enter a Mongo query JSON object that specifies filtering rules in the provided editor.
    • Default: "{}" (empty object, meaning all records if not limited by "Source Entity Take")

  • Source Entity Take ("*")

    • Type: Number
    • Description: Specifies the maximum number of records (and thus Asset/File ID pairs) to process from the Source Entity in a single run. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Enter a number. Use the "-" and "+" buttons to decrement or increment the value.
    • Default: 10

  • Source Entity Only Updated ("*")

    • Type: Switch
    • Description: If enabled (toggled on), the pipeline will only process records from the Source Entity that have been updated since the last successful run. This is useful for fetching files only for newly relevant or changed asset-file associations. If disabled, all records matching the filter and "Source Entity Take" limit will be processed. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Default: Enabled (as indicated by the active state of the toggle in the UI)

Investorflow Get Assets Files Metadata Parameters​

Parameters specific to fetching asset files from Investorflow. (Note: UI section title mentions "Metadata" but pipeline likely imports the file itself or its direct metadata based on "Asset File ID"). The question mark icon (?) next to the section title in the UI suggests more details are available there.

  • Investorflow Asset ID ("*")

    • Type: Text Area (expects a JSONata expression or dot path)
    • Description: Specifies how to retrieve the Investorflow Asset ID from each processed Source Entity record. This ID identifies the parent asset to which the file belongs. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Enter a JSONata expression or a dot path (e.g., "data.investorflow_asset_id") that extracts the Asset ID from the source record.

  • Investorflow Asset File ID ("*")

    • Type: Text Area (expects a JSONata expression or dot path)
    • Description: Specifies how to retrieve the Investorflow Asset File ID from each processed Source Entity record. This ID identifies the specific file to be imported from the specified asset. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Enter a JSONata expression or a dot path (e.g., "data.investorflow_file_id") that extracts the Asset File ID from the source record.

  • Investorflow Is Managed Assets ("*")

    • Type: Switch
    • Description: Indicates whether the assets (to which the files belong) are "Managed Assets" in Investorflow. This distinction might affect API endpoint or parameters. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Toggle on if the assets are managed, off otherwise.
    • Default: Disabled (as indicated by the inactive state of the toggle in the UI)

Target Entity Settings​

Configuration for storing the imported file information or content. The question mark icon (?) next to the section title in the UI suggests more details are available there.

  • Target Entity ("*")

    • Type: Entity
    • Description: The BuiltAPI entity where the imported asset file data (e.g., file content, URL, or metadata) from Investorflow will be stored. The question mark icon (?) in the UI provides more information.
    • Configuration: Select the appropriate entity from the dropdown menu. The asterisk (*) indicates this is a required field.

  • Target Entity Filter Mapping ("*")

    • Type: Text Area (expects a JSONata expression for upsert filter)
    • Description: Defines the mapping for the upsert filter on the Target Entity. This is used to determine if a record for the imported file already exists (for update) or if a new record should be created. The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.