Bestanden zoeken in Vault met C#

Bestanden zoeken in Vault is één van de meest basale maar ook meest gevraagde operaties in Vault-automatisering. Je wilt weten waar een specifiek onderdeel staat, welke bestanden een bepaalde lifecyclestatus hebben of welke bestanden recent zijn gewijzigd. In dit artikel leer je hoe je de Vault WebService API gebruikt om krachtige zoekopdrachten te bouwen.

Vault API: hoe het werkt

De Vault .NET API werkt via webservices. Je verbindt via WebServiceManager, die toegang geeft tot alle services: DocumentService, PropertyService, LifeCycleService, enzovoort. Alle communicatie verloopt via SOAP over HTTP naar de Vault-server.

Verbinding maken met Vault

using Autodesk.Connectivity.WebServices;
using Autodesk.Connectivity.WebServicesTools;
using VDF = Autodesk.DataManagement.Client.Framework;

// Verbinding opzetten
var settings = new VDF.Vault.Currency.Connections.ServerIdentities();
settings.DataServer = "localhost";
settings.FileServer = "localhost";

var credentials = new VDF.Vault.Currency.Connections.UserPasswordCredentials
{
    UserName = "Administrator",
    Password = "",
    Vault    = "MijnVault"
};

VDF.Vault.Currency.Connections.Connection conn =
    VDF.Vault.Library.ConnectionManager.Connect(
        settings, credentials,
        VDF.Vault.Currency.Connections.AuthenticationFlags.Standard);

var docSvc = conn.WebServiceManager.DocumentService;

Zoeken op bestandsnaam

public File[] ZoekOpNaam(DocumentService docSvc, string naam)
{
    // Zoekconditie: bestandsnaam bevat de opgegeven string
    var cond = new SrchCond
    {
        PropDefId   = 0,          // 0 = systeem-eigenschap bestandsnaam
        PropTyp     = PropertySearchType.AllProperties,
        SrchOper    = 3,          // 3 = contains
        SrchTxt     = naam,
        SrchRule    = SearchRuleType.Must
    };

    string bookmark = string.Empty;
    SrchStatus status;

    var resultaten = docSvc.FindFilesBySearchConditions(
        new[] { cond },
        null,           // geen sorteerkolommen
        null,           // alle mappen
        true,           // inclusief submappen
        true,           // latestOnly
        ref bookmark,
        out status);

    return resultaten ?? Array.Empty();
}

SrchOper waarden

Zoeken op een Vault-eigenschap (iProperty)

Om op een Vault-eigenschap te zoeken (zoals Revisie of Onderdeelnummer), heb je eerst de PropDefId nodig. Die zoek je op via de PropertyService:

public long VindPropDefId(WebServiceManager wsm, string propNaam)
{
    var propDefs = wsm.PropertyService.GetPropertyDefinitionsByDomainAndEntityClassId(
        "FILE", "FILE");

    foreach (var def in propDefs)
        if (def.DispName.Equals(propNaam, StringComparison.OrdinalIgnoreCase))
            return def.Id;

    throw new Exception($"Property definitie '{propNaam}' niet gevonden.");
}

// Gebruik:
long propId = VindPropDefId(conn.WebServiceManager, "Revision Number");

var cond = new SrchCond
{
    PropDefId   = propId,
    PropTyp     = PropertySearchType.SingleProperty,
    SrchOper    = 1,       // gelijk aan
    SrchTxt     = "B",     // revisie B zoeken
    SrchRule    = SearchRuleType.Must
};

Meerdere condities combineren (AND-logica)

// Zoek alle bestanden die BEIDE condities vervullen:
// 1. bestandsnaam bevat "steun"
// 2. revisie = "A"
long revId = VindPropDefId(conn.WebServiceManager, "Revision Number");

var condNaam = new SrchCond
{
    PropDefId = 0, PropTyp = PropertySearchType.AllProperties,
    SrchOper  = 3, SrchTxt = "steun",
    SrchRule  = SearchRuleType.Must
};
var condRev = new SrchCond
{
    PropDefId = revId, PropTyp = PropertySearchType.SingleProperty,
    SrchOper  = 1, SrchTxt = "A",
    SrchRule  = SearchRuleType.Must
};

string bookmark = string.Empty;
SrchStatus status;

var resultaten = docSvc.FindFilesBySearchConditions(
    new[] { condNaam, condRev },
    null, null, true, true,
    ref bookmark, out status);

Zoeken op lifecyclestatus

// Zoek alle bestanden met status "Released"
long lcStatId = VindPropDefId(conn.WebServiceManager, "State");

var condStatus = new SrchCond
{
    PropDefId = lcStatId,
    PropTyp   = PropertySearchType.SingleProperty,
    SrchOper  = 1,
    SrchTxt   = "Released",
    SrchRule  = SearchRuleType.Must
};

Zoeken in een specifieke map

// Zoek alleen in de map "/Projecten/PROJ-001"
var map = conn.WebServiceManager.DocumentService
    .GetFolderByPath("$/Projecten/PROJ-001");

var resultaten = docSvc.FindFilesBySearchConditions(
    new[] { cond },
    null,
    new[] { map.Id },  // mapfilter
    true,              // inclusief submappen
    true,
    ref bookmark,
    out status);

Paginering met bookmark

Bij grote resultatensets geeft Vault maximaal 200 resultaten per aanroep terug. Gebruik de bookmark voor paginering:

public List ZoekAlleResultaten(DocumentService docSvc, SrchCond[] conds)
{
    var alle      = new List();
    string bm     = string.Empty;
    SrchStatus st;

    do
    {
        var batch = docSvc.FindFilesBySearchConditions(
            conds, null, null, true, true, ref bm, out st);
        if (batch != null) alle.AddRange(batch);
    }
    while (st.TotalHits > alle.Count);

    return alle;
}

Resultaten verwerken: bestandsinformatie uitlezen

foreach (var bestand in resultaten)
{
    Console.WriteLine($"Naam     : {bestand.Name}");
    Console.WriteLine($"ID       : {bestand.Id}");
    Console.WriteLine($"Master ID: {bestand.MasterId}");
    Console.WriteLine($"Versie   : {bestand.VerNum}");
    Console.WriteLine($"Status   : {bestand.FileLfCyc?.LfCycStateName ?? "n.v.t."}");
    Console.WriteLine($"Pad      : {bestand.FullPath}");
    Console.WriteLine();
}

Veelgemaakte fouten

PropDefId = 0 voor bestandsnaam — voor de bestandsnaam gebruik je PropDefId = 0 en PropTyp = AllProperties. Voor andere eigenschappen moet je de Id opzoeken via PropertyService.

Lege resultatenset vs null — FindFilesBySearchConditions geeft null terug als er geen resultaten zijn, niet een lege array. Controleer altijd op null.

latestOnly vergeten — zet latestOnly = true als je alleen de meest recente versie wilt. Bij false krijg je alle historische versies terug.

Bookmark na elke batch resetten — de bookmark-string wordt door Vault bijgewerkt na elke aanroep. Geef hem mee als ref-parameter en hergebruik hem bij de volgende aanroep.

Samenvatting

Zoeken in Vault via de .NET API draait om SrchCond-objecten: stel de PropDefId, operator en zoektekst in, geef ze mee aan FindFilesBySearchConditions en verwerk de resultaten. Combineer meerdere condities voor complexe zoekopdrachten en gebruik paginering voor grote resultatensets.

Searching for files in Vault is one of the most basic yet most frequently requested operations in Vault automation. This article shows how to use the Vault WebService API to build powerful search queries — by name, by iProperty value, by lifecycle state and within specific folders.

How the Vault API Works

The Vault .NET API communicates via web services. You connect through WebServiceManager, which gives access to all services: DocumentService, PropertyService, LifeCycleService, etc.

Connecting to Vault

var conn = VDF.Vault.Library.ConnectionManager.Connect(
    serverIdentities, credentials,
    VDF.Vault.Currency.Connections.AuthenticationFlags.Standard);
var docSvc = conn.WebServiceManager.DocumentService;

Searching by File Name

var cond = new SrchCond
{
    PropDefId = 0,                              // 0 = filename system property
    PropTyp   = PropertySearchType.AllProperties,
    SrchOper  = 3,                              // 3 = contains
    SrchTxt   = "bracket",
    SrchRule  = SearchRuleType.Must
};
string bookmark = string.Empty;
SrchStatus status;
var results = docSvc.FindFilesBySearchConditions(
    new[] { cond }, null, null, true, true, ref bookmark, out status);

Searching by Vault Property

// First find the property definition ID
long propId = wsm.PropertyService
    .GetPropertyDefinitionsByDomainAndEntityClassId("FILE", "FILE")
    .First(d => d.DispName == "Revision Number").Id;

var cond = new SrchCond
{
    PropDefId = propId,
    PropTyp   = PropertySearchType.SingleProperty,
    SrchOper  = 1,   // equals
    SrchTxt   = "B",
    SrchRule  = SearchRuleType.Must
};

Combining Multiple Conditions (AND)

var results = docSvc.FindFilesBySearchConditions(
    new[] { condByName, condByRevision },
    null, null, true, true, ref bookmark, out status);

Pagination with Bookmark

var all = new List();
string bm = string.Empty; SrchStatus st;
do {
    var batch = docSvc.FindFilesBySearchConditions(conds, null, null, true, true, ref bm, out st);
    if (batch != null) all.AddRange(batch);
} while (st.TotalHits > all.Count);

Common Pitfalls

PropDefId = 0 for filename — use PropDefId = 0 and PropTyp = AllProperties for the filename. For other properties, look up the Id via PropertyService.

Null vs empty result — FindFilesBySearchConditions returns null when no results are found, not an empty array. Always null-check.

latestOnly — set to true to get only the most recent version. false returns all historical versions.

Summary

Searching in Vault via the .NET API revolves around SrchCond objects: set the PropDefId, operator and search text, pass them to FindFilesBySearchConditions and process the results. Combine multiple conditions for complex queries and use pagination for large result sets.