MetrixIDR Services

This category contains the following MetrixIDR Services configuration items:

Client List Importer. Configurable global settings for the Client List Importer.

  • AddMetersAsInEst. If set to true, when a new meter is added to a meter group, it will be added as not “In Estimation”. The default for this setting is False.
  • UseSimplifiedUpdateLogic. If set to true, simplified contract updating logic is used. This logic does not require perfect consistency in the contract dates of the provided contract. It assumes that the latest presented information is correct.

Diagnostics. Configurable items for diagnostics.

  • AuditUserLogonActivity. If set to true, every user log on and log off is logged in the Event Log. If set to false, this information is not logged.
  • DebugProjectsPath. The folder path where saved MetrixND projects will be placed during debugging. Debugging is turned on or off in the forecast task.
  • DefaultLogLevel. The default log detail written to the event log for tasks. Options are None, Full, Task, and SubTask.
  • LogDatabaseActivity. Turns on diagnostic logging for all database operations.
  • Meter Group Diagnostics. Turns on diagnostic logging for all Meter Group Calculations.
  • RequiresWindowsAuthentication. When set to true, MetrixIDR will prompt the user to re-enter their Windows login password when starting up. When set to false, the login window will not prompt for a password.

  • UseApplicationServerClock. When set to true, MetrixIDR will get clock time from the application server rather than the database server. This setting is read-only.

Email Notification. Email notification configuration.

  • SendEmailAddress. The name to display in the "From" field of emails.
  • SendPassword. The password used to authenticate the sender.
  • SendUserName. The username used to authenticate the sender.
  • SMTPServer. The name or IP address of the host used for SMTP transactions.
  • SMTPServerPort. The port used for SMTP transactions.
  • SMTPUseSSL. If set to true, SSL is enabled for SMTP transactions. If set to false, SSL is disabled for SMTP transactions.

Engine. Engine configuration.

  • ForecastMissingTolerance. The number of missing values in a forecast before it is rejected. Null rejects empty forecasts. -1 Disables the check.
  • HeartbeatInterval. The number of milliseconds between heartbeats.
  • HeartbeatThreshold. The number of milliseconds until a server is considered unresponsive.
  • ImportRecoveryThreshold. For table-based imports, the maximum number of hours old ‘In Process’ records need to be before attempting to re-import.
  • LongTermMeterDataImport. Setting this to True indicates that there is a Long-Term system installed that is also processing records from the IMPORT_READING staging table.
  • MaxImportThreads. The maximum number of threads created for processing table-based imports.
  • MaxMeterGroupCalculations. Sets the maximum number of simultaneous meter group calculations a server will perform.
  • MaxParallelTasks. The maximum number of parallel tasks.
  • ParallelTaskTimeout. The timeout (in seconds) for parallel tasks.
  • TaskShutdownTimeout. Sets the number of seconds to wait on a task to finish when shutting down the MetrixIDR Service.
  • TransactionTimeout. The timeout (in seconds) for transactions.
  • UpdateBatchSize. The update batch size.

FTP. FTP configuration.

  • UseWebProxy. If set to true, web proxy will be used when connecting to an FTP server.
  • WebProxyURL. The address on the web proxy server.

Integration. Integration configuration.

  • ExportCombineOutputFiles. When set to True, all XML forecast exports are combined into a single XML file. When set to False, a separate file is exported for every item. This applies to forecasts exported from both Forecast Monitor and MetrixIDR.
  • ExportDestination. The destination of the forecast export when the forecast is published from Forecast Monitor. Options are ToStagingTable and ToXMLFile. This only applies to forecasts published from Forecast Monitor.
  • ExportPath. The path to the export folder.
  • ExportPublishedSeriesType. The series type for the published series. The most recent forecast for each interval and the most recent born on date are the two options.
  • ExportShiftMPI. The number of intervals to shift the forecast date/time on export. This applies to forecasts published from Forecast Monitor. This also applies to MetrixIDR when ExportOnPublish = True.
  • ExportUnassignedConcepts. When set to True and publishing from Forecast Monitor, all concepts will be exported even when they are not assigned. When set to False and publishing from Forecast Monitor, only assigned concepts will be exported.
  • ExportUploadID. Name of an optional TaskID for an upload files task. If specified, the upload files task will execute after the export to XML is complete. This only applies to forecasts published from Forecast Monitor.
  • ExportXMLTransform. Path to an optional XLST stylesheet to transform XML export files. This only applies to forecasts published from Forecast Monitor.

Long Term. Long Term client configuration.

  • LongTermEnabled. If set to True, the Long-Term Only tabs and modules will be available in the client.
  • LongTermMeterDataImport. If set to True, the table-based import will also load the Long-Term interval data.

Medium Term. Medium Term Forecast configuration.

  • BlendWeather. If set to True, Medium Term forecasts will include the Master Weather Forecast and blend it into the scenario weather.

Meter Validation Parameters. Default parameters when executing a Compute Meter Validation task.

  • DaysBack. The number of days back of data to use in the calculation.

  • ExcludeBad. When set to true, data marked as bad is excluded from the calculation.

  • ExcludeFilled. When set to true, data marked as filled is excluded from the calculation.

  • ExcludeIncomplete. When set to true, data marked as incomplete is excluded from the calculation.

  • ExcludeLoadControl. When set to true, data marked as load control is excluded from the calculation.

  • ExcludeLoadEvent. When set to true, data marked as load event is excluded from the calculation.

  • Metric. The meter validation parameter(s) to compute. Options are Max, Min, or Both

  • MinNumDays. The minimum number of days required to calculate validation parameters for a meter.

  • ResultMargin. Result margin to use in the meter validation calculation.

  • StandardDeviationMultiplier. Standard Deviation multiplier to use in the meter validation calculation.

Model. Model configuration.

  • ExcludeRegressionModelsFromScoring. If set to True, Regression models are excluded from Model scoring.

  • MaxCalibrationFactor. The maximum allowed calibration factor. If a computed calibration factor is greater than the provided value, it will be filled with the maximum allowed value. This value can be overridden for an individual model.
  • MinCalibrationFactor. The minimum allowed calibration factor. If a computed calibration factor is less than the provided value, it will be filled with the minimum allowed value. This value can be overridden for an individual model.

Portfolio. Retail Portfolio configuration.

  • PortfolioCalcEnabled. This setting is read only. If set to True, the calculation of Meter Group Portfolio data is enabled. Also, when set to True, the ContractStart and ContractStop fields are read only on the Meter List.
  • PortfolioForecastMonths. This setting is read only. When the PortfolioCalcEnabled setting is set to True, this setting specifies the maximum number of forecast months to compute portfolio data.

Publish. Publish Forecast configuration.

  • ExportOnPublish. If set to True, the forecast will export to the MetrixIDR staging tables as well as to the internal tables.
  • ExportPublishedinUTC. If set to True, the forecast will export in UTC.

Schedule. Schedule configuration.

  • DeleteExistingForecast. When set to True, when the ImportSchedFcstData task is executed, the entire existing Schedule forecast is deleted when a new forecast is imported.

System Settings. System Settings configuration.

  • EstimationTimeout. The timeout (in seconds) for model estimation.

Weather. Weather settings configuration.

  • CalculatedConceptStart. The minimum date to use for calculation of a computed weather concept. Applies when exporting data for the calculated weather concept to CSV or Excel.
  • DefaultCloudAlbedo. The default value of Cloud Albedo used in the calculation of cloud adjusted solar radiation. This value can be overridden at the Weather station level and in an individual Solar model.
  • FillActualWeatherWithForecast. If true, any gaps in the observed weather data is filled with the latest available forecast value for the station and concept.