Click or drag to resize

Database Properties

The Database type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleActualDSN
Actual DSN logged in, depends on superoffice.ini and travel status
(Inherited from IDatabase.)
Public propertyCode exampleActualPrefix
Actual Prefix of logged-in connection, depends on superoffice.ini and travel status Note: From CRM 5 we changed the prefix from SO to CRM5.
(Inherited from IDatabase.)
Public propertyCode exampleAdmin
Admin api. Must be logged in with user level 0 to access Admin api. Must be logged in with user level 0/functional right Field Administrator and/or List Administrator and/or User Administrator to access
(Inherited from IDatabase.)
Public propertyDatabase
Returns the Database object.
(Inherited from IDatabase.)
Public propertyCode exampleDataSourceType
Data source type - c-tree or ODBC type
(Inherited from IDatabase.)
Public propertyCode exampleDataSourceVariant
Data source variant - central, travel, satellite db
(Inherited from IDatabase.)
Public propertyCode exampleDictionary
Return a data dictionary object.
(Inherited from IDatabase.)
Public propertyCode exampleFind
Returns a Find object - has search functions that return collections The SOFind object contains a collection of methods for searching and retrieving data from the database.
(Inherited from IDatabase.)
Public propertyNotepadPage (Inherited from IDatabase.)
Public propertyCode exampleNotepadPages
Number of notepad pages for the current user Notepad is the small notepad that is accessed by CTRL + click on the Note in the taskbar. The notepad is a personal notebook, and is not connected to any contact or contact person. Notepad is the small notepad that is accessed by CTRL + click on the Note in taskbar. The notepad is a personal notebook, and is not connected to any contact or contact person.
(Inherited from IDatabase.)
Public propertyCode exampleNumbers
Returns an object for controlling the Number allocation system. The example with add a counter to one of the fields created in the SODictionarySDK examples.
(Inherited from IDatabase.)
Public propertyCode exampleOwnerContactId
Returns the id of the owner contact The owner contact is the most important contact in the database, if this contact is deleted or changed without a new key code from SuperOffice the database is destroyed so it will return an error if you try to change e.g the name of the contact object with contact_id = ownercontactid.
(Inherited from IDatabase.)
Public propertyCode exampleOwnerCountryId
Returns the id of the owner country The country a contact is saved with, affects the phone number format, and the address layout.
(Inherited from IDatabase.)
Public propertyCode examplePassword
Obsolete. Use SafeCredentials instead. Always returns blank now. OBSOLETE in Seven. Use SafeCredentials instead.
(Inherited from IDatabase.)
Public propertyCode examplePreferences
Preference settings object SOPreference can be used to get system properties and settings
(Inherited from IDatabase.)
Public propertyCode exampleRevision
Returns the Revision number (e.g release 5.6.30 returns 30)
(Inherited from IDatabase.)
Public propertyCode exampleSafeCredentials
A security token that can be used instead of username+password to log in New in Seven.
(Inherited from IDatabase.)
Public propertyCode exampleSettings
Get the database settings object - does not require login to use.
(Inherited from IDatabase.)
Public propertyStringResources
Returns a string resource manager.
(Inherited from IDatabase.)
Public propertyCode exampleSystemOwnerContactId
Get the system owner contact id (system wide). The owner contacts are contacts that may own associates, and they are the most important contacts in the database. If these contacts are deleted or changed without a new key code from SuperOffice the database may be destroyed. In a system with several databases (satellites), there will be other owner companies. The contact_id of this company will be returned when asking for OwnerContactId.
(Inherited from IDatabase.)
Public propertyCode exampleTimeZones
Returns a TimeZone manager object with functions for converting and listing time zone information.
(Inherited from IDatabase.)
Public propertyCode exampleTravelInterface
Returns an object with Travel functions.
(Inherited from IDatabase.)
Public propertyCode exampleUserAssociateId
Returns the associate id of the logged in user Use with Database.GetAssociate to get information on the user.
(Inherited from IDatabase.)
Public propertyCode exampleUsername
The associate name of the current user.
(Inherited from IDatabase.)
Public propertyUtils
Returns a Utility interface. This interface may have reduced functionality in a release build
(Inherited from IDatabase.)
Public propertyCode exampleVersion
Returns the Version as a decimal (e.g. 5.6 or 6.0)
(Inherited from IDatabase.)
Top
See Also