Differences
This shows you the differences between the selected revisions of the page.
| faq_script_vs_gui 2020-04-30 | faq_script_vs_gui 2024-09-18 (current) | ||
| Line 2: | Line 2: | ||
| ===== [[common]] Common Problems ===== | ===== [[common]] Common Problems ===== | ||
| - | There are two common reasons why a script does not work, when a connectivity is otherwise possible: | + | There are three common reasons why a script does not work, when a connectivity is otherwise possible |
| - | * You run script from a different environment (under a different account/service; with a different configuration) than the GUI. \\ See another FAQ: [[faq_scheduler|My script works fine when executed manually, but fails or hangs when run by Windows Scheduler, SSIS or other automation service. What am I doing wrong?]] ((Although it covers a different topic, its recommendations are valid for this case as well.)) | + | ==== Environment ==== |
| - | * You have your [[session_configuration|session configured]] differently in the script and in the %%GUI%%. | + | You run script from a different environment (under a different account/service; with a different configuration) than the GUI. |
| - | * Use a [[ui_generateurl|Generate Session URL/Code]] command to avoid common mistakes in manually typed URL's or code; and to make sure all the settings from your GUI configuration is used in the script. \\ A common problem is [[session_url#special|special characters]] in some part of the [[session_url|session URL]] (typically a password or a username). | + | |
| - | * Passphrase to an SSH private key is not a password, you need to specify it using ''[[scriptcommand_open|-passphrase]]'' switch, not in a password part of the session %%URL%%. | + | |
| - | * With [[webdav|WebDAV]] and [[s3|S3]] protocols, it is possible that [[faq_root_path|you do not have an access to the root folder (bucket list in S3)]]. | + | |
| - | ===== Logging ===== | + | See another FAQ: [[faq_scheduler|*]] (Although it covers a different topic, its recommendations are valid for this case as well). |
| + | |||
| + | ==== [[configuration]] Configuration === | ||
| + | |||
| + | You have your [[session_configuration|session configured]] differently in the script and in the %%GUI%%. | ||
| + | * Use a [[ui_generateurl|Generate Session URL/Code]] command to avoid common mistakes in manually typed URL's or code; and to make sure all the settings from your GUI configuration is used in the script. \\ A common problem is [[session_url#special|special characters]] in some part of the [[session_url|session URL]] (typically a password or a username). \\ Further, some characters have special meaning in string literals in programming languages. If your password (or other credential) contains such special character, it needs to be escaped using the rules of the language. Notably in PowerShell, a dollar sign has special meaning in double-quoted string. Code generated by WinSCP escapes these too. | ||
| + | * Passphrase to an SSH private key is not a password, you need to specify it using ''[[scriptcommand_open|-passphrase]]'' switch, not in a password part of the session %%URL%%. | ||
| + | * With [[webdav|WebDAV]] and [[s3|S3]] protocols, it is possible that [[faq_root_path|you do not have an access to the root folder (bucket list in S3)]]. | ||
| + | |||
| + | ==== [[paths]] Paths ==== | ||
| + | |||
| + | You use different paths in the script than in the GUI. | ||
| + | * Always make sure you that use the //exact// paths that you see on the label above the [[ui_file_panel|file panel]] in the GUI. Use //Copy Path to Clipboard// command to avoid typing errors. | ||
| + | * Common mistake is using paths that are relative to the home folder as absolute paths. For example, when there's ''data'' folder in your ''/home/user'' folder, you cannot refer to the folder as ''/data''. Either use an absolute path ''/home/user/data'' (recommended) or relative path ''data''. | ||
| + | * Remote paths are case sensitive. So ''Data'' is not the same as ''data''. | ||
| + | |||
| + | ==== [[inputs]] Source and Destination Inputs ==== | ||
| + | |||
| + | Commands in scripting (like [[scriptcommand_put|''put'']] and [[scriptcommand_get|''get'']]) and some methods in .NET assembly (like [[library_session_getfiles|''Session.GetFiles'']] and [[library_session_putfiles|''Session.PutFiles'']]) do not take mere paths as inputs. The source input is expected to be a path terminated by a slash (a backslash when uploading) and followed by a [[file_mask|file mask]]. Similarly the destination input is expected to be a path also terminated by a slash (a backslash when downloading) followed by an optional [[operation_mask|operation mask]]. As a simple example, a command to upload all files in scripting should be like: | ||
| + | <code winscp> | ||
| + | put C:\source\path\* /destination/path/ | ||
| + | </code> | ||
| + | Similarly in .NET assembly: | ||
| + | <code csharp> | ||
| + | $session.PutFiles("C:\source\path\*", "/destination/path/").Check() | ||
| + | </code> | ||
| + | The trailing ''\*'' in the source path and the ''/'' in the destination path both matter. Read documentation of respective scripting commands or .NET assembly methods for details. In .NET assembly, in many cases, it's easier to use more specific methods like [[library_session_putfiletodirectory|''Session.PutFileToDirectory'']], [[library_session_putfilestodirectory|''Session.PutFilesToDirectory'']],[[library_session_getfiletodirectory|''Session.GetFileToDirectory'']] or [[library_session_getfilestodirectory|''Session.GetFilesToDirectory'']], as they do not have that strict interpretation of the inputs. | ||
| + | |||
| + | ===== [[logging]] Logging ===== | ||
| You can also enable a [[logging|session logging]] both in the %%GUI%% (on //[[ui_pref_logging|Logging page]]// of Preferences dialog) and the script (using a command-line parameter ''[[commandline#logging|/log]]'') and compare the logs to find out what is different. Use a command-line parameter ''[[commandline#logging|/loglevel=*]]'' to enable a password logging and check if a correct password is used. | You can also enable a [[logging|session logging]] both in the %%GUI%% (on //[[ui_pref_logging|Logging page]]// of Preferences dialog) and the script (using a command-line parameter ''[[commandline#logging|/log]]'') and compare the logs to find out what is different. Use a command-line parameter ''[[commandline#logging|/loglevel=*]]'' to enable a password logging and check if a correct password is used. | ||
| Line 16: | Line 41: | ||
| ===== Further Reading ==== | ===== Further Reading ==== | ||
| - | * More generic article on [[faq_environment|making WinSCP work in a new environment (operating system, machine, user account, network)]]. | + | * More generic article [[faq_environment|*]]. |
| - | * [[guide_debugging_scheduler|Debugging transfer task running in Windows Scheduler, SSIS or other automation service]]. | + | * [[troubleshooting#scripting|Troubleshooting scripting/automation issues]] |
| + | * [[guide_debugging_scheduler|*]]. | ||