CommonDatabaseFunctions Class

Scanjour Workflow4 Reference Manual
Common database functions.
Inheritance Hierarchy

SystemObject
  Scanjour.Workflow4.BaseCommonDatabaseFunctions

Namespace:  Scanjour.Workflow4.Base
Assembly:  Scanjour.Workflow4.Base (in Scanjour.Workflow4.Base.dll) Version: 23.3.0.0 (23.3.0.0)
Syntax

public static class CommonDatabaseFunctions

The CommonDatabaseFunctions type exposes the following members.

Methods

  NameDescription
Public methodStatic memberAddCaseUpdateCode
Adds an update code to a case.
Public methodStatic memberAddRecordUpdateCode(ODataService, String, String)
Adds an update code to a record.
Public methodStatic memberAddRecordUpdateCode(Uri, String, String)
Adds an update code to a record.
Public methodStatic memberAddressExists
Determines if an address entities exists for the provided address key.
Public methodStatic memberClearRecordUpdateCode(ODataService, String)
Clears the update code of the specified record.
Public methodStatic memberClearRecordUpdateCode(Uri, String)
Clears the update code of the specified record.
Public methodStatic memberDeleteCase
Delete case with caseid
Public methodStatic memberDeleteCaseRecords
Delete records on case with caseid
Public methodStatic memberDeleteContacts
Deletes all contacts in the list of addressKeys
Public methodStatic memberDeleteObjects
Deletes all objects in a collection.
Public methodStatic memberExecuteODataQuery
Executes an OData query. The method expects that the result contains zero or one entities.
Public methodStatic memberExecuteODataQueryForMultiple
Executes an OData query. The method expects that the result is an enumeration of entities.
Public methodStatic memberGetAccessCodeForProtection
Construct an access code for a user
Public methodStatic memberGetActualImpersonator
Resolves the SecurityContext in case a user is a department
Public methodStatic memberGetAddressAlive
Gets the address for alive person value based on an addresskey.
Public methodStatic memberGetAddressCount
Determines the number of address entities for the provided address key.
Public methodStatic memberGetAddressKeyFromUsername
Retrives the key to the address that belongs to a username.
Public methodStatic memberGetAllGdprClassifications
Public methodStatic memberGetCaseOrDefaultGdprClassification
Gets a GDPR classification of case or system default.
Public methodStatic memberGetCaseParties
Gets parties on case with specified id
Public methodStatic memberGetCombinedRecordLength
Gets the DocLength of records from list
Public methodStatic memberGetCultureNameFromOData Obsolete.
Public methodStatic memberGetCustomDomains
Retrieves the customs domain entities of a specific domain type.
Public methodStatic memberGetCustomDomainValues
Gets the custom domain values, based on a domain type.
Public methodStatic memberGetDefaultFileClass
Gets the Default FileClass defined in WZExplorers
Public methodStatic memberGetDispatcher
Retrives a single dispatcher entity (if any) by its identity.
Public methodStatic memberGetDispatcherIds
Gets a list of dispatcher identities, based on the provided sequence identity.
Public methodStatic memberGetEmployee
Gets employee based on the identity.
Public methodStatic memberGetEmployeeFromNameCode
Gets employee based on the identity.
Public methodStatic memberGetFileOfficerFromFileKey
Retrieves the Officer of a case.
Public methodStatic memberGetImpersonatorContact
Get user as Contact
Public methodStatic memberGetInfo
Gets the corrosponding info message text
Public methodStatic memberGetLocalizedError
Retrieves a localized validation error, formatted with arguments.
Public methodStatic memberGetNextProcessDisplayOrder
Gets next Process DisplayOrder. If processDisplayOrder is provided - it will return a next free value.
Public methodStatic memberGetODataCultureName
Get the current user culture in the Users register from OData. Default system culture if current user has no culture info.
Public methodStatic memberGetODataServiceForUser
Gets odata service context for an impersonated user
Public methodStatic memberGetODataUsername
Get the current user name in the Users register from OData.
Public methodStatic memberGetODataUsernameWithCulture
Get the current user name and culture from the Users register in OData.
Public methodStatic memberGetOuDomain
Gets the OU (Organizational Unit) domain based on its value.
Public methodStatic memberGetProcessParameters(Uri, Guid)
Get all process parameters.
Public methodStatic memberGetProcessParameters(Uri, String)
Get all process parameters.
Public methodStatic memberGetRecordAppendixes
Gets a collection of appendixe entities based on a record identity.
Public methodStatic memberGetRecordCustomLabel
Gets the info value of the costumlabel specified, for a specific record
Public methodStatic memberGetRecordFileKey
Gets the record file key, based on a record identity.
Public methodStatic memberGetRecordGdprClassification
Gets record's GDPR Classification
Public methodStatic memberGetRecordOfficer
Gets employe domain entity based on a record identity.
Public methodStatic memberGetRecordResponsibleOu
Gets a records responsible ou based on the record identity.
Public methodStatic memberGetRecordState
Gets the state of a record entity.
Public methodStatic memberGetReferencedRecords
Gets a list of referenced record entitiess, based on record identity.
Public methodStatic memberGetSetting
Returns the setting for a key from the wzp_settings register.
Public methodStatic memberGetSettings
Returns the settings for a keys from the wzp_settings register.
Public methodStatic memberGetSettingWithFilter
Returns the setting for a key from the wzp_settings register. Optimized to be used for getting cache timestamp by only return setting if it exists
Public methodStatic memberGetSortedChannelPriorities
Gets the order of shipment types
Public methodStatic memberGetSystemOwner
Get the SystemOwner from OData.
Public methodStatic memberGetUserEmailAddress
Retrives an email address based on the address key.
Public methodStatic memberGetUsernameFromOData Obsolete.
Public methodStatic memberGetValidContactTypes
Gets all valid contact types.
Public methodStatic memberGetValidResponsibleOu
Determines the valid ResponsibleOu (Organizational Unit) from the record identity.
Public methodStatic memberGetWorkflowInstanceFileKey
Gets the file key from the case that started the process.
Public methodStatic memberHasExpired
Determine whether an object has expired due to its end date.
Public methodStatic memberHasFileAccess
Determines whether the current user has access to update a specific file entity.
Public methodStatic memberHasRecordAccess
Determines whether the current user has access to update a specific record entity.
Public methodStatic memberHasRegisterAccess
Determines whether the current user has access to update the specified entity in the specified register.
Public methodStatic memberHasSetting
Determines if a setting is defined by the provided module and key.
Public methodStatic memberSaveSetting
Writes or overwrites a setting with specified value.
Public methodStatic memberUserHasEmailAddress
Determine whether a user has an email address.
Top
Fields

  NameDescription
Public fieldStatic memberlastContact
The last impersonator NameCode
Public fieldStatic memberlastContactType
The last impersonator NameType_value
Public fieldStatic memberlastODataUri
The last OData connection
Top
See Also

Reference