Differences

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

--- common:volume_flags [2017/08/17 19:57] – [Flag Definitions] dcumming
+++ common:volume_flags [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== Overview ======
+====== Volume Flags ======
-Flags indicate the status of a Volume including its movements, Slot, location, Container, audits, and more.
+[[object:volume|Volume]] Flags represent one or more Boolean statuses of a single tape [[object:volume|Volume]].
+Depending on the respective Flag, the Flag may be automatically set, or may be set and unset by the user.
+These Flags can be used to filter tapes by status, for instance, scratch tapes, or encrypted tapes, may be used together to facilitate filtering on all scratch tapes, that are not encrypted.
-===== Flags =====
 {{:master:tapemaster_flags.png}}
-==== Flag Definitions ====
+===== Flag Definitions =====
+^ Flag Value  ^ Description                                                                                                                   ^ Settable  ^
+|  **A**      | (Depreciated function) [[object:volume|Volume]] has a Container Security Tag assigned.                                                                                 | No        |
+|  **a**      | [[object:volume|Volume]] has failed a Physical Audit or a Logical Audit (Set by Reconciliation).                                                | **Yes**   |
+|  **B**      | [[object:volume|Volume]] is a Container.                                                                                                        | No        |
+|  **C**      | [[object:volume|Volume]] is confirmed in its Current [[object:repository|Repository]].                                                                                | No        |
+|  **c**      | [[object:volume|Volume]] is part of a Consignment.                                                                                              | No        |
+|  **D**      | [[object:volume|Volume]] has a Move Date.                                                                                                       | No        |
+|  **d**      | [[object:volume|Volume]] Move Date is in the past.                                                                                              | No        |
+|  **E**      | [[object:volume|Volume]] is encrypted.                                                                                                          | **Yes**   |
+|  **F**      | [[object:volume|Volume]] has been set as a [[master:favorites_list|Favorite]]                                                                   | No        |
+|  **G**      | [[object:volume|Volume]] has missed a [[technote:reports|reporting]] deadline.                                                                                       | **Yes**   |
+|  **H**      | [[object:volume|Volume]] Move Date is a Holiday.                                                                                                | No        |
+|  **h**      | [[object:volume|Volume]] is hidden (ghosted).                                                                                                   | **Yes**   |
+|  **I**      | [[object:volume|Volume]] is moving internally (from one Slot to another in the same [[object:repository|Repository]]).                                                | No        |
+|  **K**      | [[object:volume|Volume]] has been Picked-Up.                                                                                                    | **Yes**   |
+|  **L**      | [[object:volume|Volume]] has an update lock and cannot be updated by anyone other than the [[common:tapemaster_user|tapemaster User]].          | **Yes**   |
+|  **l**      | [[object:volume|Volume]] has a move lock and cannot be moved.                                                                                   | **Yes**   |
+|  **M**      | [[object:volume|Volume]] is moving from one [[object:repository|Repository]] to another.                                                                              | No        |
+|  **m**      | [[object:volume|Volume]] has a Home Slot.                                                                                                       | No        |
+|  **N**      | [[object:volume|Volume]] has a Description.                                                                                                     | No        |
+|  **n**      | [[object:volume|Volume]] has no Slot assigned.                                                                                                  | No        |
+|  **O**      | [[object:volume|Volume]] is in the Primary Offsite [[object:repository|Repository]].                                                                                  | No        |
+|  **o**      | [[object:volume|Volume]] is overdue at its Target [[object:repository|Repository]].                                                                                   | No        |
+|  **p**      | [[object:volume|Volume]] has been set as Move Pending as its Move Date has been exceeded (Set by [[cli:TMSS10MovePending|TMSS10MovePending]]).  | **Yes**   |
+|  **Q**      | [[object:volume|Volume]] has been flagged as unhealthy by a VeriTape system.                                                                    | **Yes**   |
+|  **r**      | [[object:volume|Volume]] has been requested back from a Third-Party.                                                                            | **Yes**   |
+|  **S**      | [[object:volume|Volume]] always uses [[cookbook:simplemanagement|Simple Management]].                                                           | **Yes**   |
+|  **t**      | Do not assign a Slot to this [[object:volume|Volume]].                                                                                          | **Yes**   |
+|  **U**      | [[object:volume|Volume]] has been scanned out of the Current [[object:repository|Repository]] using either TapeTrack Lite or TapeTrack Check Point.                   | **Yes**   |
+|  **u**      | [[object:volume|Volume]] has been flagged as a duplicate.                                                                                       | **Yes**   |
+|  **W**      | [[object:volume|Volume]] has a warning (has moved back to its original [[object:repository|Repository]] without having been confirmed at it's Target [[object:repository|Repository]]).            | **Yes**   |
+|  **X**      | [[object:volume|Volume]] has been Audit-Scanned.                                                                                                | **Yes**   |
+|  **Z**      | [[object:volume|Volume]] is Scratch.                                                                                                            | **Yes**   |
+===== Using Flags =====
+TapeTrack uses many of the [[object:volume|Volume]] Flag internally to pass information from one program to another, but Flag can also be used to filter information for [[technote:reports|reporting]] purposes.
+==== Using Flags for Reporting ====
+[[object:volume|Volume]] Flag can be used for [[technote:reports|reporting]] purposes in both
+[[:#tapetrack-desktop-software|TapeTrack Windows Desktop Programs]] and [[cli:introduction|TapeTrack Command Line Programs]].
+For details on how to use the [[object:volume|Volume]] Flags in [[technote:reports|reporting]] see the [[common:volume_flag_filters|Volume Flag Filters]] section.
+==== Setting and Unsetting Flags ====
+Some [[object:volume|Volume]] Flag can be set and unset by performing operations on the respective [[object:volume|Volume]], for instance, when you move a [[object:volume|Volume]], the [[object:volume|Volume]] will get a move Flag, and when you confirm a [[object:volume|Volume]] the move Flag will be removed.
+Other Flag can only be set and unset by the user requesting that they change, and the remaining Flag are a hybrid that are set by an activity, and then unset manually.
-  * **A**: Volume has a Container Security Tag assigned.
+=== Changing Flags via the Command Line ===
-  * **a**: Volume has failed a Physical Audit or a Logical Audit (Set by Reconciliation).
-  * **B**: Volume is a Container.
-  * **C**: Volume is confirmed in its current Repository.
-  * **c**: Volume is part of a Consignment.
-  * **D**: Volume has a Move Date.
-  * **d**: Volume Move Date is in the past.
-  * **E**: Volume is encrypted.
-  * **F**: Volume has been set as a [[master:favorites_list|Favorite]]
-  * **G**: Volume has missed a reporting deadline.
-  * **H**: Volume Move Date is a Holiday.
-  * **h**: Volume is hidden (ghosted).
-  * **I**: Volume is moving internally (from one Slot to another in the same Repository).
-  * **K**: Volume has been Picked-Up.
-  * **L**: Volume has an update lock and cannot be updated by anyone other than the [[common:tapemaster_user|tapemaster User]].
-  * **l**: Volume has a move lock and cannot be moved.
-  * **M**: Volume is moving from one Repository to another.
-  * **m**: Volume has a Home Slot.
-  * **N**: Volume has a Description.
-  * **n**: Volume has no Slot assigned.
-  * **O**: Volume is in the Primary Offsite Repository.
-  * **o**: Volume is overdue at its Target Repository.
-  * **p**: Volume has been set as Move Pending as its Move Date has been exceeded (Set by [[cli:TMSS10MovePending|TMSS10MovePending]]).
-  * **Q**: Volume has been flagged as unhealthy by a VeriTape system.
-  * **r**: Volume has been requested back from a Third Party.
-  * **S**: Volume always uses Simple Management.
-  * **s**: Volume Move Date was last set by Simple Management.
-  * **t**: Do not assign a Slot to this Volume.
-  * **U**: Volume has been scanned out of the current Repository using either TapeTrack Lite or TapeTrack Check Point.
-  * **u**: Volume has been flagged as a duplicate.
-  * **W**: Volume has a warning (has moved back to its original Repository without having been confirmed at its destination).
-  * **X**: Volume has been Audit-Scanned.
-  * **Z**: Volume is Scatch.
-==== Setting and Managing Flags ====
-There are two ways to set flags:
+[[object:volume|Volume]] Flags are indirectly set by the following Command Line Programs:
-=== Method 1 ===
-Right-click the Volume/s in the Volume List, hover over Special Operations, then Modify and select Flags.
+^ Program            ^ Notes                                                                                  ^
+| [[cli:TMSS10ModifyFlags|TMSS10ModifyFlags]] | Sets and unsets Flags that can be modified without performing a corresponding action.  |
+| [[cli:TMSS10ExpireByDate|TMSS10ExpireByDate]] | Sets the Move Pending Flag.  |
-{{:master:tapemaster_flags_special.png}}
-For each flag in the Modify Flags window, there are three options:
+=== Changing Flags via the Desktop ===
-  * **Value**: Value can be set to one of four options:
-     - **Do not change**: Leaves the Flag as is.
-     - **Add Flag**: Adds the selected Flag to the selected Volume(s).
-     - **Remove Flag**: Removes the selected Flag from the selected Volume(s).
-     - **Toggle Flag**: Will add the selected flag if it is not present and remove it if it is.
-  * **Set Count**: When multiple Volumes are selected, the Set Count will display how many Volumes have that flag.
-  * **Not-Set Count**: When multiple Volumes are selected, the Not-Set Count will display how many Volumes do not have that flag.
-=== Method 2 ===
-Go to the ''Options Tab'' in the ''Volume Properties Window'', and toggle the flags section.
+A selection of [[#flag-definitions|Flags]] can be [[:master:set_volume_flags|applied to or removed from Volumes]] via the [[:master:inventory_right_menu|right-click inventory window menu]] in TapeMaster.
-Set the desired Tags to **True** to add them or **False** to deactivate them.
-{{image}}
-The Flags in the Options Tab are as follows:
-  * **Has Consignment %% (c) %%**: When **True**, the selected Volume is part of a Consignment.
+To remove a W Flag select that [[object:volume|Volume]] and press F2.
-  * **Has Description (N)**: When **True**, the selected Volume has a description.
-  * **Do Not Slot (t)**: When **True**, the selected Volume cannot be slotted.
-  * **Is a Container (B)**: When **True**, the selected Volume is a Container.
-  * **Movement Required (M)**: When **True**, the selected Volume is either Moving or needs to be Moved.
-  * **Hidden (h)**: When **True**, the selected Volume is hidden and cannot be viewed in the Volume List. Hidden Volumes can be seen by modifying options in the ''Preferences Window'' under the ''File Menu''.
-  * **Moving Internal (I)**: When **True**, the selected Volume is moving from one Slot to another in the same Repository.
-  * **Simple Management (S)**: When **True**, the selected Volume may only Move when a corresponding [[cookbook:simplemanagement|Simple Management Rule]] exists.
-  * **Move Pending (p)**: When "**True**, the selected Volume has been set in a Move Pending status by [[cli:TMSS10MovePending|TMSS10MovePending]] and has exceeded its Move Date.
-  * **Overdue (o)**: When **True**, the selected Volume is overdue at its Target Repository.
-  * **Next Move Date exceeded (p)**: When **True**, the selected Volume has exceeded its Move Date.
-  * **Has Tag (A)**: When **True**, the selected Volume is a Container and has a Security Tag assigned.
-  * **No Slot (n)**: When **True**, the selected Volume has no Slot assigned.
-  * **Move Lock (I)**: When **True**, the selected Volume is in a Move Lock and cannot be moved.
-  * **Update Lock (L)**: When **True**, the selected Volume has an Update Lock and can only be updated by a User with tapemaster Rights.
-  * **Off-site (O)**: When **True**, the selected Volume is at a Repository that is Offsite.
-  * **Move Date is a Holiday (H)**: When **True**, the selected Volume has a Move Date that is marked as a Holiday in the Server Administration Window under the Administration Menu.
-  * **Audit Failure (a)**: When **True**, the selected Volume has failed a physical audit with either TapeTrack Sync or another Reconciliation process.