Skip to main content

Update Market Assets in Investorflow

Overview​

This pipeline updates market assets, including general asset information and tenancy schedules, in Investorflow. It uses data from a specified Source Entity within your BuiltAPI Workspace to identify and modify the corresponding assets in Investorflow.

Pipeline Parameters​

Name​

  • Type: String
  • Description: A user-defined name for this pipeline instance.
  • Example: "Update Investorflow Asset Tenancy Schedules from CRM"

Source Entity Settings​

Configuration options for specifying the source of the data used for updates.

  • Source Entity

    • Type: Entity
    • Description: The BuiltAPI entity from which data will be pulled to update market asset metadata in Investorflow. This entity should contain the necessary information for identifying assets and the new metadata values.
    • Configuration: Select the appropriate entity from the dropdown menu.

  • Source Entity Filter

    • Type: JSON (Mongo Query)
    • Description: Defines conditions under which records are selected from the Source Entity for processing. Only records matching this filter will be used to update Investorflow assets. The question mark icon (?) in the UI provides more information.
    • Configuration: Enter a Mongo query JSON object that specifies filtering rules in the provided editor.
    • Default: "{}" (empty object, meaning all records if not specified otherwise and not limited by "Source Entity Take")

  • Source Entity Take

    • Type: Number
    • Description: Specifies the maximum number of records to take from the Source Entity in a single run. The question mark icon (?) in the UI provides more information.
    • 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 of this pipeline. If disabled, all records matching the filter and "Source Entity Take" limit will be processed.
    • Default: Enabled (as indicated by the active state of the toggle in the UI)

Investorflow Update Market Assets Files Metadata Parameters​

Parameters for defining how to map source entity fields to Investorflow fields.

  • Investorflow Asset ID ("*")

    • Type: Text Area (expects a JSONata expression or dot path)
    • Description: Map the field that provides the unique asset identifier in Investorflow.
    • 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 Body ("*")

    • Type: Text Area (expects a JSONata expression generating a JSON object)
    • Description: Map the field(s) that provide asset details for updating in Investorflow
    • Configuration: Enter a JSONata expression that constructs the JSON payload for the asset update, using data from the source record. Refer to the Investorflow API documentation for the required body structure.

  • Investorflow Asset Tenancy Schedules Body ("*")

    • Type: Text Area (expects a JSONata expression generating a JSON object)
    • Description: Map the field(s) that provide tenancy schedules for the asset.
    • Configuration: Enter a JSONata expression that constructs the JSON payload for the tenancy schedules update, using data from the source record. Refer to the Investorflow API documentation for the required body structure for tenancy schedules.