Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:other_commands:add_password_protection_to_folder [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:other_commands:add_password_protection_to_folder [2026/09/10 17:59] (current) – Brought up to pipeline command template standard. richard
@@ Line 1: / Line 1: @@
-encrypt a folder with password protection.
+====== Add Password Protection To Folder ======
-often used with [[visual3d:documentation:visual3d_signal_types:text_data_type|text_data]]
+The Add_Password_Protection_To_Folder command allows users to encrypt folders in the [[visual3d:documentation:visual3d_signal_types:data_tree|data tree]] with password protection.
-add_password_protection_to_folder
+**NOTE 1**: We strongly recommend that users DO NOT store data in their workspace that requires encryption, but some organizational policies require certain [[Visual3D:Documentation:Visual3D_Signal_Types:TEXT_Data_Type|TEXT_DATA]] fields to be encrypted.
-/signal_types=
-/signal_folder=original
-/password=
-//;//
+**NOTE 2**: There is no mechanism for recovering forgotten passwords. If the password used to encrypt a folder is lost then that data will no longer be readable.
+===== Pipeline Command =====
+The Add_Password_Protection_To_Folder command can be found in the pipeline workshop's Folder Encryption folder.
+<code>
+Add_Password_Protection_To_Folder
+/SIGNAL_TYPES=
+/SIGNAL_FOLDER=ORIGINAL
+/Password=
+;
+</code>
+===== Command Parameters =====
+^ Parameter ^ Description ^
+| Signal Types | The [[visual3d:documentation:pipeline:general_information:signal_types|type of signal]] whose folder will be encrypted. |
+| Signal Folder | The [[visual3d:documentation:pipeline:general_information:signal_folder|signal folder]] to be encrypted. |
+| Password | The password to be used. **NOTE**: Lost passwords cannot be recovered. |
+===== Notes =====
+**NOTE 1**: We strongly recommend that users DO NOT store data in their workspace that requires encryption.
+**NOTE 2**: There is no mechanism for recovering forgotten passwords. If the password used to encrypt a folder is lost then that data will no longer be readable.
+===== See Also =====
+Related pipeline commands include:
+  * [[visual3d:documentation:pipeline:other_commands:remove_password_protection_from_folder|Remove_Password_Protection_From_Folder]]
+  * [[visual3d:documentation:pipeline:file_commands:enter_password_to_view_folder_data|Enter_Password_To_View_Folder]]