Run a Transaction script from the command line
When you run a Transaction script from the command line, you can pass Transaction script commands as parameters.
Note: To ensure that the log messages are saved, set the Excel save option to Save at end of run.
You can run a Transaction script from the command line using this syntax:
"Winshuttle.Studio.Console.exe full path" -SapTransaction -run"<Transaction script name with full path>" [parameters - optional]
Note: This command requires "Winshuttle.Studio.Console.exe full path" to be enclosed in double quotes. In addition, ensure that there is a single space between "Transaction.exe full path" and "Transaction script name with full path".
When you enter Transaction Script commands, separate each command using a space as the delimiter. The order in which you include these commands is not significant. If the Transaction Script command you specified does not exist in the Transaction script you are using, the command is added at run-time.
Example:
"C:\Program Files\Winshuttle\Studio\Winshuttle.Studio.Console.exe" -SapTransaction -run"C:\MyDocuments\Winshuttle\Studio\Script\Sample.TxR" -dsr"4" -der"6"
In this example, Transaction runs, opens Sample.TxR, reads the file, and then replaces or adds these commands to the file:
- -dsr starts from row 4 (ignores the Start Row value specified on the Studio Run tab).
- -der stops the run after three transactions (ignores the End Row value specified on the Studio Run tab).
Transaction runs the recording, using the parameters that are in the command line. All commands that run at the command prompt take precedence over the same commands that are already contained in the Transaction script file.
You can test this command line operation by running this command in the Windows Run dialog box.
Note: For best results, test these commands in a nonproduction system with a limited number of transactions before you run the Transaction script from the command line.
Command reference
|
Parameter |
Description |
Example |
| -drs | Set the run sheet |
-drs"SheetName" |
|
-alf |
Name of the auto logon credential |
-alf"W6r-someone-800" |
|
-arf |
Attach the data file with the posting results |
-arf"true" |
|
-dsw |
Disable the production server warning |
-dsw"true" |
|
-rfn |
Result file name |
-rfn"C:\Users\centraluser\Desktop\MM02.xlsx |
|
-eml |
Send notification email on schedule confirmation |
-eml"someone@winshuttle.com,someone@example.com" |
|
-irr |
If run reason is required or not |
-irr"true" |
|
-rsn |
Run reason |
-rsn"This is a demo run" |
|
-mod |
Recording mode for the script |
-mod"0" (0 = Batch, 1 = Non-Batch without controls, 2 = Non-Batch with controls, 3 = GUI Scripting) |
|
-dsr |
Start Row |
-dsr"5" |
|
-der |
End Row |
-der"10" |
| -wel | Write extended log | -wel"true" |