Integration (File-Based)

Task Name

Description

Argument Template

DownloadFiles

Download files from a remote server or path. Takes an import id string as a required argument. This identifier is configured using MetrixIDR Server Manager.

<args>

<arg name="ImportID" value="{ID}" />

</args>

ImportTask

Executes a configured Import Task. This command takes a path to an Import Spec file and an event category as required arguments. See the MetrixIDR documentation for details on creating an Import Spec file.

<args>

<arg name="xmlConfigPath" value="{path}"/>

<arg name="EventCategory" value="{importask}"/>

</args>

ExportTask

Executes a configured Export Task. This command takes a path to an Export Spec file and an event category as required arguments. See the MetrixIDR documentation for details on creating an Export Spec file.

<args>

<arg name="xmlConfigPath" value="{path}"/>

<arg name="EventCategory" value="{exportask}"/>

</args>

ExportAllForecast ToXML

Exports the forecast for all active Schedules to the default export folder (specified in the System Settings dialog).

<args>

<arg name="Comment" value="AutoPublish" />

<arg name="shiftIntervals" value="0" type="System.Int32" />

<arg name="exportInUTC" value="False" type="System.Boolean" />

</args>

ExportForecastsToXML

Exports the forecasts for a subset of active Schedules to the default export folder (specified in the System Settings dialog). Takes a filter string e.g. CUSTOM1=’Group1’ as a required argument.

<args>

<arg name="FilterString" value="{filterstring}" />

<arg name="Comment" value="AutoPublish" />

<arg name="shiftIntervals" value="0" type="System.Int32" />

<arg name="exportInUTC" value="False" type="System.Boolean" />

</args>

ExportAllForecasts ToXMLWithEditWindow

Exports the forecast for all active Schedules to the default export folder (specified in the System Settings dialog) using the edit window associated with the specified Action Role. Takes an Action as a required argument.

<args>

<arg name="ActionRole" value="{ActionRole}" />

<arg name="Comment" value="AutoPublish" />

<arg name="shiftIntervals" value="0" type="System.Int32" />

<arg name="exportInUTC" value="False" type="System.Boolean" />

</args>

ExportForecastsToXMLWithEditWindow

Exports the forecasts for a subset of active Schedules to the default export folder (specified in the System Settings dialog) using the edit window associated with the associated with the specified Action Role. Takes a filter string e.g. CUSTOM1=’Group1’ and an Action Role as required arguments.

<args>

<arg name="FilterString" value="{filterstring}" />

<arg name="ActionRole" value="{ActionRole}" />

<arg name="Comment" value="AutoPublish" />

<arg name="shiftIntervals" value="0" type="System.Int32" />

<arg name="exportInUTC" value="False" type="System.Boolean" />

</args>

UploadFiles

Upload files to a remote server or path. Takes an export id string as a required argument. This identifier is configured using MetrixIDR Server Manager.

<args>

<arg name="ExportID" value="{ID}" />

</args>

GenerateForecasts NoDependents

Generate a System Forecast for a subset of active Models, Portfolio Items, Five Minute Models, and Schedules. Takes a filter string, e.g. CUSTOM1=''Group 1'' as a required argument. Does not generate forecasts for any antecedent or dependent items.

<args>

<arg name="FilterString" value="{filterstring}" />

<arg name="WarnNoModels" value="True" type="System.Boolean" />

<arg name="WarnNoPortfolios" value="True" type="System.Boolean" />

<arg name="WarnNoFiveMinModels" value="True" type="System.Boolean" />

<arg name="WarnNoSchedules" value="True" type="System.Boolean" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>