Differences

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

--- common:volume_flags [2017/08/25 20:54] – [Overview] Gerard Nicol
+++ common:volume_flags [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== Overview ======
+====== Volume Flags ======
-Volume Flags represent one or more Boolean statuses of a single tape volume.
+[[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.
+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, or may be used together to facilitate filtering on all scratch tapes, that are not encrypted.
+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.
@@ Line 12: / Line 12: @@
 ===== Flag Definitions =====
 ^ Flag Value  ^ Description                                                                                                                   ^ Settable  ^
-|  **A**      | Volume has a Container Security Tag assigned.                                                                                 | No        |
+|  **A**      | (Depreciated function) [[object:volume|Volume]] has a Container Security Tag assigned.                                                                                 | No        |
-|  **a**      | Volume has failed a Physical Audit or a Logical Audit (Set by Reconciliation).                                                | Yes       |
+|  **a**      | [[object:volume|Volume]] has failed a Physical Audit or a Logical Audit (Set by Reconciliation).                                                | **Yes**   |
-|  **B**      | Volume is a Container.                                                                                                        | No        |
+|  **B**      | [[object:volume|Volume]] is a Container.                                                                                                        | No        |
-|  **C**      | Volume is confirmed in its current Repository.                                                                                | No        |
+|  **C**      | [[object:volume|Volume]] is confirmed in its Current [[object:repository|Repository]].                                                                                | No        |
-|  **c**      | Volume is part of a Consignment.                                                                                              | No        |
+|  **c**      | [[object:volume|Volume]] is part of a Consignment.                                                                                              | No        |
-|  **D**      | Volume has a Move Date.                                                                                                       | No        |
+|  **D**      | [[object:volume|Volume]] has a Move Date.                                                                                                       | No        |
-|  **d**      | Volume Move Date is in the past.                                                                                              | No        |
+|  **d**      | [[object:volume|Volume]] Move Date is in the past.                                                                                              | No        |
-|  **E**      | Volume is encrypted.                                                                                                          | Yes       |
+|  **E**      | [[object:volume|Volume]] is encrypted.                                                                                                          | **Yes**   |
-|  **F**      | Volume has been set as a [[master:favorites_list|Favorite]]                                                                   | No        |
+|  **F**      | [[object:volume|Volume]] has been set as a [[master:favorites_list|Favorite]]                                                                   | No        |
-|  **G**      | Volume has missed a reporting deadline.                                                                                       | **Yes**   |
+|  **G**      | [[object:volume|Volume]] has missed a [[technote:reports|reporting]] deadline.                                                                                       | **Yes**   |
-|  **H**      | Volume Move Date is a Holiday.                                                                                                | No        |
+|  **H**      | [[object:volume|Volume]] Move Date is a Holiday.                                                                                                | No        |
-|  **h**      | Volume is hidden (ghosted).                                                                                                   | **Yes**   |
+|  **h**      | [[object:volume|Volume]] is hidden (ghosted).                                                                                                   | **Yes**   |
-|  **I**      | Volume is moving internally (from one Slot to another in the same Repository).                                                | No        |
+|  **I**      | [[object:volume|Volume]] is moving internally (from one Slot to another in the same [[object:repository|Repository]]).                                                | No        |
-|  **K**      | Volume has been Picked-Up.                                                                                                    | **Yes**   |
+|  **K**      | [[object:volume|Volume]] has been Picked-Up.                                                                                                    | **Yes**   |
-|  **L**      | 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 an update lock and cannot be updated by anyone other than the [[common:tapemaster_user|tapemaster User]].          | **Yes**   |
-|  **l**      | Volume has a move lock and cannot be moved.                                                                                   | **Yes**   |
+|  **l**      | [[object:volume|Volume]] has a move lock and cannot be moved.                                                                                   | **Yes**   |
-|  **M**      | Volume is moving from one Repository to another.                                                                              | No        |
+|  **M**      | [[object:volume|Volume]] is moving from one [[object:repository|Repository]] to another.                                                                              | No        |
-|  **m**      | Volume has a Home Slot.                                                                                                       | No        |
+|  **m**      | [[object:volume|Volume]] has a Home Slot.                                                                                                       | No        |
-|  **N**      | Volume has a Description.                                                                                                     | No        |
+|  **N**      | [[object:volume|Volume]] has a Description.                                                                                                     | No        |
-|  **n**      | Volume has no Slot assigned.                                                                                                  | No        |
+|  **n**      | [[object:volume|Volume]] has no Slot assigned.                                                                                                  | No        |
-|  **O**      | Volume is in the Primary Offsite Repository.                                                                                  | No        |
+|  **O**      | [[object:volume|Volume]] is in the Primary Offsite [[object:repository|Repository]].                                                                                  | No        |
-|  **o**      | Volume is overdue at its Target Repository.                                                                                   | No        |
+|  **o**      | [[object:volume|Volume]] is overdue at its Target [[object:repository|Repository]].                                                                                   | No        |
-|  **p**      | Volume has been set as Move Pending as its Move Date has been exceeded (Set by [[cli:TMSS10MovePending|TMSS10MovePending]]).  | **Yes**   |
+|  **p**      | [[object:volume|Volume]] has been set as Move Pending as its Move Date has been exceeded (Set by [[cli:TMSS10MovePending|TMSS10MovePending]]).  | **Yes**   |
-|  **Q**      | Volume has been flagged as unhealthy by a VeriTape system.                                                                    | **Yes**   |
+|  **Q**      | [[object:volume|Volume]] has been flagged as unhealthy by a VeriTape system.                                                                    | **Yes**   |
-|  **r**      | Volume has been requested back from a Third Party.                                                                            | **Yes**   |
+|  **r**      | [[object:volume|Volume]] has been requested back from a Third-Party.                                                                            | **Yes**   |
-|  **S**      | Volume always uses [[cookbook:simplemanagement|Simple Management]].                                                           | **Yes**   |
+|  **S**      | [[object:volume|Volume]] always uses [[cookbook:simplemanagement|Simple Management]].                                                           | **Yes**   |
-|  **t**      | Do not assign a Slot to this Volume.                                                                                          | **Yes**   |
+|  **t**      | Do not assign a Slot to this [[object:volume|Volume]].                                                                                          | **Yes**   |
-|  **U**      | Volume has been scanned out of the current Repository using either TapeTrack Lite or TapeTrack Check Point.                   | **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**      | Volume has been flagged as a duplicate.                                                                                       | **Yes**   |
+|  **u**      | [[object:volume|Volume]] has been flagged as a duplicate.                                                                                       | **Yes**   |
-|  **W**      | Volume has a warning (has moved back to its original Repository without having been confirmed at its destination).            | **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**      | Volume has been Audit-Scanned.                                                                                                | **Yes**   |
+|  **X**      | [[object:volume|Volume]] has been Audit-Scanned.                                                                                                | **Yes**   |
-|  **Z**      | Volume is Scratch.                                                                                                            | **Yes**   |
+|  **Z**      | [[object:volume|Volume]] is Scratch.                                                                                                            | **Yes**   |
 ===== Using Flags =====
-==== Setting 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]].
-There are two ways to set flags:
+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.
-=== Method 1 ===
-Right-click the Volume/s in the Volume List, hover over Special Operations, then Modify and select Flags.
+==== Setting and Unsetting Flags ====
-{{:master:tapemaster_flags_special.png}}
+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.
-For each flag in the Modify Flags window, there are three options:
+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.
-  * **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.
+=== Changing Flags via the Command Line ===
-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.
+[[object:volume|Volume]] Flags are indirectly set by the following Command Line Programs:
-  * **Has Description (N)**: When **True**, the selected Volume has a description.
-  * **Do Not Slot (t)**: When **True**, the selected Volume cannot be slotted.
+^ Program            ^ Notes                                                                                  ^
-  * **Is a Container (B)**: When **True**, the selected Volume is a Container.
+| [[cli:TMSS10ModifyFlags|TMSS10ModifyFlags]] | Sets and unsets Flags that can be modified without performing a corresponding action.  |
-  * **Movement Required (M)**: When **True**, the selected Volume is either Moving or needs to be Moved.
+| [[cli:TMSS10ExpireByDate|TMSS10ExpireByDate]] | Sets the Move Pending Flag.  |
-  * **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.
+=== Changing Flags via the Desktop ===
-  * **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.
+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.
-  * **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.
+To remove a W Flag select that [[object:volume|Volume]] and press F2.
-  * **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.