Click or drag to resize

Searching Documents

When the APIDemo application is run with “/m:get” parameters, the following operations are performed:

The Document Finder is the service responsible for searching for document matching given criteria and retrieving information including both system fields (properties) and user defined metadata fields.

The search criteria is a collection of conditions which consist of a search type, search operator and zero or more operands (whose type and meaning depend on both search type and operator). The following criteria can be used to find all documents containing some phrase in their name:

C#
1SearchCriteria criteria = new SearchCriteria();
2
3SearchCondition condition = new SearchCondition();
4condition.SearchType = SearchType.DocumentName;
5condition.OperatorType = Operator.Contains;
6condition.Operands = new object[] { "sample phrase" };
7
8criteria.SearchConditions = new SearchCondition[] { condition };

Multiple search criteria can be combined using AND operator. The following criteria can be used to find documents with a specified schema and metadata field AND located in a specified folder:

C#
 1SearchCriteria criteria = new SearchCriteria();
 2
 3SearchCondition fieldCondition = new SearchCondition();
 4fieldCondition.SearchType = APIDemo.DocumentFinderService.SearchType.SchemaWithField;
 5fieldCondition.OperatorType = APIDemo.DocumentFinderService.Operator.Equal;
 6fieldCondition.Operands = new object[] { documentSchemaId, metadataFieldId, "sample value" };
 7
 8SearchCondition folderCondition = new SearchCondition();
 9folderCondition.SearchType = APIDemo.DocumentFinderService.SearchType.FolderId;
10folderCondition.OperatorType = APIDemo.DocumentFinderService.Operator.Equal;
11folderCondition.Operands = new object[] { folderId };
12
13criteria.SearchConditions = new SearchCondition[] { fieldCondition, folderCondition };

The GetDocumentsBySnapshot method creates a snapshot, which is basically a sorted list of documents which is stored in the database at the time of performing the search and identified using a GUID. The same method also retrieves information about a single page of documents from the snapshot and information about columns displayed in the specified view, so it provides all necessary information to populate a grid.

C#
1// Order by document name
2ColumnSelector cc = new ColumnSelector();
3cc.IsSystem = true;
4cc.Id = (int)FileHold.Common.SystemFieldType.DocumentName;
5ColumnSelector[] sortOrder = new ColumnSelector[] { cc };
6
7Guid prevSnapshotId = Guid.Empty;
8Guid snapshotId = Guid.Empty;
9ColumnsWithValues columnsWithValues = finder.GetDocumentsBySnapshot( prevSnapshotId, ref snapshotId, "FLD", criteria, sortOrder, 0, 3 );

The viewContainerType parameter of the GetDocumentsBySnapshot method can be one of the following strings:

There are three identifiers associated with each document returned in the ColumnsWithValues structures:

Usually when performing an operation on a single document, the MetadataVersionId is passed to the API, but some operations require a DocumentId or DocumentVersionId.

In order to download a document from the Document Repository a download token must be first obtained from the Library Manager. The download token is a randomly generated GUID which allows securely passing information between the two services.

C#
1int metadataVersionId = columnsWithValues.DocumentValues[ 0 ].MetadataVersionId;
2Guid token = Guid.Empty;
3long fileSize = 0;
4string fileName = String.Empty;
5documentManager.PrepareSingleDocumentToDownload( metadataVersionId, ref token, ref fileSize, ref fileName, ActionType.Downloaded );

The file size (in bytes) and name (with extension) are also retrieved. File can be downloaded entirely using one request, but for larger files it is recommended to download the file by smaller chunks. Also for better performance it is recommended to use the new DownloadFileDataChunk method rather than GetFileDataChunk.

C#
1int transferedSize = 0;
2while ( transferedSize < fileSize )
3{
4    int size = (int)Math.Min( fileSize - transferedSize, 64 * 1024 );
5    byte[] buffer = repositoryController.DownloadFileDataChunk( token, transferedSize, size );
6    stream.Write( buffer, 0, size );
7    transferedSize += size;
8}

Some operations can be performed on multiple documents at once; such operations are called batch operations. For example, several documents can be downloaded as a single zip file. To perform a batch operation, a selection must first be created. A selection is simply a subset of one or more search snapshots (for example search results, linked documents and document tray).

C#
 1Selection selection = new Selection();
 2
 3SnapshotSelection snapshotSelection = new SnapshotSelection();
 4snapshotSelection.SnapshotId = snapshotId;
 5snapshotSelection.DocumentIdList = new int[] { columnsWithValues.DocumentValues[ 0 ].DocumentId };
 6snapshotSelection.MetadataVersionIdList = new int[] { columnsWithValues.DocumentValues[ 0 ].MetadataVersionId };
 7
 8selection.SnapshotSelection = new SnapshotSelection[ 1 ] { snapshotSelection };
 9
10Guid selectionId = documentManager.CreateSelection( selection );

A batch of documents can be downloaded in the same way as a single document, using a download token generated using the following method.

C#
1Guid token = Guid.Empty;
2long fileSize = 0;
3string fileName = String.Empty;
4documentManager.PrepareDocumentsToDownload( selectionId, false, false, ref token, ref fileSize, ref fileName );

Note that in most cases a selection is automatically destroyed after a successful batch operation so it doesn't need to be destroyed manually.