Skip to content

A .NET library that simplifies working with the DocuWare Platform SDK, providing a clean API, XML-documented services, and extra features not available in the official SDK.

License

Notifications You must be signed in to change notification settings

felixmk0/EasierDocuware

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EasierDocuWare

EasierDocuWare is a .NET library that simplifies working with the DocuWare Platform SDK.
It provides a clean, strongly-typed API with XML-documented services, making it easy to connect, search, and manage documents, file cabinets & more. Additionally, EasierDocuWare includes extra features not available in the official SDK, such as duplicate control, date handling, data validations, and other common methods typically required in robust web services related to document management.

Features

  • Authentication
    • Connect to DocuWare server with credentials (ConnectAsync).
    • Connect to DocuWare via App Registration (ConnectAppRegistrationAsync).
    • Disconnect from the DocuWare Server/App Registration (DisconnectAsync).
  • Organizations
    • Retrieve default organization (GetOrganization).
    • Retrieve all organizations (GetOrganizationsAsync).
  • File Cabinets
    • Retrieve all file cabinets (GetFileCabinetsAsync).
    • Retrieve a file cabinet by ID (GetFileCabinetById).
  • Documents
    • Retrieve documents from a file cabinet (GetDocumentsByFileCabinetIdAsync).
    • Retrieve a document by ID (GetDocumentByIdAsync).
    • Retrieve document fields by document (GetDocFieldsAsync).
    • Retrieve document fields by file cabinet and document ID (GetDocFieldsAsync).
    • Update single document fields (UpdateDocFieldsAsync).
    • Batch update multiple documents (BatchUpdateDocFieldsAsync).
    • Batch update multiple documents keyword index fields (BatchUpdateKeywordIndexFieldsAsync).
    • Download a document (stream) by document and file cabinet ID (DownloadDocumentAsync).
    • Export a document as a DWX file by document and file cabinet ID (ExportDocumentAsDwxAsync).
    • Import a DWX document via a stream by file cabinet ID (ImportDwxDocAsync).
    • Validate a document's date field (ValidateDocDateFieldAsync).
    • Find duplicate documents by matching field values (GetDuplicateDocsAsync).
    • Find duplicate document IDs by matching field values (GetDuplicateDocsIdsAsync).

Getting Started

Requirements

  • .NET 6.0 or higher
  • Access to a DocuWare server (cloud or on-premise)
  • Valid credentials

Installation

Clone the repo and reference the project in your solution:

git clone https://github.com/felixmk0/EasierDocuware.git

About

A .NET library that simplifies working with the DocuWare Platform SDK, providing a clean API, XML-documented services, and extra features not available in the official SDK.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages