Description:
Activates result collection and optionally records the results. A non-empty FileNamePrefix attribute causes a CSV file to be generated. The file is updated every Interval seconds with the latest results.
Can be used with Command Sequencer: No
Parents: Project, Sequencer, StcSystem
| Attribute | Description | ||||||
|---|---|---|---|---|---|---|---|
| Common Writable Attributes | ProgressCancelled | ||||||
| ConfigType |
Configuration object under which you want the results. Type: string Default: "" (empty string) |
||||||
| DisablePaging |
Whether to Disable Paging. Type: bool Default: TRUE Possible Values:
|
||||||
| FileNamePrefix |
First (filename) part of the output filename. Use the OutputFormat attribute to configure the filename extension. An empty filename disables CSV output, so that only the data model is updated. Type: string Default: "" (empty string) |
||||||
| FilterList |
Filtering Object Handle List. Type: handle Default: 0 |
||||||
| Interval |
Number of seconds between updates to the CSV file. At each update to the CSV file, the latest values from the ResultType objects are written to the file. Type: u32 Default: 1 |
||||||
| OutputChildren |
Output children if any. Type: bool Default: FALSE Possible Values:
|
||||||
| OutputFormat |
Filename extension of the output filename. Type: string Default: csv |
||||||
| Parent |
This must be the handle of the Project object. Type: handle Default: 0 |
||||||
| RecordsPerPage |
Number of Records per Page. Type: u16 Default: 100 |
||||||
| ResultParent |
Object in the configuration under which you want results. If you want results for every port, use the Project object. If you want results for just specific ports, use the port handles. Type: handle Default: 0 |
||||||
| ResultType |
Results object type to use. There are many of these to choose from. Some examples: AnalyzerPortResults, PppoeSessionResults, Ospfv2RouterResults. Type: string Default: "" (empty string) |
||||||
| ViewAttributeList |
A list of attributes in the results object. You can use this to choose just the attributes you are interested in. An empty string, the default, means all attributes. Attributes that are not in this list will not be updated and will always be zero in the data model. Only the ones specified with this attribute will be written to the CSV file. You specify the results object with the ResultType attribute. See the documentation for your chosen results object to learn the attributes it contains. Type: string Default: "" (empty string) |
||||||
| ViewName |
To be implemented. Type: string Default: "" (empty string) |
| Read-Only Attribute | Description |
|---|---|
| Common Read-Only Attributes | ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status |
| ReturnedDataSet |
Returned ResultDataSet Handle. Type: handle Default: 0 |
| ReturnedResultDataSet |
NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it. Handle of the new ResultDataSet object on success. Type: string Default: "" (empty string) |