Processes - Start
Declaration
<AMPROCESSES ACTIVITY="create" DOMAINNAME="text" REMOTEMACHINE="text" USERNAME="text" PASSWORD="encrypted text" PRIORITY="options" EXECUTABLE="text" WORKINGDIR="text" ARGUMENTS="text" RESULTPID="Text" />
Description: Starts an instance of the specified process and optionally, populates a variable with the process identifier. This activity supports starting local or remote processes.
Practical Usage
Used to start a process on the local machine or on a remote computer.
Process Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Executable |
Text |
Yes |
(Empty) |
EXECUTABLE="c:\folder\theprocess.exe" |
The path and file name to the executable (.EXE) file linked to the process in which to start. Press the folder icon to open an Explorer dialog to navigate to the specified executable file or enter the path and file name manually in the provided text-box. |
Working Folder |
Text |
No |
(Empty) |
WORKINGDIR="c:\foldername\" |
The initial directory for the process to be started. This value is normally populated upon entry of a value under the Executable parameter. This option is provided primarily for shells that must start an application and specify the application's initial drive and working directory. In most cases, no modifications are needed for this parameter. |
Arguments |
Text |
No |
(Empty) |
ARGUMENTS="text" |
Specifies command-line options that are passed to the process to start. |
Set process priority to |
Text (options) |
No |
Normal |
PRIORITY="High" |
The priority level to set for the process to start. The available options are:
|
Store process identifier in variable |
Text |
No |
(Empty) |
RESULTPID="Text" |
The name of the variable in which to populate with the unique process identifier. Note that the process identifier is valid from the time the process is created until the time the process is terminated. |
Computer Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Local computer |
|
|
|
|
If enabled, specifies that the process to start resides on the local machine. This parameter is enabled by default. If this parameter is selected, the Another computer parameter becomes inactive. This is a visual mode parameter used during design time only, therefore, it contains no markups. |
Another computer |
|
|
|
|
If enabled, specifies that the process to start resides on a remote machine. The parameters below become active if this parameter is enabled. This is a visual mode parameter used during design time only. Therefore, it contains no markups. |
Computer |
Text |
Yes |
(Empty) |
|
The host name or IP address of the remote machine where the process to start resides. This parameter is available only if the Another Computer parameter is enabled. |
Domain |
Text |
Yes |
(Empty) |
DOMAINNAME="netauto" |
The domain name of the remote machine where the process to start resides. This parameter is available only if the Another Computer parameter is enabled. |
Username |
Text |
Yes |
(Empty) |
USERNAME="Bruce.Wayne" |
A valid username used to log onto the remote machine in which the process to start resides. This parameter is available only if the Another Computer parameter is enabled. |
Password |
Text |
Yes |
(Empty) |
PASSWORD="encrypted" |
The password corresponding to the username entered in the Username field. This parameter is available only if the Another Computer parameter is enabled. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Start local process "C:\Program Files (x86)\Adobe\Adobe Photoshop CS3\Photoshop.exe". Store process identifier in variable named "TheProcess".
<AMPROCESSES ACTIVITY="create" PRIORITY="abovenormal" EXECUTABLE="C:\Program Files (x86)\Adobe\Adobe Photoshop CS3\Photoshop.exe" WORKINGDIR="C:\Program Files (x86)\Adobe\Adobe Photoshop CS3" RESULTPID="TheProcess" />