Skip to main content

Box_FileMetrics Job

The Box_FileMetrics Job offers insight into content sizing, staleness, and ownership of files in the Box environment.

note

The staleness threshold can be customized within the File Metrics Details analysis.

Analysis Tasks for the Box_FileMetrics Job

Navigate to Box > 2.Content > Box_FileMetrics > Configure node and select Analysis to view analysis tasks.

warning

Most of these analysis tasks should never be modified and never be deselected.

Analysis Tasks for the Box_FileMetrics Job

The following analysis tasks are selected by default:

  • File Metrics Details – Creates the Box_FileMetrics_Details table accessible under the job’s Results node
  • File Count by User – Creates the Box_FileMetrics_UserFileCount table accessible under the job’s Results node
  • Total File Size by User – Creates the Box_FileMetrics_UserFileSize table accessible under the job’s Results node
  • File Counts by File Extension – Creates the Box_FileMetrics_ExtFileCount table accessible under the job’s Results node
  • File Size by File Extension – Creates the Box_FileMetrics_ExtFileSize table accessible under the job’s Results node

In addition to the tables created by the analysis tasks, the Box_FileMetrics Job produces the following pre-configured reports:

ReportDescriptionDefault TagsReport Elements
Files by ExtensionThis report summarizes the Box content by file extension.NoneThis report is comprised of four elements:
  • Pie Chart – Displays top 20 file counts by file extension
  • Bar Chart – Displays top 5 file size by file extension
  • Table – Provides details on file counts by file extension
  • Table – Provides details on file size by file extension
Files by UserThis report summarizes the Box content by user.NoneThis report is comprised of four elements:
  • Bar Chart – Displays top 5 file count by user
  • Bar Chart – Displays top 5 file size by user
  • Table – Provides details on file count by user
  • Table – Provides details on file size by user

Customize Analysis Tasks for the Box_FileMetrics Job

The default values for parameters that can be customized are:

Analysis TaskCustomizable Parameter NameDefault ValueValue Indicates
File Metrics Details@STALE_THRESHOLD30Consider content stale after 30 days

See the Configure the Customizable Parameters in an Analysis Task topic for instructions on how to modify parameters.