Product Documentation
Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023

maeImportScenarioSetup

maeImportScenarioSetup(
t_reliabilityScenarioSetup
[ ?session t_sessionName ]
[ ?run t_runName ]
[ ?file t_fileName ]
[ ?operation t_typeOfOperation ]
)
=> t / nil

Description

Imports the details from the specified CSV file to the existing reliability scenario setup.

Arguments

t_reliabilityScenarioSetup

Name of the reliability scenario setup to which you want to import details from the CSV file.

If the specified reliability scenario setup does not exist in the Reliability Scenarios list in the Data View assistant, an error message is displayed in the CIW.

?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 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 from which you want to import the details to the existing reliability scenario setup.

If you do not specify this argument, details of the reliability scenario setup are imported from the scenarioSetup.csv file saved in the current working directory.

If the file scenarioSetup.csv does not exist in the current working directory, an error message is displayed in the CIW.

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"

?operation t_operationType

Type of operation to be performed.

Valid values are:

  • overwrite: Overwrites the details from the CSV file in the existing reliability scenario setup. This is the default value.
    All existing scenarios from the Reliability Scenarios Setup form are deleted and from the CSV file are added to the form.
  • merge: Merges the details from the CSV file in the existing reliability scenario setup.
    If a scenario name being imported from the CSV file already exists in the Reliability Scenarios Setup form, the existing scenario is deleted from the form, and its details are copied from the CSV to the form.
    When you specify this value:
    • Scenarios that exist only in the form, but not in CSV file, are kept as is.
    • Scenarios that exist only in the CSV file, but not in the form, are appended in the form.
  • retain: If a scenario name being imported from the CSV file already exists in the Reliability Scenarios Setup form, its import is discarded from the CSV file, and the existing scenario in the UI is retained as is.
    When you specify this value:
    • Scenarios that exist only in the Reliability Scenarios Setup form, but not in the CSV file being imported, are kept as is.
    • Scenarios that exist only in the CSV file, but not in the form, are appended.

Value Returned

t

The details from the CSV file are successfully imported to the reliability scenario setup.

nil

The details from the CSV file cannot be imported to the reliability scenario setup because of an error.

Examples

The following example imports the details of the reliability scenario setup from the testCSV.csv file to the existing reliability scenario setup RelxScenario.

maeImportScenarioSetup("RelxScenario" ?file "/home/user/ReliabilitySetup/testCSV.csv")
=> t

The following example merges the details of the reliability scenario setup from the scenarioSetup.csv file saved in the current working directory to the existing reliability scenario setup RelxScenario.

maeImportScenarioSetup("RelxScenario" ?operation "merge")
=> t


Return to top
 ⠀
X