Command Line Utility Guide

Command Line Utility Guide

runProject

runProject

Start an
Managed File Transfer
Project using the runProject command. The following table lists the available options when running a Project.
Example:
infamftcmd.bat -server http://10.1.4.1:8000/informaticamft -user Administrator -password Administrator -command runProject -project /Test
infamftcmd.bat -server http://10.1.4.1:8000/informaticamft -user Administrator -password Administrator -command runProject -project /Test -mode batch -jobQueue SFTP -jobName "Script Transfer" -priority 10 
-variables erroremail control@example.com loglocation /logs/errors/
Parameter Name
Description
Required?
Default Value
project
The Project location and Project name. Each Project name and location is proceeded with a forward slash as shown in the example.
Yes
None
mode
The mode in which to run a Project.
  • Batch mode immediately submits the project for execution regardless of other active jobs. The command screen will return "
    Project '[Project Name]' submitted for execution
    " indicating the job was successfully submitted.
  • Interactive mode waits for any previous jobs to finish and then executes the job. The command screen will return "
    Project '[Project Name]' finished with no Errors
    " indicating the job completed successfully.
No
interactive
jobName
Specify a name which identifies the Job. This name should be descriptive enough so Admin Users can quickly identify this Job from a report or list. The Job Name cannot exceed 50 characters. Spaces are allowed.
No
None
jobQueue
The Job Queue the Project is placed in when the Job is executed in batch mode. If a Job Queue is not specified in the runProject command, the Job is placed in the Job Queue specified on the Project's Control tab. If a Job Queue is not specified on the Project's Control tab, the Job is placed in the default Job Queue.
No
None
priority
The priority of CPU resource given to the Project. The priority is a value from 1 to 10 (highest)
No
5
variables
A list of variables the Project can use to override any variables specified in the Project. When using the variables option, use the following syntax: -variables <variable name> <override value>
For example, a variable named "erroremail" contains the value "admin@example.com," which is used to send an email to admin@example.com if the Project fails. However, if a Project fails and it was started using the runProject command, you may want email notification to go to "control@example.com." For this you would specify -variables erroremail control@example.com
No
None

0 COMMENTS

We’d like to hear from you!