Click or drag to resize

Database Interface

Database Class

Namespace:  SuperOffice.COM.SuperOfficeDB
Assembly:  SuperOfficeDB.Interop (in SuperOfficeDB.Interop.dll) Version: 8.0.0.0
Syntax
public interface Database : IDatabase

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
Methods
  NameDescription
Public methodCode exampleAddDocument
Add an existing file to the document archive, returning a new document object for the file.
(Inherited from IDatabase.)
Public methodCode exampleAddDocumentForAssociate
Add an existing file to the document archive on behalf of some associate, returning a new document object for the file.
(Inherited from IDatabase.)
Public methodCode exampleCreateAppointment
Returns a blank Appointment. Use SetDefaults on the returned object to fill it with sensible data.
(Inherited from IDatabase.)
Public methodCreateAppointmentSentry (Inherited from IDatabase.)
Public methodCreateAssociate
method CreateAssociate
(Inherited from IDatabase.)
Public methodCode exampleCreateContact
Returns a blank Contact object. Use SetDefaults on the contact object to fill it with sensible data.
(Inherited from IDatabase.)
Public methodCreateContactSentry (Inherited from IDatabase.)
Public methodCode exampleCreateDocument
Creates a blank document object. Use SetDefaults on the returned object to fill it with sensible data.
(Inherited from IDatabase.)
Public methodCode exampleCreatePerson
Return a blank Person object. Use SetDefaults on the returned object to fill it with sensible data.
(Inherited from IDatabase.)
Public methodCreatePersonSentry (Inherited from IDatabase.)
Public methodCode exampleCreateProject
Create a blank Project object. Use SetDefaults on the returned object to fill it with sensible data.
(Inherited from IDatabase.)
Public methodCode exampleCreateProjectMember
Create a new ProjectMember object.
(Inherited from IDatabase.)
Public methodCreateProjectSentry (Inherited from IDatabase.)
Public methodCode exampleCreateRelation
Create a blank Relation object. Use the Save() method to persist the object to the database.
(Inherited from IDatabase.)
Public methodCreateRelationSentry (Inherited from IDatabase.)
Public methodCode exampleCreateSale
Create a blank Sale object. Returns an error if you are not allowed to create sales. Use SetDefaults on the sale object to fill it with sensible data
(Inherited from IDatabase.)
Public methodCreateSaleSentry (Inherited from IDatabase.)
Public methodCode exampleCreateSaleStakeholder
Create a new SaleStakeholder object. Use SetDefaults on the sale object to fill it with sensible data
(Inherited from IDatabase.)
Public methodCode exampleCreateSelection
Create a blank Selection, Returns an error if the user us not allowed to create selections. Use SetDefaults on the selection object to fill it with sensible data
(Inherited from IDatabase.)
Public methodCreateSelectionSentry (Inherited from IDatabase.)
Public methodCode exampleExportBlobToFile
Copy a blob to a file
(Inherited from IDatabase.)
Public methodCode exampleGetADOConnection
Returns an ADO Connection object for the current database. Returns an error if this is the Application.Database object. To connect to the database we have made it simple to get the connection string. This will require some sort of login. GetADOConnection creates a new connection each time you call it, and its only possible to call it trough the SuperOfficedb Library, calling it from SOApplication will generate an error.
(Inherited from IDatabase.)
Public methodCode exampleGetADOConnectionString
Returns an ADO connection string corresponding to the current database To connect to the database we have made it simple to get the connection string. This will require some sort of login. GetADOConnection creates a new connection each time you call it, and its only possible to call it trough the SuperOfficedb Library, calling it from SOApplication will generate an error.

To connect to the database we have made it simple to get the connection string, this will only return the string and not build the connection.

This will require some sort of login. Its only possible to call GetADOConnectionString trough the SuperOfficeDB Library, calling it from SOApplication will generate an error.

(Inherited from IDatabase.)
Public methodCode exampleGetAppointment
Get an Appointment object by id. Returns an error if the appointment is hidden by sentry rules. Calling this function and passing 0 as appointmentID will create a new appointment object.
(Inherited from IDatabase.)
Public methodCode exampleGetAssociate
Returns an Associate object with a given associate id.
(Inherited from IDatabase.)
Public methodCode exampleGetAssociateList
Returns a list of associates (internal employees, associate.type=0) (internal employees, associate.type=0). Does not check if the associate is retired.
(Inherited from IDatabase.)
Public methodGetChecklist (Inherited from IDatabase.)
Public methodCode exampleGetContact
Returns a Contact object with a given ID. Returns an error if the contact is not readable.
(Inherited from IDatabase.)
Public methodCode exampleGetDocument
Get an existing document object. Returns an error if the document is hidden.
(Inherited from IDatabase.)
Public methodCode exampleGetDocumentFromPath
Find out if a given document is archived in SuperOffice. Returns the corresponding document object or NULL if no docplugin can recognize the path.
(Inherited from IDatabase.)
Public methodCode exampleGetExternalPersonList
Returns a list of all external users (associate.type=4)
(Inherited from IDatabase.)
Public methodGetFavouriteItems
Returns a collection of list items in the user's favourites for the given table.
(Inherited from IDatabase.)
Public methodCode exampleGetHeadings
Returns a collection of Headings for a given list. From CRM 5 we have added the possibility to sort list items under different headings, visible for all or only for some usergroups.
(Inherited from IDatabase.)
Public methodCode exampleGetHistoryItems
Returns a collection of list items in the user's history for the given table. These are the most recent items the current user have accessed.
(Inherited from IDatabase.)
Public methodCode exampleGetHistoryItemsByTableNameAndExtraId
Returns a collection of list items in the user's history for the given table name and extra id. These are the most recent items the current user have accessed.
(Inherited from IDatabase.)
Public methodCode exampleGetInvitations
Get a collection with all invitations for the logged in user
(Inherited from IDatabase.)
Public methodCode exampleGetList
Returns a collection of list items for a given list item table.

Returns IListTextItems containing all the items in the given table, filtered and grouped according to the current user's group, but without the headings.

Note that items that are repeated under more than one heading will be repeated in the list.

(Inherited from IDatabase.)
Public methodCode exampleGetListItem
Return a given List Item in a given list table.

Returns IListTextItems containing all the items in the given table, filtered and grouped according to the current user's group, but without the headings.

Note that items that are repeated under more than one heading will be repeated in the list.

(Inherited from IDatabase.)
Public methodCode exampleGetListItemByName
Return a given List Item in a given list table based on the text of the item rather than the id.

Returns IListTextItems containing all the items in the given table, filtered and grouped according to the current user's group, but without the headings.

Note that items that are repeated under more than one heading will be repeated in the list.

(Inherited from IDatabase.)
Public methodCode exampleGetLocationList
Returns a list of resources that are locations New in Seven.
(Inherited from IDatabase.)
Public methodCode exampleGetPerson
Get a Person object by person_id. Returns an error if the person is hidden by sentry rules.
(Inherited from IDatabase.)
Public methodCode exampleGetProject
Get an existing project from the database. Returns an error if the project is hidden.
(Inherited from IDatabase.)
Public methodCode exampleGetProjectMember
Get an existing ProjectMember by its projectmember_id
(Inherited from IDatabase.)
Public methodGetQuote
Get an existing Quote by its quote_id
(Inherited from IDatabase.)
Public methodGetQuoteAlternative
Get an existing QuoteAlternative by its quotealternative_id
(Inherited from IDatabase.)
Public methodGetQuoteLine
Get an existing QuoteLine by its quoteline_id
(Inherited from IDatabase.)
Public methodGetQuoteVersion
Get an existing QuoteVersion by its quoteversion_id
(Inherited from IDatabase.)
Public methodCode exampleGetRelation
Get a Relation object. Return an error if the relation is hidden. If you call the GetRelation function with 0, it will create a new relation, like Database.CreateRelation
(Inherited from IDatabase.)
Public methodCode exampleGetResourceList
Returns a list of resources (associate.type = 1)
(Inherited from IDatabase.)
Public methodCode exampleGetSale
Get an existing Sale object by sale_id. Returns an error if the sale is hidden.
(Inherited from IDatabase.)
Public methodCode exampleGetSaleStakeholder
Get an existing SaleStakeholder by its salestakeholder_id
(Inherited from IDatabase.)
Public methodCode exampleGetSelection
Get an existing Selection. Returns an error if the selection is not visible for the user.
(Inherited from IDatabase.)
Public methodCode exampleGetStagesForSaleType
Returns the valid salestages for the given saletype New in Seven.
(Inherited from IDatabase.)
Public methodCode exampleImport
Perform unattended Import using an import description file created earlier. Returns true if the import succeeded.

The *.dsc file has information regarding the file mapping and what file should be imported (and where is it located).

There are 1 import description and 1 import text file available under \Examples\Import. Copy this to C:\Imp, and the example code will perform a successful import.

(Inherited from IDatabase.)
Public methodCode exampleImportBlobFromFile
Copy a file into the database. Returns the blob record id.

The *.dsc file has information regarding the file mapping and what file should be imported (and where is it located).

There are 1 import description and 1 import text file available under \Examples\Import. Copy this to C:\Imp, and the example code will perform a successful import.

(Inherited from IDatabase.)
Public methodCode exampleIsAnsiBase
Returns TRUE if database uses ANSI text, FALSE if it uses Unicode text From 6.2 our database support Unicode (UTF8 collating order), read more on Techdoc
(Inherited from IDatabase.)
Public methodCode exampleLogin
Log in to the database with the given user and password. Returns true if the login succeeded.
(Inherited from IDatabase.)
Public methodCode exampleRefresh
Reloads all the internal caches (lists, roles, users, etc).
(Inherited from IDatabase.)
Public methodCode exampleSubstituteTemplateVars
Substitutes template variables in the source string, returning the result. Assumes the current user.

This function will replace template variables in a string with the specified information, e.g. replace the <name> template variable with the text "SuperOffice AS". If you want to create your own template systems, you can access our substitution engine using this function. This will fill the values based on the logged in user.

Read More

(Inherited from IDatabase.)
Public methodCode exampleSubstituteTemplateVarsEx
Substitute template variables based on an associateid, returning the result.

This function will replace template variables in a string with the specified information, e.g. replace the <name> template variable with the text "SuperOffice AS". If you want to create your own template systems, you can access our substitution engine using this function. This will fill the values based on the logged in user.

Read More

This function will replace template variables in a string with the specified information, e.g. replace the <name> template variable with "SuperOffice AS". If you want to create your own template systems, you can access our substitution engine using this function. This will fill the values based on the associate provided.

Read More

(Inherited from IDatabase.)
Public methodCode exampleSubstituteTemplateVarsUrlEncoding
Substitute template variables based on an associateid, with the selected url encoding, returning the result.

This function will replace template variables in a string with the specified information, e.g. replace the <name> template variable with the text "SuperOffice AS". If you want to create your own template systems, you can access our substitution engine using this function. This will fill the values based on the logged in user.

Read More

This function will replace template variables in a string with the specified information, e.g. replace the <name> template variable with the text "SuperOffice AS". If you want to create your own template systems, you can access our substitution engine using this function. This will fill the values based on the logged in user.

Read More

(Inherited from IDatabase.)
Top
See Also