DocumentSchemaManager Class

Service for managing document schemas and metadata fields.

Definition

Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.1.0.0
C#
[WebServiceAttribute(Namespace = "http://filehold.com/librarymanager/documentschemamanager/")]
[WebServiceBindingAttribute(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class DocumentSchemaManager : WebService
Inheritance
Object    MarshalByValueComponent    WebService    DocumentSchemaManager

Constructors

DocumentSchemaManagerInitializes a new instance of the DocumentSchemaManager class

Properties

Methods

AddDocumentControlField Create a new Document Control Field.
AddDocumentSchema(DocumentSchema) Adds new document schema with fields
AddDocumentSchema(DocumentSchema, Database, DbTransaction) 
AddDocumentSchemaField Adds field definition to document schema
AddEvent Create a new event definition.
AddGlobalField Creates new metadata field (also called "global field" in the API)
AddVersionControlField Create a new Version Control Field.
AreDocumentTypesCompatible This method is obsolete.
ChangeDocumentSchema Sets new details for schema
ChangeGlobalField Changes definition of metadata field
CheckHasAccessToSchemaInCabinet Checks whether user is allowed to add document in particular schema to specified cabinet
CheckIfItemIsAssociatedWithDocuments Check if a metadata field has values with given dropdown or drilldown menu item
CreateDocumentSchema Creates document schema
DeleteDocumentControlField Delete a Document Control Field.
DeleteDocumentSchema Deletes document schema
DeleteDocumentSchemaFieldDefinition Deletes document schema field definition
DeleteEvent Delete an event definition.
DeleteVersionControlField Delete a Version Control Field.
GetAllDocumentsSchemas Retrieves the details of all available document schemas.
GetAllFields Retrieves the details of all available metadata fields (without drop down menu items).
GetAllowedConversionsInFolder Calculate allowed document type conversions in given folder
GetAvailableCurrencySymbols Returns available currency symbols
GetAvailableDateFormats Returns available date formats
GetAvailableDecimalSeparators Returns available decimal separators
GetAvailableGroupSeparators Returns available group separators
GetAvailableNegativeColors Returns available colors for negative numbers
GetAvailableNegativeFormats Returns available formats for negative numbers
GetChoicesFromSource Retrieves choices from specified source
GetChoicesFromSourceForPreview Retrieves choices from specified source
GetCommonInactiveFieldChoicesFromMetadataVersionIds Returns common collection of DropdownFieldChoices with IsInactive flag specified for particular field and given documents' metadataVersionIds.
GetControlFieldsOverview Get an overview list of all Document and Version Control Fields
GetDataProviders Return available custom data providers
GetDefaultFolderSchemaId Retrieve default schema ID for folder.
GetDocumentControlField Get details of a Document Control Field.
GetDocumentControlFieldsList Get a list of all existing Document Control Fields.
GetDocumentDetailsFields Returns all metadata fields of particular schema and DocumentName system field
GetDocumentSchema Retrieves schema's details
GetDocumentSchemaFields Returns all metadata fields of particular schema
GetDocumentSchemaFieldsIncludingInvisible Returns all metadata fields of particular schema (with fields marked as not visible)
GetDocumentSchemasInfoList Lists document schemas start with the specified string
GetDocumentSchemasOverviewList Lists all document schemas present in system providing general information about them.
GetDocumentSchemaType Return default format of given schema
GetDrillDownMenuItemByID 
GetDrilldownMenuItems Returns collection of drill-down choices specified for particular field
GetDrillDownMenuPathByID 
GetDropDownMenuItems Returns collection of choices specified for particular field
GetDropDownMenuItemsByIDs Returns collection of choices specified for particular field and given ids
GetDropDownMenuItemsByNames Returns collection of choices specified for particular field and given names
GetDropDownMenuItemsForImport Returns collection of choices specified for particular field and given names or source IDs
GetDropDownMenuItemsPaged Returns collection of choices specified for particular field with paging and filtering
GetDropDownMenuItemsPagedV2 Returns collection of choices specified for particular field with paging and filtering
GetElectronicSchemaList Return all schemas for electronic documents or records.
GetEventDefinition Return event definition with given identifier.
GetEventsList Get a list of all events.
GetEventsOverview Get an overview list of all events.
GetFieldsInfo Returns information about specified fields from particular schema
GetFieldsList Returns brief information about all metadata fields existing in the system. The text property is the metadata field name and the value is the metadata field id.
GetFieldsOverviewInfoList /// Returns information about all metadata fields starting with the specified string.
GetFieldsOverviewList Returns information about all metadata fields existing in the system.
GetFieldsOverviewListIncludingInvisible Returns information about all metadata fields existing in the system including invisible fields.
GetFilteredDropDownMenuItems Returns collection of choices specified for particular field with paging, sorting and filtering. The field must be a DB lookup drop-down menu field.
GetFirstCharactersOfDocumentSchemas Return distinct first characters of document schema names
GetFirstCharactersOfGlobalFields Return distinct first characters of metadata fields
GetGlobalField Returns specified metadata field definition (also called "global field" in the API)
GetGlobalFieldFast Returns metadata field without drop down menu items
GetGlobalFields(String, Boolean, Boolean) Returns specified metadata field definitions
GetGlobalFields(String, Boolean, Boolean, Database, DbTransaction) 
GetOfflineSchemaList Return all schemas for offline documents.
GetPagedDocumentSchemaFields Retrieves schema's fields.
GetPagedDocumentSchemaFieldsCount Retrieves schema's fields count.
GetReindexWarningThreshold Returns a minimum number of documents that when changing their metadata value field will show a warning message.
GetSchemaList Returns all schemas defined in system.
GetSchemaListAdvanced Return list of document schemas for editing document metadata
GetSchemaListForCabinet Returns list of schemas to which user has permissions based on localization.
GetSchemaListNoCustomNaming Return all schemas without custom naming.
GetSchemaListOfConvertedType Returns all schemas for document after conversion to electronic or offline.
GetSchemaListOfDocumentType Returns all schemas of specified type (type is specified by document).
GetSchemaListOfSelectionType Returns all schemas of specified type (type is specified by selection).
GetUserDateFormats Return date formats for the current user.
GetVersionControlField Get details of a Version Control Field.
GetVersionControlFieldsList Get a list of all existing Version Control Fields.
IsCustomNamingPatterModified Check if custom naming pattern was modified
IsDocumentSchemaUsed Check if the document schema is associated with any document.
IsMetadataFieldUsed Check if a metadata field has associated documents or auto-tagging definitions.
IsReindexWarningThresholdReached Checks if ReindexWarningThreshold is reached and how many documents will need reindexing
LookupMetadata Lookup metadata for the given value.
LookupMultiMetadata(Int32, FieldWithValue) Lookup metadata for given values.
LookupMultiMetadata(Int32, LookupSettings, FieldWithValue, Database, DbTransaction) 
RemoveDocumentSchemaField Removes document schema field
RemoveEventHistory 
RemoveEventNotifications 
SetFieldsOrder Sets order of fields for particular schema
SynchronizeDBLookUpField(Int32) Synchronize a single DB lookup metadata field
SynchronizeDBLookUpField(Int32, Database, DbTransaction) 
UpdateDocumentControlField Update an existing Document Control Field.
UpdateEvent Change the definition of an event.
UpdateVersionControlField Update an existing version control field.
VerifyConnection Check connection to given data source.
VerifyFieldSourceSettings Verifies source settings of specified field
VerifyLookupConnection Check connection to given lookup data source.
VerifySourceSettings Verifies specified source settings

Extension Methods

See Also