logging_xml » Revisions »
Differences
This shows you the differences between the selected revisions of the page.
| logging_xml 2017-11-01 | logging_xml 2024-12-02 (current) | ||
| Line 8: | Line 8: | ||
| The %%XML%% logging is useful e.g. to: | The %%XML%% logging is useful e.g. to: | ||
| - | * Find a list of files that were actually uploaded/downloaded, when transferring whole directory or files matching a mask; | + | * Find a list of files that were actually uploaded/downloaded, when transferring a whole directory or when transferring files matching a mask; |
| - | * Get directory listing; | + | * Get a directory listing; |
| * Record operations done during [[task_synchronize_full|synchronization]]. | * Record operations done during [[task_synchronize_full|synchronization]]. | ||
| Line 27: | Line 27: | ||
| </code> | </code> | ||
| - | The top level ''session'' tag represents one logical session, which may consist of several physical sessions, particularly when connection is lost. Attribute ''name'' refers to name of the logical session. Attribute ''start'' indicates time when the session was initiated·((All timestamps in the %%XML%% log have %%XML%% ''dateTime'' type, where only ''%%YYYY-MM-DD"T"HH:MM:SS.NNN"Z"%%'' syntax is used.)). | + | The top level ''session'' tag represents one logical session, which may consist of several physical sessions, particularly when connection is lost. Attribute ''name'' refers to name of the logical session. Attribute ''start'' indicates time when the session was initiated.((All timestamps in the %%XML%% log have %%XML%% ''dateTime'' type, where only ''%%YYYY-MM-DD"T"HH:MM:SS.NNN"Z"%%'' syntax is used.)) |
| The ''session'' element includes [[#elements|child elements]], where each element represents single log entry, i.e. single physical operation with remote file over the logical session. | The ''session'' element includes [[#elements|child elements]], where each element represents single log entry, i.e. single physical operation with remote file over the logical session. | ||
| Line 95: | Line 95: | ||
| <code xml> | <code xml> | ||
| - | <group name="put -preservetime d:\*.txt" start="2012-01-04T14:25:10.204Z"> | + | <group name="put -preservetime d:\*.txt" start="2021-12-03T14:25:10.204Z"> |
| <upload> | <upload> | ||
| <filename value="d:\readme.txt" /> | <filename value="d:\readme.txt" /> | ||
| <destination value="/home/user/readme.txt" /> | <destination value="/home/user/readme.txt" /> | ||
| + | <size value="15345" /> | ||
| <result success="true" /> | <result success="true" /> | ||
| </upload> | </upload> | ||
| Line 197: | Line 198: | ||
| Associated script commands: ''[[scriptcommand_chmod|chmod]]'', ''[[scriptcommand_keepuptodate|keepuptodate]] -permissions'', ''[[scriptcommand_put|put]] -permissions'', ''[[scriptcommand_synchronize|synchronize]] remote|both -permissions'' | Associated script commands: ''[[scriptcommand_chmod|chmod]]'', ''[[scriptcommand_keepuptodate|keepuptodate]] -permissions'', ''[[scriptcommand_put|put]] -permissions'', ''[[scriptcommand_synchronize|synchronize]] remote|both -permissions'' | ||
| + | |||
| + | ==== [[cp]] cp ==== | ||
| + | [[task_move_duplicate#duplicate|Duplication]] of one remote file or directory. | ||
| + | |||
| + | Elements: | ||
| + | ^ Element ^ Description ^ | ||
| + | | ''filename'' | Absolute path to source local file (in ''value'' attribute) | | ||
| + | | ''destination'' | Absolute path to destination remote file (in ''value'' attribute) | | ||
| + | |||
| + | Example: | ||
| + | <code xml> | ||
| + | <cp> | ||
| + | <filename value="/home/martin/public_html/about.html" /> | ||
| + | <destination value="/home/martin/backup/about.html.20171220" /> | ||
| + | <result success="true" /> | ||
| + | </cp> | ||
| + | </code> | ||
| + | |||
| + | Associated script commands: ''[[scriptcommand_cp|cp]]'' | ||
| ==== [[download]] download ==== | ==== [[download]] download ==== | ||
| Line 205: | Line 225: | ||
| | ''filename'' | Absolute path to source remote file (in ''value'' attribute) | | | ''filename'' | Absolute path to source remote file (in ''value'' attribute) | | ||
| | ''destination'' | Absolute path to destination local file (in ''value'' attribute)((File name may differ from name of source file.)) | | | ''destination'' | Absolute path to destination local file (in ''value'' attribute)((File name may differ from name of source file.)) | | ||
| + | | ''size'' | Number of bytes transferred. | | ||
| Example: | Example: | ||
| Line 211: | Line 232: | ||
| <filename value="/home/martin/public_html/about.html" /> | <filename value="/home/martin/public_html/about.html" /> | ||
| <destination value="d:\www\about.htm" /> | <destination value="d:\www\about.htm" /> | ||
| + | <size value="55387" /> | ||
| <result success="true" /> | <result success="true" /> | ||
| </download> | </download> | ||
| Line 291: | Line 313: | ||
| ==== [[mv]] mv ==== | ==== [[mv]] mv ==== | ||
| - | [[task_move_duplicate#move|Moving]] or of one remote file or directory to different remote directory or [[task_rename|renaming]] of one remote file or directory. | + | [[task_move_duplicate#move|Moving]] of one remote file or directory to different remote directory or [[task_rename|renaming]] of one remote file or directory. |
| Elements: | Elements: | ||
| Line 359: | Line 381: | ||
| | ''filename'' | Absolute path to source local file (in ''value'' attribute) | | | ''filename'' | Absolute path to source local file (in ''value'' attribute) | | ||
| | ''destination'' | Absolute path to destination remote file (in ''value'' attribute)((File name may differ from name of source file.)) | | | ''destination'' | Absolute path to destination remote file (in ''value'' attribute)((File name may differ from name of source file.)) | | ||
| + | | ''size'' | Number of bytes transferred. | | ||
| Example: | Example: | ||
| Line 365: | Line 388: | ||
| <filename value="d:\www\about.htm" /> | <filename value="d:\www\about.htm" /> | ||
| <destination value="/home/martin/public_html/about.html" /> | <destination value="/home/martin/public_html/about.html" /> | ||
| + | <size value="55387" /> | ||
| <result success="true" /> | <result success="true" /> | ||
| </upload> | </upload> | ||
| Line 400: | Line 424: | ||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| <session xmlns="http://winscp.net/schema/session/1.0" | <session xmlns="http://winscp.net/schema/session/1.0" | ||
| - | name="martin@example.com" start="2009-03-02T19:34:57.734Z"> | + | name="martin@example.com" start="2012-01-04T14:25:53.173Z"> |
| <group name="put -preservetime -permissions=644 d:\www\about.htm" start="2012-01-04T14:28:45.393Z"> | <group name="put -preservetime -permissions=644 d:\www\about.htm" start="2012-01-04T14:28:45.393Z"> | ||
| <upload> | <upload> | ||
| Line 446: | Line 470: | ||
| If you want to parse the XML log yourself anyway, see following guides to learn how to do that in different development environments: | If you want to parse the XML log yourself anyway, see following guides to learn how to do that in different development environments: | ||
| - | * [[guide_automation_advanced|Guide to advanced scripting]] (Windows script host; Java or VB script); | + | * [[guide_automation_advanced|*]] (Windows script host; Java or VB script); |
| - | * [[guide_dotnet|Guide for using WinSCP from .NET]] (.NET; C# or VB.NET); | + | * [[guide_dotnet|*]] (.NET; C# or VB.NET); |
| - | * [[guide_interpreting_xml_log|Guide to interpreting XML log for advanced scripting]] (.NET, C#). | + | * [[guide_interpreting_xml_log|*]] (.NET, C#). |
| ==== [[xslt]] Transforming XML Log to Text Output Using XSLT Transformation ==== | ==== [[xslt]] Transforming XML Log to Text Output Using XSLT Transformation ==== | ||
| Line 457: | Line 481: | ||
| <code xml> | <code xml> | ||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| - | <session xmlns="http://winscp.net/schema/session/1.0" name="user@host" start="2015-01-30T06:45:57.008Z"> | + | <session xmlns="http://winscp.net/schema/session/1.0" name="user@host" start="2021-12-03T06:45:57.008Z"> |
| <download> | <download> | ||
| <filename value="/path/file1.txt" /> | <filename value="/path/file1.txt" /> | ||
| <destination value="C:\path\file1.txt" /> | <destination value="C:\path\file1.txt" /> | ||
| + | <size value="2022" /> | ||
| <result success="true" /> | <result success="true" /> | ||
| </download> | </download> | ||
| Line 466: | Line 491: | ||
| <filename value="/path/file2.txt" /> | <filename value="/path/file2.txt" /> | ||
| <destination value="C:\path\file2.txt" /> | <destination value="C:\path\file2.txt" /> | ||
| + | <size value="5782" /> | ||
| <result success="true" /> | <result success="true" /> | ||
| </download> | </download> | ||
| Line 485: | Line 511: | ||
| </code> | </code> | ||
| - | You can execute it using any %%XSLT%% processor, e.g. ''[[https://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=21714|msxsl.exe]]'': | + | You can execute it using any %%XSLT%% processor: |
| - | <code> | + | * .NET [[dotnet>system.xml.xsl.xslcompiledtransform|''XslCompiledTransform'' class]], e.g. from PowerShell: \\ <code powershell> |
| - | msxsl.exe log.xml download.xsl | + | $xslt = New-Object System.Xml.Xsl.XslCompiledTransform |
| + | $xslt.Load("download.xslt") | ||
| + | $xslt.Transform("log.xml", "download.txt")</code> | ||
| + | * [[https://gitlab.gnome.org/GNOME/libxml2/-/wikis/home|Libxml2]] ''xsltproc.exe'': \\ <code> | ||
| + | xsltproc.exe download.xslt log.xml | ||
| </code> | </code> | ||
| Line 498: | Line 528: | ||
| </code> | </code> | ||
| - | For a more complex example, see [[script_custom_listing_format_csv#scripting|Custom directory listing format (CSV)]]. | + | For a more complex example, see [[script_custom_listing_format_csv#scripting|*]]. |