Generating Reports

[IrishManInBV]

Is there a way to generate reports from Vault, so that I can see the history at the folder level or at the file level or both?

if not, then is it possible to get some information on the database structure where things are stored in the database, so I can write a report module to pull this information out.

[paulroub]

The vault command-line client's HISTORY command will give you an XML report on the history of a file or folder. If this isn't sufficient, I'd recommend using the Client API (available from the Vault downloads page) instead of trying to go directly to the database.

The database structures are not documented at the user level, nor are they in any way guaranteed not to change. The API is a documented, predictable target. The full command line client source is included for example purposes.

-paul

[IrishManInBV]

where is the documentation on the api, i didn't see any when i downloaded the file and not seeing any documentation.
you mentioned the command line, and I was wondering if it was possible to set this up so that it does it recursively with the files that are in the selected folder or on a file level.

[paulroub]

See VaultClientIntegrationLib.chm in the Client API zip file.

[paulroub]

As far as the command line client, it will list the history of whichever object you specify. If you give it the name of a Vault folder, it will recursively list the history of that folder and its contents. Given a file, it will list just that file's history.

[Beth]

I wanted to jump in quick just to mention a work-around I've helped a few users with. If you run a history query, you can save it as a .csv file. A .csv file can be imported into Excel and then manipulated a variety of ways to produce useful reports.

[IrishManInBV]

thanks for the quick replies, was a little disappointed to see that all of the code for the library is c#, nothing against c# just that I am more familiar with vb.net. Still, the documentation on the command line looks okay, so I should be able to get what I want.

Beth,
you mentioned a history query, not sure where that is, still i will search around and see what it is. Otherwise, thanks again for your help.

[paulroub]

The library works just fine from any .NET language -- I've even blogged about using it from PowerShell here and here.

[Beth]

you mentioned a history query, not sure where that is, still i will search around and see what it is.

The history query is found in the Vault GUI client. You will select either $ or a folder you want to see history on, then select View - Show History. There are a number of options you can choose from the tabs in the dialog window, then you click OK. Once the history shows, go to Query - Save Results As. That is where you can save it as a .csv file.