You are here: Reference Manual > FME Server Console > Directives > Running Workspaces

Running Workspaces

"RUN_WORKSPACE <workspace file>" [options]

The FME Server Console is directed to run a workspace in synchronous (default) mode by specifying the name of the workspace file as an argument, in the following form:

<repositoryName>/<workspaceName>.fmw

The specified workspace must already exist in the specified FME Server repository. Specifying an absolute path to the workspace file is not supported.

Running workspaces in synchronous mode means that the command line prompt does not return until the FME Server finishes the job, at which time the translation results are printed to the screen.

For detailed information on the options, refer to Command Line Options.

Examples:

RUN_WORKSPACE Samples/parcels.fmw --SourceDataset_MIF
C:\MyData\parcels\*.mif -LOG_FILENAME C:\Logs\parcels.log TM_priority 50

ABORT_JOB "<jobID>" [options]

Removes a job from the Transformation Manager if processing has not started. If the FME Engine has started processing the job, the processing continues.

Running Workspace in Asynchronous Mode

"SUBMIT_JOB <workspace file>" [options]

Using this command is the same as using the RUN_WORKSPACE command.

Unlike the RUN_WORKSPACE command, which blocks the console until the job has finished, SUBMIT_JOB inserts the job into the Transformation Manager’s queue and returns a job ID to you immediately.

GET_JOB_STATUS "<jobID>" [options]

Returns the status of a job that was submitted to the Transformation Manager.

Running a Workspace From an External File

To run a workspace with parameters defined in an external file, use the XML_PARAMETER_FILE value:

run_workspace Samples/austinDownload.fmw -XML_PARAMETER_FILE C:\Temp\params.xml

Structure the XML file as follows:

<?xml version="1.0" encoding="utf-8"?>

<TRANSFORMATION_REQUEST>

<PUBLISHED_PARAMETER name="myParam1">value1</PUBLISHED_PARAMETER>

<PUBLISHED_PARAMETER name="myParam2">value2</PUBLISHED_PARAMETER>

<FME_DIRECTIVE name="fmeDirective">someValue</FME_DIRECTIVE>

</TRANSFORMATION_REQUEST>