Skip to main content

Post Notes to Investorflow

Overview​

This pipeline is designed to post notes from a Source Entity in your BuiltAPI Workspace to specified Market Assets in Investorflow. The content and visibility of the note are determined by mappings from the Source Entity.

Pipeline Parameters​

Name​

  • Type: String
  • Description: A user-defined name for this pipeline instance.
  • Example: "Post Market Asset Updates as Notes to Investorflow"

General Settings​

General pipeline configuration settings. The question mark icon (?) next to the section title in the UI suggests more details are available there.

  • Pipeline Timeout
    • Type: String
    • Description: Timeout duration for processing the pipeline (e.g., "10m" for 10 minutes, "1h" for 1 hour). The question mark icon (?) in the UI provides more information.
    • Default: "10 min"

Source Entity Settings​

Settings for fetching records from the source entity that will be used to create notes. 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 data for the notes and the ID of the related Investorflow Market Asset. 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 are selected from the Source Entity. Only notes from these records will be posted. This field is optional. 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 limited by "Source Entity Take" and if "Source Entity Only Updated" is disabled or no previous run state exists)

  • Source Entity Take ("*")

    • Type: Number
    • Description: Specifies the maximum number of records (and thus potential notes) 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 (integer between 1 and 100). 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 helps prevent posting duplicate notes. 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 Post Notes Parameters​

Parameters for forming and inserting the note into a MarketAsset in Investorflow. The question mark icon (?) next to the section title in the UI suggests more details are available there.

  • MarketAsset ID Mapping ("*")

    • Type: Text Area (expects a JSONata expression or dot path)
    • Description: Specifies how to retrieve the Investorflow MarketAsset ID from each processed Source Entity record. This ID identifies the MarketAsset to which the note will be attached. 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_market_asset_id") that extracts the MarketAsset ID from the source record.

  • Note Template Mapping ("*")

    • Type: Text Area (expects a JSONata expression or dot path generating a string)
    • Description: Specifies how to generate the note text (content/body) from the Source Entity record. 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., "'Update: ' & data.status & '. Details: ' & data.details") that constructs the full text of the note.

  • Note Visibility Mapping ("*")

    • Type: Select
    • Description: Determines the visibility of the note in Investorflow (e.g., Public or Internal). The question mark icon (?) in the UI provides more information. The asterisk (*) indicates this is a required field.
    • Configuration: Choose from the available options:
      • Public
      • Internal
    • Default: Public