How to View File Usage Summary Information

You view file usage summary information, in Configuration Manager, by using the SMS_MeteredFiles and SMS_FileUsageSummary classes.

To view file usage summary information

Set up a connection to the SMS Provider.
Get a collection of all of the metered files SMS_MeteredFiles.
Get a collection of all of the summarized files SMS_FileUsageSummary.
Loop through the summarized file information, displaying information as required.

Example

The following example method displays file usage summary information by using the SMS_MeteredFiles and SMS_FileUsageSummary classes.

Note

The example code below is relatively inefficient. In an environment with large amounts of data (large result sets), it would be better to do the query on SMS_MeteredFiles, then loop over that result, doing individual queries for SMS_FileUsageSummary where SMS_FileUsageSummary.FileID=meteredFile.FileID.

For information about calling the sample code, see Calling Configuration Manager Code Snippets.


sub ViewFileUsageSummaryInfo(connection)

' Get SMS_MeteredFiles - used to match FileID to a file name

' Build query to get all metered files.
meteredFilesQuery = "SELECT * FROM SMS_MeteredFiles"

' Run query.
Set meteredFiles = connection.ExecQuery(meteredFilesQuery, , wbemFlagForwardOnly Or wbemFlagReturnImmediately)

' Get the summarized files.

' Build query to get all file usage summary information.
fileUsageSummaryQuery = "SELECT * FROM SMS_FileUsageSummary"

' Run query.
Set fileUsageSummary = connection.ExecQuery(fileUsageSummaryQuery, , wbemFlagForwardOnly Or wbemFlagReturnImmediately)

' Output file usage summary information.
For Each summariedFile in fileUsageSummary

    For each meteredFile in meteredFiles

        if meteredFile.MeteredFileID=summariedFile.FileID then
            wscript.echo "File Name: " & meteredFile.FileName
            Exit For
        end if

    next

    ' As matching summary information is found, output details.
    wscript.echo "File ID: "             & summariedFile.FileID
    wscript.echo "Distinct User Count: " & summariedFile.DistinctUserCount
    wscript.echo "Interval Start: "      & summariedFile.IntervalStart
    wscript.echo "Interval Width: "      & summariedFile.IntervalWidth
    wscript.echo "Site Code: "           & summariedFile.SiteCode
    wscript.echo " "

Next

end sub


public void ViewFileUsageSummaryInfo(WqlConnectionManager connection)
{
    try
    {
        // Build query to get all metered files.
        string meteredFilesQuery = "SELECT * FROM SMS_MeteredFiles";

        // Run meteredFiles query.
        IResultObject meteredFilesTemp = connection.QueryProcessor.ExecuteQuery(meteredFilesQuery);

        // Cache values to local list.
        List<IResultObject> meteredFiles = new List<IResultObject>();
        foreach (IResultObject meteredFileTemp in meteredFilesTemp)
        {
            meteredFiles.Add(meteredFileTemp);
        }

        // Build query to get all the file usage summary information.
        string fileUsageSummaryQuery = "SELECT * FROM SMS_FileUsageSummary";

        // Run fileUsageSummary query.
        IResultObject fileUsageSummaryTemp = connection.QueryProcessor.ExecuteQuery(fileUsageSummaryQuery);

        // Cache values to local list.
        List<IResultObject> fileUsageSummary = new List<IResultObject>();
        foreach (IResultObject summariedFileTemp in fileUsageSummaryTemp)
        {
            fileUsageSummary.Add(summariedFileTemp);
        }

        // Enumerate through the files.
        foreach (IResultObject summariedFile in fileUsageSummary)
        {
            foreach (IResultObject meteredFile in meteredFiles)
            {
                if (meteredFile["MeteredFileID"].StringValue == summariedFile["FileID"].StringValue)
                {
                    // As matching summary information is found, output details.
                    Console.WriteLine("File Name: " + meteredFile["MeteredFileName"].StringValue);
                    break;
                };
            };

            // As matching summary information is found, output details.
            Console.WriteLine("File ID: " + summariedFile["FileID"].StringValue);
            Console.WriteLine("Distinct User Count: " + summariedFile["DistinctUserCount"].StringValue);
            Console.WriteLine("Interval Start: " + summariedFile["IntervalStart"].StringValue);
            Console.WriteLine("Interval Width: " + summariedFile["IntervalWidth"].StringValue);
            Console.WriteLine("Site Code: " + summariedFile["SiteCode"].StringValue);
            Console.WriteLine(" ");
        };
    }
    catch (SmsException ex)
    {
        Console.WriteLine();
        Console.WriteLine("Failed. Error: " + ex.InnerException.Message);
    }
}

The example method has the following parameters:

Parameter	Type	Description
`connection`	- Managed: `WqlConnectionManager` - VBScript: SWbemServices	A valid connection to the SMS Provider.

Compiling the Code

This C# example requires:

Namespaces

System

System.Collections.Generic

System.Text

Microsoft.ConfigurationManagement.ManagementProvider

Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine

Assembly

adminui.wqlqueryengine

microsoft.configurationmanagement.managementprovider

Robust Programming

For more information about error handling, see About Configuration Manager Errors.

.NET Framework Security

For more information about securing Configuration Manager applications, see Configuration Manager role-based administration.

Feedback

Was this page helpful?

Last updated on 2022-10-04