ecl-logo Documentation

PriceInstrumentTime

PriceInstrumentTime[protocol]table

provides a table listing the pricing information for all instruments used by protocol.

PriceInstrumentTime[notebook, Span[startDate, endDate]]table

provides a table listing the pricing information for all instruments used by completed protocols in notebook between the startDate and endDate.

PriceInstrumentTime[notebook]table

provides a table listing the pricing information for all instruments used by all completed protocols in notebook between Now and one month before Now.

PriceInstrumentTime[team, Span[startDate, endDate]]table

provides a table listing the pricing information for all instruments used by all completed protocols in notebooks financed by team between the startDate and endDate.

PriceInstrumentTime[team]table

provides a table listing the pricing information for all instruments used by all completed protocols in notebooks financed by team between Now and one month before Now.

Details

  • The pricing is based upon the PricingRate of each given instrument and how long that instrument was used in the protocol.
  • Pricing information is only calculated for Completed parent protocols.
  • For the Team or Notebook overloads, non-Completed and non-parent protocols are filtered out and not displayed.
  • By default, if teams or notebooks are specified and no date range is provided, function defaults to showing protocols completed in the past 30 days.
  • Note that the prices displayed in this documentation are only for the sake of example and do not represent actual prices.
  • In order to find the real pricing rate for an instrument, please Download the PricingRate field from the corresponding Model[Instrument] object.
  • Input
    Output
    General Options
    Messages
  • MissingPricingLevelThe following instruments used do not have a listed pricing level: `1`. These instruments have been filtered out of the displayed results. Please contact ECL to ensure this field is properly populated for all instruments.
    ParentProtocolRequiredThe following provided protocol(s) are subprotocols: `1`. These protocols' prices are already included in the price of their parent protocols. Please provide only completed parent protocols to the inputs of PriceInstrumentTime.
    ProtocolNotCompletedThe following provided protocol(s) are not yet completed and thus pricing from instrument time cannot be calculated: `1`. Please wait until these protocols are completed and then call this function again.