Vault Tracking Report

Table of Contents

About This Report

The Vault Tracking Report displays information about media that is managed by the Vault Tracker feature, including pending actions, spare media that are due back, movement action history, and media related to a Vault Tracker policy.

You must log into the CommCell Console to access this report.

When to Use This Report

You can use the Vault Tracking Report to review information related to Vault Tracker media. This report is useful if you need to know:

  • Media that is related to the Vault Tracker pending actions and which user action is required
  • Media that is due within a number of upcoming days
  • Vault Tracker movement action history
  • All media related to the Vault Tracker policy
  • Media that meets a selected set of criteria

What This Report Contains

This report presents the data in the following sections:

Sections Description
Media This table provides information about media that is managed by Vault Tracker. Information displayed in the table includes:
  • Bar code that is assigned to media
  • Name of the library in which the media is located and its associated tracking policy
  • Media source, destination, and storage policy
  • Media side information including status, last read time, last write time, and total data size

Export to Iron Mountain

Reports that are exported to Iron Mountain display information in columns that have no column headings. On the Output tab, if you select Media Barcode, then only the Bar Code column appears in the Iron Mountain output. If you leave Media Barcode cleared, then all of the following columns appear in the Iron Mountain output.

Column Description
Iron Mountain Customer ID Can be a numeric or alphanumeric value assigned to an Iron Mountain customer.
OP or CT
  • OP indicates the number of media with volume information is greater than one.
  • CT indicates that the number of media with volume information is less than one.
Bar Code Can be a numeric or alphanumeric value assigned to media for identification.
Due Back Date Date on which the media is due back.
Location Current location of the media.

How to Generate the Report

You can generate the default version of any CommCell Report on demand in the CommCell Console.

  1. On the CommCell Console ribbon, select the Reports tab, and then click the button for the report that you want to run.

    Some report buttons appear under Other Reports.

  2. In the Report Selection dialog box, click Run.

    The report appears in your default Web browser.

Scheduling the Report

  1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to schedule.

    The Report Selection dialog box appears.

  2. Configure the report as needed.
  3. In the Report Selection dialog box, click Schedule.
  4. On the Schedule Pattern tab, in the Schedule Name box, enter a name for the schedule.
  5. Select the interval at which you want the report to run: One Time, Daily, Weekly, Monthly, or Yearly.
  6. In the Start Time box, type the time of day when you want the report generation to begin.
  7. Under Repeat, specify the exact times and days that you want the report to run.
  8. Click Ok.

Customizations That You Can Perform With This Report

You can further customize the report by using the tabs that are available in the Report Selection dialog box. The following table describes the available report options for this report.

Options Description
General On this tab, you can select that types of media to include in the report. Options include the following:
  • Media that is pending action, due back for reuse, or related to a tracking policy
  • Media history including aborted, completed, and rolled back media
  • Group media by destination, action or source
  • Include or exclude copy retention information
Source Location This tab is available only if you select the Reconciliation, Tracking Policies, or History option from the General tab.

You can set the report to display information for all source locations in the CommCell, or select individual source locations.

Current Locations This tab is available only if you select the Due back for reuse option from the General tab.

You can set the report to display information for all current locations in the CommCell, or select individual locations.

Libraries This tab is available only if you select the Due back for reuse option from the General tab.

You can set the report to display information for all Libraries in the CommCell, or select individual Libraries.

Destination Location This tab is available only if you select the Reconciliation, Tracking Policies, or History option from the General tab.

You can set the report to display information for all destination locations in the CommCell, or select individual locations.

Storage Policy This tab is available only if you select the Due back for reuse option from the General tab.

You can set the report to display information for all storage policies in the CommCell or select individual storage policies.

Tracking Policy This tab is available only if you select the Reconciliation, Tracking Policies, or History option from the General tab.

You can set the report to display information for all tracking policies in the CommCell, or select individual tracking policies.

Time Range This tab is available only if you select the Reconciliation, Due back for reuse, or History option from the General tab.

You can choose to include information from a specific time range in the report.

  • Choose a number of hours, days, or weeks from the list. The report information ends at the time that you generate the report.
  • Select a time zone, and then enter a range of time from a specific date and time to another specific date and time.
  • Set the report to start at the first event that occurred in the CommCell, or enter a specific date and time in the Select Start Time section.
  • Set the report to end at the last event that occurs in the CommCell before you run the report, or enter a specific date and time in the Select End Time section.
Output

You can set the report output to appear in one of several  formats and save it to a variety of locations. Set any of the following options:

  • Generate the report in HTML, Text separated by commas or tabs, PDF, or Iron Mountain format
  • Select a style sheet to customize XML output
  • Enter a location to save the report in one of these locations:
    • On your local computer
    • On a shared network drive
    • An FTP location to which you can upload.
  • Choose a language from the Choose Locale list to set the report to appear in that language.
  • Select Date and Time, and then select a format from the list to set the format in which the date and time appears in the report

Creating a Custom Style Sheet

You can create a custom style sheet so that the output for the Vault Tracking report includes the information that is most Important to you. The default style sheet includes a number of columns that you can remove or modify, as it suits your needs.

  1. Navigate to the folder where the style sheet is located.

    By default, the style sheet is saved in the following location:

    <software installation folder>\Reports\XSLs\0\VaultTracking\sample1.xsl

  2. Right-click sample1.xsl, click Open with, and then select a text editor from the list of available applications.
  3. Edit the style sheet code to add, remove, or rearrange the tracking information that is included in the report output.
  4. Save your changes, and then close the application.

Mapping Table

The following objects can be excluded from or modified in the style sheet. In order to exclude entire columns, you must remove both the column header and its associated data from the style sheet.

Column Header Associated Data
<th>Bar Code</th> <td><xsl:value-of select="@barCode"/></td>
<th>Action ID</th> <td><xsl:value-of select="@actionId"/></td>
<th>Library</th> <td><xsl:value-of select="@library"/></td>
<th>Tracking Policy</th> <td><xsl:value-of select="@policy"/></td>
<th>Current Location</th> <td><xsl:value-of select="@current"/></td>
<th>Container</th> <td><xsl:value-of select="@container"/></td>
<th>Source</th> <td><xsl:value-of select="@source"/></td>
<th>Destination</th> <td><xsl:value-of select="@destination"/></td>
<th>Start Time</th> <td><xsl:value-of select="@startTimeStr"/></td>
<th>End Time</th> <td><xsl:value-of select="@endTimeStr"/></td>
<th>Storage Policy</th> <td><xsl:value-of select="@SP"/></td>
<th>Storage Policy Copy</th> <td><xsl:value-of select="@copy"/></td>
<th>Job Status</th> <td><xsl:choose>
<xsl:when test="@endTime &gt; 0 and (@jobStatus div 4) mod 2 &gt;= 1">Rolled back</xsl:when>
<xsl:when test="@endTime &gt; 0 and (@jobStatus div 8) mod 2 &gt;= 1">Aborted</xsl:when>
<xsl:when test="@endTime &gt; 0 and (@jobStatus div 2) mod 2 &gt;= 1">Completed</xsl:when>
<xsl:when test="@endTime &gt; 0 and (@jobStatus div 1) mod 2 &gt;= 1">Failed</xsl:when>
<xsl:when test="@endTime &lt;= 0 and @jobStatus=1">Ready</xsl:when>
<xsl:when test="@endTime &lt;= 0 and @jobStatus=2">Running</xsl:when>
<xsl:when test="@endTime &lt;= 0 and @jobStatus=4">Failed</xsl:when>
<xsl:when test="@endTime &lt;= 0 and @jobStatus=8">Completed</xsl:when>
<xsl:otherwise>N/A</xsl:otherwise>
</xsl:choose>
</td>
<th>Return Date</th> <td><xsl:choose>
<xsl:when test="@dueback &lt; 0">Never</xsl:when>
<xsl:when test="@dueback=0">Now</xsl:when>
<xsl:otherwise><xsl:value-of select="@duebackTime"/></xsl:otherwise>
</xsl:choose>
</td>
<th>Initiator</th> <td><xsl:choose>
<xsl:when test="@policyId &gt; 0"><xsl:value-of select="@policy"/></xsl:when>
<xsl:when test="@jobId &gt; 0"><xsl:value-of select="@jobId"/></xsl:when>
<xsl:otherwise>N/A</xsl:otherwise>
</xsl:choose>
</td>

Example

To exclude the Action ID, Storage Policy, and Storage Policy Copy, remove both the table header and associated data for each. The following style sheet excludes the Action ID, Storage Policy, and Storage Policy Copy columns:

Style Sheet Hierarchy

The following diagram depicts the hierarchy that is used in the custom style sheet.

Additional Options

The following table describes additional operations that you can perform with the reports feature:

Option Description Related topics
Saving the Report Output

You can save the report output to a specified location.

  1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to save.

    The Report Selection dialog box appears.

  2. Configure the report as needed.
  3. Select the Output tab, and then from the Output Format section, select a file format.
  4. Select Output To, and then enter the location to which you want to save the report.
    • To save the report to your local computer, select Use Local Drive On, and then in the Report Copy Location box, enter a location.
    • To save the report to a shared network drive, select Use Network Share, and then in the Report Copy Location box, enter a location.
    • To upload the report to an FTP site, select FTP Upload, and then click Settings to enter the FTP location and your credentials.
  5. From the Choose Locale list, select the language in which you want the report to appear.
  6. At the bottom of the Report Selection dialog box, click Run.

    The report opens in the file format that you specified and a copy of the report is saved to the location that you entered.

 
Saving a Report as a Template

You can save the report settings as a template in the CommCell Console, and then run the report at any time.

  1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to make into a template.

    The Report Selection dialog box appears.

  2. Configure the report as needed.
  3. At the bottom of the Report Selection dialog box, click Save As.

    The Save As dialog box appears.

  4. Select Save a Report, and then enter a name for the template in the box.
  5. Click OK.

    The report template appears in the CommCell Browser under Reports > My Reports.

 
Generating a Report from a Template

You can generate a report from a template at any time.

  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to generate, and then select Run Immediately.

    The report opens in the format that is specified in the template.

 
Modifying a Report Template
  1. In the CommCell Browser, go to Reports | My Reports | General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to change, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Report Details tab, and then make changes on any of the available tabs.
  4. Click OK to save your settings.
 
Cloning a Report Template
  1. In the CommCell Browser, go to Reports | My Reports | General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to clone, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Job Initiation tab, and then select Saved Report.
  4. Select Clone this report as, and then enter a name in the box.
  5. Click OK.

    The cloned report appears in the General tab.

 
Deleting a Report Template
  1. In the CommCell Browser, go to Reports | My Reports | General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to delete, and then select Delete.

    A message appears that asks if you are sure that you want to delete the selected Report Template.

  3. Click Yes.

    The report is removed from the General tab.

 
Setting a Report Alert This option allows users or user groups to get an automatic notification when a report is created. Follow the steps given below to set up the criteria to raise notifications/alerts:
  1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to set alerts for.

    The Report Selection dialog box appears.

  2. Configure the report as needed
  3. At the bottom of the Report Selection dialog box, click Schedule.

    The Schedule Details dialog box appears.

  4. Configure the schedule as needed.
  5. Select the Notification tab, and then click Add Alert.
  6. From the Add Alert Wizard dialog box, select the types of notifications that you want to send, and then click Next.
  7. Add recipients to the selected list.
    • To add a recipient that is a user in the CommCell, from the Available list, select a user, and then click Add.
    • To add a recipient that is not a user in the CommCell, in the Email to Recipients box, type an e-mail address.
  8. Click Next, and then click Finish.
  9. Click OK.
Refer to Alerts.
Saving a Report as a Script

The Command Line Interface allows you to generate reports from the command line. The commands can be executed from the command line or can be integrated into scripts. You can generate command line scripts for specific operations in the CommCell Console by using the Save As Script option.

To create an XML script that generates a report:

  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to save as a script, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Job Initiation tab, and then click Save As Script

    The Save As Script dialog box appears.

  4. Enter the appropriate settings to generate a script file.
    1. From the Client list, select the name of the client where you want to save the script.
    2. In the Path box, enter the file path where you want to save the script, and then enter a name for the script file at the end of the path.

      Ensure that the name of the file contains the .xml extension

    3. Click OK to create the script.

      A message appears that says that the script saved successfully

    4. Click OK.

    The Save As Script and the Saved Reports dialog boxes close.

Refer to Command Line Interface.