IDatabaseSettings

class IDatabaseSettings

Bases: ImpactCOMWrapperBase

Description:

Describes the settings of a database.

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

property address_documents

Gets address_documents.

Description:

Indicates whether address documents are being used in this database.

Returns:

The value of address_documents.

Return type:

address_documents (bool)

property can_save

Gets can_save.

Description:

Indicates if the user has permission to modify the database installation settings

Remarks:

Introduced in Impact 12.0.0.157

Returns:

The value of can_save.

Return type:

can_save (bool)

property contact_documents

Gets contact_documents.

Description:

Indicates whether customer contact documents are being used in this database.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of contact_documents.

Return type:

contact_documents (bool)

Examples:

property customer_addresses

Gets customer_addresses.

Description:

Indicates whether customer addresses are being used in this database.

Returns:

The value of customer_addresses.

Return type:

customer_addresses (bool)

property customer_contacts

Gets customer_contacts.

Description:

Indicates whether customer contacts are being used in this database.

Returns:

The value of customer_contacts.

Return type:

customer_contacts (bool)

property customer_documents

Gets customer_documents.

Description:

Indicates whether customer documents are being used in this database.

Returns:

The value of customer_documents.

Return type:

customer_documents (bool)

property customer_sites

Gets customer_sites.

Description:

Indicates whether customer sites are enabled in this database.

Remarks:

Will only return true if db_sites is also true.

Returns:

The value of customer_sites.

Return type:

customer_sites (bool)

property db_sites

Gets db_sites.

Description:

Indicates whether sites are enabled in this database.

Returns:

The value of db_sites.

Return type:

db_sites (bool)

property document_provider

Gets document_provider.

Description:

An IDocumentProvider object representing the underlying document provider for the database.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of document_provider.

Return type:

document_provider (IDocumentProvider)

Examples:

property document_settings

Gets document_settings.

Description:

An IDocumentSettings object representing document settings for the database.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of document_settings.

Return type:

document_settings (IDocumentSettings)

Examples:

property enterprise_database_type

Gets enterprise_database_type.

Description:

Indicates in which Enterprise context the database is being used.

Remarks:

Introduced in Impact 7.0.0.10

Returns:

The value of enterprise_database_type.

Return type:

enterprise_database_type (ipEnterpriseDatabaseType)

property layer_documents

Gets layer_documents.

Description:

Indicates whether project layer documents are being used in this database.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of layer_documents.

Return type:

layer_documents (bool)

Examples:

property mts_sites

Gets mts_sites.

Description:

Indicates whether MTS sites are enabled in this database.

Remarks:

Will only return true if db_sites is also true.

Returns:

The value of mts_sites.

Return type:

mts_sites (bool)

property other_documents

Gets other_documents.

Description:

Indicates whether other documents are being used in this database.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of other_documents.

Return type:

other_documents (bool)

Examples:

property palettes

Gets Palettes.

Description:

Indicates whether a palette database table (PALETTE) is being used in this database.

Remarks:

Introduced in Impact 11.0.0.81

Returns:

The value of Palettes.

Return type:

palettes (bool)

property project_documents

Gets project_documents.

Description:

Indicates whether project documents are being used in this database.

Returns:

The value of project_documents.

Return type:

project_documents (bool)

Examples:

property project_sites

Gets project_sites.

Description:

Indicates whether project sites are enabled in this database.

Remarks:

Will only return true if db_sites is also true.

Returns:

The value of project_sites.

Return type:

project_sites (bool)

property site_documents

Gets site_documents.

Description:

Indicates whther site documents are being used in this database.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of site_documents.

Return type:

site_documents (bool)

Examples:

property symbol_documents

Gets symbol_documents.

Description:

Indicates whether symbol documents are being used in this database.

Returns:

The value of symbol_documents.

Return type:

symbol_documents (bool)

property table_relationship_options

Gets table_relationship_options.

Description:

Table relationship options

Returns:

The value of table_relationship_options.

Return type:

table_relationship_options (IDatabaseTableRelationshipOptions)

Examples:

property table_relationships

Gets table_relationships.

Description:

Returns a collection of the table relationships defined in the database.

Returns:

The value of table_relationships.

Return type:

table_relationships (IDatabaseTableRelationships)

Examples:

property tables

Gets Tables.

Description:

An IDatabaseTables collection containing descriptions of the tables contained in this database.

Returns:

The value of Tables.

Return type:

tables (IDatabaseTables)

property template_documents

Gets template_documents.

Description:

Indicates whether template documents are being used in this database.

Returns:

The value of template_documents.

Return type:

template_documents (bool)

property user_documents

Gets user_documents.

Description:

Indicates whether user documents are being used in this database.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of user_documents.

Return type:

user_documents (bool)

Examples:

get_format_settings_ids_for_table(table_name)
Description:

Retrieves the keys of the Formatted Strings master tool settings for the given table name.

Remarks:

Currently formatted strings are supported only for the “CUSTOMER” and “ADDRESS” tables. Introduced in Impact 11.0.0.40

Returns:

An array of long values, representing the MTS keys (or an empty array, if there are none).

Parameters:

table_name (str) – The table for which the formatted settings have been defined.

persisted_globals(name)
Description:

Gets (and possibly creates) an IGlobals collection that represents a named group of variables stored in the database.

Remarks:

In Impact, the persisted global variables can be found in the Database Installation setttings, Automation, Persisted Globals. Persisted globals are typically used by automation and plug-ins for storing database-wide settings. Persisted global variables are limited to the following data types: string, integer, long, single, double, boolean, date. In some circumstances, the persisted global variables might be read-only (for example at an Enterprise site database) so check the IGlobals.read_only property before attempting to modify any values. Persisted globals cannot be modified by nServer; only read access is permitted. After making any changes to persisted globals, it is necessay to use IDatabaseSettings.save to preserve the modifications. Introduced in Impact 12.0.0.159

Returns:

The variable group. If the group did not already exist, it is be created.

Parameters:

name (str) – The name of the desired variable group.

Examples:

save()
Description:

Saves any changes that were made to database installation settings.

Remarks:

After making any changes to persisted globals, it is necessay to use this method to preserve the modifications. Introduced in Impact 12.0.0.157

Returns:

Returns True if the settings were successfully saved.

Examples