maeExportScenarioSetup

maeExportScenarioSetup(
t_reliabilityScenarioSetup
[ ?session t_sessionName ]
[ ?run t_runName ]
[ ?file t_fileName ]
[ ?allReadOnly g_allReadOnly ]
[ ?enabledReadOnly g_enabledReadOnly ]
)
=> t / nil

Description

Exports the details of the specified reliability scenario setup to a CSV file.

Arguments

t_reliabilityScenarioSetup
	Name of the reliability scenario setup whose details are to be exported to the CSV file.
?session t_sessionName
	Name of the session. If you do not specify this argument, the current session is used. To get a list of available maestro sessions, use the function maeGetSessions.
?run t_runName	Name of the run in a run plan. The default value is an empty string (""). This argument is useful only when the setup has a run plan.
?file t_fileName
	Name of the CSV file to which you want to export the details of reliability scenario setup. If you do not specify this argument, details of the reliability scenario setup are exported to the scenarioSetup.csv file in the current working directory. You can specify either the absolute path or the relative path to the CSV file in this argument. For example: "/home/user/ReliabilitySetup/test.csv" "./test.csv"
?allReadOnly g_allReadOnly
	Specifies whether to export all reliability scenario rows from the setup in read-only mode. Valid values are t and nil. The default value is nil. The arguments ?allReadOnly and ?enabledReadOnly are mutually exclusive. You cannot specify the value t for both the arguments, simultaneously.
?enabledReadOnly g_enabledReadOnly
	Specifies whether to export only enabled reliability scenario rows in read-only mode. Valid values are t and nil. The default value is nil. The arguments ?allReadOnly and ?enabledReadOnly are mutually exclusive. You cannot specify the value t simultaneously for both the arguments.

Value Returned

t	The details of the specified reliability scenario are successfully exported.
nil	The details of the specified reliability scenario cannot be exported because of an error.

Examples

The following example exports the details of the reliability scenario setup RelxScenario to the testCSV.csv file at the specified location.

maeExportScenarioSetup("RelxScenario" ?file "/home/user/ReliabilitySetup/testCSV.csv")

=> RelxScenario is exported to /home/user/ReliabilitySetup/testCSV.csv

=> t

The following example exports the details of the reliability scenario setup RelxScenario to the scenarioSetup.csv file in the current working directory.

maeExportScenarioSetup("RelxScenario")

=> RelxScenario is exported to ./scenarioSetup.csv

=> t

The following example exports the details of the reliability scenario setup RelxScenarios to the specified CSV file in the current working directory. All the reliability scenario rows from the Reliability Scenarios Setup form are exported in read-only mode to the CSV file.

maeExportScenarioSetup("RelxScenarios" ?file "./myExportedSetup" ?allReadOnly t)

=> RelxScenarios0 is exported as ./myExportedSetup

=> t

The following example exports the details of the reliability scenario setup RelxScenarios to the specified CSV file in the current working directory. Only the reliability scenario rows that are enabled in the Reliability Scenarios Setup form are exported in read-only mode to the CSV file.

maeExportScenarioSetup("RelxScenarios" ?file "./myExportedSetupReadOnly" ?enabledReadOnly t)

=> RelxScenarios0 is exported as ./myExportedSetupReadOnly

=> t

Return to top