Execution and Job Commands

This section describes the commands that you can use in interactive mode, on the command line, or in a script file. The commands in this section are used to control job execution and specify execution options.

Note: When using Isight without a results database, only the start and stop commands will work. The other commands in this group require a results database.

The following commands are available:

delete

Delete the specified jobs from the results database.

job:<job_ID> Specify the ID of the job to delete.

exportjob

Export the specified jobs from the results database to a local file.

job:<job_ID> Specify the ID of the job to export.
exfile:<filename.zrf> Specify the file to write the exported job to.
fileparam:<y|n> Specify y to export file parameters along with the job data; specify n to exclude the contents of file parameters.

exportjobtoacs

Export all jobs from the local database to the SIMULIA Execution Engine database.

includefile:<true|false> Specify whether or not you want to include file parameters.

importjob

Import the specified jobs into the results database.

importfile: <filename.zrf> Specify the file containing the job to import.

joblog

Display job log information. This command does not currently work for jobs run locally without a results database. Use the monitor:y option for the start command instead. You can use any of the job matching criteria arguments to select the jobs for which to retrieve logs. For more information, see Job Matching Criteria Arguments.

job:<job_ID> Specify the ID of the job for which to get the log.

jobreport (or jreport)

Generate a report for the given job name or job ID.

Note: You can use any of the job matching criteria arguments to select jobs to display. For more information, see Job Matching Criteria Arguments.

name: <report_name> Specify the name of the report. If no name is specified, the associated model name is used.
dir: <directory> Specify the directory where the report will be saved. If you do not specify a directory, the report is saved in your “home” directory, and the location is displayed.

jobstatus (or jstatus)

Display job information. You can use any of the job matching criteria arguments to select jobs to display. For more information, see Job Matching Criteria Arguments. If no arguments are given, all jobs are listed.

model

Get information about a model. The information includes the input parameters that can be set with the start input:<file_name> or start args:PARM=VALUE commands. You must specify either the name or file argument. Use the following sub-arguments to specify the model information:

name: <object_name> The fully qualified library name of the model. For example, com.myorg.mymodel.
version:<2.0> Select a specific version of a model from the SIMULIA Execution Engine library. The default is the latest version.
file: <file_name> The name of the model you want to view information about.
output: <file_name> Write the model inputs to a file in exactly the format used by the start input:<file_name> command option. When this option is specified, the model information is not displayed at the terminal.

modelreport (or mreport)

Generate a report for the given model (.zmf) file.

file:<filename> Specify the name of the model file on which to report.
name: <report_name> Specify the name of the report. If no name is specified, the model name is used.
dir:<directory> Specify the directory where the report will be saved. If you do not specify a directory, the report is saved in your “home” directory, and the location is displayed.
format: <html|text|word> Select the format in which you want the report generated. The default is HTML. HTML and Word reports include extra information not included in the Text format.

monitor

Monitor a job while it executes. This allows you to connect to a currently running job on the SIMULIA Execution Engine or a local job started with start wait:n. This command does nothing if the job has already finished.

job:<job_ID> Specify the ID of the job to monitor.

pause

Pause one or more running jobs. This command does nothing if the job has already finished. You can use any of the job matching criteria arguments to select the jobs to pause. For more information, see Job Matching Criteria Arguments.

job:<job_ID> Specify the ID of the job to pause.

results

Save job results to your local hard disk. If the job has not finished when the results command is submitted, the command will register a request to save the results when the job does finish. The Command Line Client will delay exiting until all delayed requests to save results have finished. You can cancel a save request by typing CTRL-C.

job:<job_ID_number> Specify one or more jobs using their ID numbers. You can use any of the job matching criteria arguments to select the jobs to save. For more information, see Job Matching Criteria Arguments.
dir: <directory_name> Specify which directory will hold the results. If this option is omitted, the results are saved to your home directory.
resfiles:<y> Include file parameters in the files written by the results command. The contents of the file are copied into a subdirectory of the output directory, and the path to the file is included in the CSV or Name-Value file.

resume

Resume one or more paused jobs. You can use any of the job matching criteria arguments to select the jobs to resume. For more information, see Job Matching Criteria Arguments.

start

Initiate model execution. The start command runs the models on the SIMULIA Execution Engine if you log on to a SIMULIA Execution Engine. If you log on in standalone Isight mode, the models run locally.

The following sub-arguments can be used with this argument. (The file or name argument must be used with this command. You cannot specify both; only one model can be run at a time.)

acl: <TERM,...,TERM>

In SIMULIA Execution Engine environments, specify the access control list (permission information) for the model results. Each TERM is made up of the following three parts: NAME, PERMISSION, and CATEGORY. These parts are described below:

  • NAME: The name string of the permission. Can be set to “*” to mean “any user.”
  • PERMISSION: Can be set to AL (alter), MO (modify), RE (read), RF (reference), or NO (none).
  • CATEGORY: Can be set to U (user) or G (Group)
args: <parameter_name=parameter_value>;[root.child]; <parameter_name= parameter_value> ... Specify new values for input parameters on the command line. If any parameter name or value contains spaces, enclose everything after the first colon in double quotation marks.

Each parameter assignment is applied to the parameters of the root component of the model by default. Any expression of the form [root.child] (or [root.child1.child2], etc.) denotes a component-name path from the model root to some child component. When such an expression appears, all assignments that follow it are applied to the parameters of that child component. You must type the component path in square brackets.

The model to be run may contain Input or In/Out parameters that have no default value and are not overridden by mappings (e.g., in the root component). In this case you must provide values for these parameters in this command-line argument or in the input:<file_name> sub-argument, in any combination. For more details about parameters with no default value, see Setting Parameter Preferences.
desc: <description> Set the name of the job.
dir: <directory_name> Specify which directory will hold the results. It should be used in conjunction with the results option. This argument implies the results:yes option.
export:<y|n> Export a job once it finishes executing.
exfile: <directory_name> Specify the directory where the exported job is stored. Your current working directory is used by default.
file: <path_and_name_of_file> Load and execute a model from your local hard disk.
fileparam: <y|n> Specify if you want file parameters exported with your job when using the export command. The default setting is n.
input: <file_name> Specify a name/value file that contains new values for input parameters. The basic format for this file is shown below:
# A Comment
PARAMETER NAME = 99.333
STRING PARM = "para one"
ARRAY[0] = 1.0
ARRAY[1] = 2.0

Note: You can omit the equals sign if parameter names contain only letters and digits (e.g., X 5).The assignments are applied to the parameters of the root component by default. The file can also contain lines of the form [root.child] (or [root.child1.child2], etc.). Each line denotes the component-name path from the root to a child component. When present, all assignments following such expressions are applied instead to the named child component, up to the next such expression (or end-of-file). You must type the component path in square brackets.

The model to be run may contain Input or In/Out parameters that have no default value and are not overridden by mappings (e.g., in the root component). In this case you must provide values for these parameters in this command-line argument or in the input:<file_name> sub-argument, in any combination. For more details about parameters with no default value, see Setting Parameter Preferences.
joblog:<debug|info|warn|error|syserror> Set the log level for the job. The default level is determined by the current setting in the Design Gateway’s preference file.
monitor:<y|n> Monitor the execution of a submitted model. The log file of the execution and job events are displayed at the command prompt while the job runs
name:<model_name> Load and execute a model that resides in the library. The library is the one corresponding to the logon selected after executing this command (or specified using other command line arguments).
nowait:<y> Do not wait for the job to finish. In interactive mode, you get a new command prompt immediately and can continue to work while the job runs. In command-line mode, when connected to a SIMULIA Execution Engine, fipercmd will exit immediately while the job runs on the SIMULIA Execution Engine. When not connected to the SIMULIA Execution Engine, fipercmd will wait until the job finishes before exiting because the job actually runs inside the fipercmd process. The results of the job can be retrieved later with the results command.

Note: This is the same as the wait: option except reversed. For example, nowait:y is the same as wait:n.
output:<file_name> Save the results of the run to a file. All input and output parameters of the top-level component are written to the file in name/value format, plus comments indicating when the job was run. You may specify both print:y and output:<file_name> for the same run. File parameters will be saved to the same directory as the output file. They will be saved with the local name associated with the file parameter in the root component of the model.
print:<y> Print the results of the run to the terminal. All input and output parameters of the top-level component of the model are printed in the same name/value format used by the input command.
resfiles:<y> Include file parameters in the files written by the results:y command. The contents of the file are copied into a subdirectory of the output directory, and the path to the file is included in the CSV or Name/Value file.
results:<y|n> Save all job results to your local hard disk as a series of comma-separated values (CSV) files, with one file for each component in the model. If you do not specify a directory with the dir:path option, your results are saved in your default user directory, and you are notified of the location. The results for each job will be saved in a subdirectory of this directory named with the job name (and a unique number if several jobs have the same name).
startdelay:<nmin> When launching a job on a SIMULIA Execution Engine, create the job now but start running the job only after the given number of minutes has passed. The startdelay <nmin> can be formatted as mm, hh:mm, or ddd:hh:mm, where ddd, hh, and mm are whole numbers representing the number of days, hours, and minutes (assuming a 24-hour clock), respectively. If a delay time of zero is entered, the job will start immediately. This argument cannot be used with the starttime: argument within a single start command, and it is not valid in standalone mode.
starttime:<date> When launching a job on a SIMULIA Execution Engine, create the job now but start running the job only when the given date and time has been reached. The starttime <date> can be formatted as MM/dd/yy, MM/dd/yy@hh:mm, or MM/dd/yy@hh:mm(AM|PM), where MM, dd, and yy represent the month, day of month, and last two digits of the year, and hh and mm represent the time of day in hours and minutes, assuming a 24-hour clock unless AM or PM is added after the hh:mm. If a date and time earlier than the current date and time are entered, the job will start immediately. This argument cannot be used with the startdelay: argument within a single start command, and it is not valid in standalone mode.
version:<model_version> Specify the version of the model you are opening with the name argument. The default value is latest.
wait:<n> Do not wait for the job to finish. In interactive mode, you get a new command prompt immediately and can continue to work while the job runs. In command-line mode, when connected to a SIMULIA Execution Engine, fipercmd will exit immediately while the job runs on the SIMULIA Execution Engine. When not connected to the SIMULIA Execution Engine, fipercmd will wait until the job finishes before exiting because the job actually runs inside the fipercmd process. The results of the job can be retrieved later with the results command.

stop

Stop (cancel) running jobs. You can use any of the job matching criteria arguments to select the jobs to cancel. For more information, see Job Matching Criteria Arguments.

job:<job_ID> Specify the ID of the job to stop.