Snapshot & RestorePoint
Tag: Snapshot / RestorePoint
These tags are self explanatory. They're used to create a Snapshot/RestorePoint and can be run in any module.
Tag Attributes
| Attributes | Attribute Values | Value Description | Comment |
|---|---|---|---|
| KeepAlive | TRUE / FALSE - defaults to FALSE | By default, the automation closes each window so that the script is executed without human intervention. If you wish to keep a window open, use this attribute. | N/A |
| FilePath | N/A | The path file is absolute or relative to current script file location (missing or wrong extension will be forced to valid one with a warning). Snapshot: .ytr_snap Restore Point: .ytr_rest | N/A |
| Password | N/A | Password (ASCII only) | N/A |
| IncludePermanentComments | TRUE / FALSE - defaults to FALSE | N/A | N/A |
| ShowInExplorer | TRUE / FALSE - defaults to FALSE | N/A | N/A |
Tag Attributes (specific to Snapshot)
| Attributes | Attribute Value | Value Description | Comment |
|---|---|---|---|
| Public | TRUE (public) / FALSE (restricted to tenant) - defaults to FALSE | N/A | N/A |
| IncludeHiddenColumns | TRUE / FALSE - defaults to FALSE | N/A | N/A |
| IncludeHiddenRows | TRUE / FALSE - defaults to FALSE | N/A | N/A |
Example Script
Snapshot
<Snapshot FilePath="snapshot1.ytr_snap" /> <!-- Tenant restricted snapshot without password -->
<Snapshot FilePath="snapshot2.ytr_snap" Password="P@ssword!" /> <!-- Tenant restricted snapshot with password -->
<Snapshot FilePath="snapshot3.ytr_snap" Password="P@ssword!" ShowInExplorer="TRUE" /> <!-- Tenant restricted snapshot with password shown in explorer after creation -->
<Snapshot FilePath="snapshot4.ytr_snap" Password="P@ssword!" ShowInExplorer="TRUE" Public="TRUE" /> <!-- Public snapshot with password shown in explorer after creation -->
XML
RestorePoint
<RestorePoint FilePath="restorepoint1.ytr_rest" /> <!-- Restore point without password -->
<RestorePoint FilePath="restorepoint2.ytr_rest" Password="P@ssword!" /> <!-- Restore point with password -->
<RestorePoint FilePath="restorepoint3.ytr_rest" Password="P@ssword!" ShowInExplorer="TRUE" /> <!-- Restore point with password shown in explorer after creation -->
XML