IDocumentSettings

class IDocumentSettings

Bases: ImpactCOMWrapperBase

Summary:

Provides access to the document settings of a database.

Remarks:

Introduced in Impact 9.0.0.83.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property documents_cache_path

Gets documents_cache_path.

Summary:

Determines the network path where cached document thumbnails are stored.

Returns:

The value of documents_cache_path.

Return type:

documents_cache_path (str)

property groups

Gets Groups.

Summary:

An IDocumentGroups collection containing descriptions of the document groups stored by the underlying document provider.

Returns:

The value of Groups.

Return type:

groups (IDocumentGroups)

property max_document_size_mb

Gets max_document_size_mb.

Summary:

Returns the maximum allowed document size (in MB).

Remarks:

Introduced in Impact 11.0.0.8

Returns:

The value of max_document_size_mb.

Return type:

max_document_size_mb (int)

property meta_extractors

Gets meta_extractors.

Summary:

An IDocumentMetaExtractors collection containing all registered document meta-data extractors.

Returns:

The value of meta_extractors.

Return type:

meta_extractors (IDocumentMetaExtractors)

Examples:

property mime_types

Gets mime_types.

Summary:

An IDocumentMIMETypes collection containing descriptions of the document MIME types stored by the underlying document provider.

Returns:

The value of mime_types.

Return type:

mime_types (IDocumentMIMETypes)

property supports_changing_history_item_details

Gets supports_changing_history_item_details.

Summary:

Determines if the document configuration supports changing of history item details after creation.

Returns:

The value of supports_changing_history_item_details.

Return type:

supports_changing_history_item_details (bool)

property supports_data_purge

Gets supports_data_purge.

Summary:

Determines if the document provider supports purging of file data from documents.

Returns:

The value of supports_data_purge.

Return type:

supports_data_purge (bool)

Examples:

property supports_document_key

Gets supports_document_key.

Summary:

Determines if the underlying document provider supports identifying each document by an integer key.

Remarks:

Each document can always be uniquely identified by the IDocument.id property. However some document providers may also provider a unique IDocument.key integer property for each document. It is recommended to always use the IDocument.id property if possible.

Returns:

The value of supports_document_key.

Return type:

supports_document_key (bool)

property supports_major_and_minor_versions

Gets supports_major_and_minor_versions.

Summary:

Determines if the underlying document provider supports both major and minor version numbers.

Remarks:

The underlying document provider is responsible for assigning and incrementing version numbers for documents. This happens both when documents are created or updated. Typically each document provider supports either a [major] version numbering or a [major].[minor] version numbering scheme.

Returns:

The value of supports_major_and_minor_versions.

Return type:

supports_major_and_minor_versions (bool)

property supports_obliterate

Gets supports_obliterate.

Summary:

Determines if the underlying document provider supports obliterating of documents.

Remarks:

The obliteration of documents removes all trace of a specific document from document storage. Once a document has been obliterated it can never been retrieved.

Returns:

The value of supports_obliterate.

Return type:

supports_obliterate (bool)

Examples:

property supports_paging

Gets supports_paging.

Summary:

Determines if the underlying document provider supports paging of IDocuments collections.

Remarks:

The IDocumentContext object provides a context used to interact with an IDocuments object for setting up paging.

Returns:

The value of supports_paging.

Return type:

supports_paging (bool)

property supports_paging_forward_only

Gets supports_paging_forward_only.

Summary:

Determines if the underlying document provider supports forward only paging of IDocuments collections.

Remarks:

The supports_paging property must also be true. The IDocumentContext object provides a context used to interact with an IDocuments object for setting up paging.

Returns:

The value of supports_paging_forward_only.

Return type:

supports_paging_forward_only (bool)

property supports_revert_to

Gets supports_revert_to.

Summary:

Determines if the underlying document provider supports reverting to a specific document version.

Returns:

The value of supports_revert_to.

Return type:

supports_revert_to (bool)

property supports_searching

Gets supports_searching.

Summary:

Determines if the underlying document provider supports searching of documents.

Returns:

The value of supports_searching.

Return type:

supports_searching (bool)

property supports_searching_all_versions

Gets supports_searching_all_versions.

Summary:

Determines if the underlying document provider supports searching of all documents versions.

Returns:

The value of supports_searching_all_versions.

Return type:

supports_searching_all_versions (bool)

property supports_searching_deleted

Gets supports_searching_deleted.

Summary:

Determines if the underlying document provider supports searching of deleted and data purged documents.

Returns:

The value of supports_searching_deleted.

Return type:

supports_searching_deleted (bool)

property supports_searching_file_size

Gets supports_searching_file_size.

Summary:

Determines if the underlying document provider supports searching document file sizes.

Returns:

The value of supports_searching_file_size.

Return type:

supports_searching_file_size (bool)

property supports_tag_synonyms

Gets supports_tag_synonyms.

Summary:

Determines if the underlying document provider supports tag synonyms.

Returns:

The value of supports_tag_synonyms.

Return type:

supports_tag_synonyms (bool)

property supports_tagging_checked_out_documents_only

Gets supports_tagging_checked_out_documents_only.

Summary:

Determines if the underlying document provider supports tagging of documents when they are not checked out.

Returns:

The value of supports_tagging_checked_out_documents_only.

Return type:

supports_tagging_checked_out_documents_only (bool)

property supports_undelete

Gets supports_undelete.

Summary:

Determines if the underlying document provider supports undeleting documents.

Returns:

The value of supports_undelete.

Return type:

supports_undelete (bool)

property tags

Gets Tags.

Summary:

An IDocumentTags collection containing all of the document tags stored by the underlying document provider.

Returns:

The value of Tags.

Return type:

tags (IDocumentTags)

property thumbnail_generators

Gets thumbnail_generators.

Summary:

An IDocumentThumnailGenerators collection containing all registered document thumbnail generators.

Returns:

The value of thumbnail_generators.

Return type:

thumbnail_generators (IDocumentThumbnailGenerators)

Examples:

property types

Gets Types.

Summary:

An IDocumentTypes collection containing descriptions of the document types stored by the underlying document provider.

Returns:

The value of Types.

Return type:

types (IDocumentTypes)

Examples:

clear_documents_cache()
Summary:

Clears all cached document thumbnail files from the shared thumbnail cache network folder.

export_xml(xml_file)
Summary:

Export all document configuration settings to an XML file.

Remarks:

The export_xml/import_xml functions can be used to transfer document settings between Impact installations regardless of the underlying document provider. In addition to writing the XML file this function may also create a ‘Thumbnails’ folder containing all MIME type thumbnails in the destination folder. So both the exported XML settings file and ‘Thumbnails’ folder should be kept together.

Parameters:

xml_file (str) – The path of the XML file to generate.

Examples:

import_xml(xml_file)
Summary:

Import all document configuration settings from an XML file.

Remarks:

The export_xml/import_xml functions can be used to transfer document settings between Impact installations regardless of the underlying document provider. The XML file may contain references to MIME type thumbnails contained in an associated ‘Thumbnails’ folder.

Parameters:

xml_file (str) – The path of the XML file to import document settings from.

Examples:

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

Examples