Skip to main content Skip to complementary content

PIX.QMSAPI.DataObjects Namespace

Classes

Allotment
AssignedUser

Represents assigned user.

AssignedUserDeletion

Represents user assignment that should be deleted.

Assignment
Assignments

Represents assignments.

Category

Represents a single category.

CloudDeploymentSettings
DirectoryServiceConnectorAPISettings

Represents all configurable settings of a Directory Service Connector.

DirectoryServiceObject

Represents a directory service object.

DistributionConfigValues

Represents config values for the QDS load balancer distribution groups.

DocumentAccessEntry

Represents a single entry, controlling the access to a document.

DocumentAttribute

Name and Value of a document attribute

DocumentFolder

Represents a document folder.

DocumentFolder.DocumentFolderAdministrators

Administrators of the document folder.

DocumentFolder.DocumentFolderGeneral

General settings for the document folder.

DocumentFolder.DocumentFolderServices

Services settings for the document folder.

DocumentMetaData

Represents metadata of a document.

DocumentMetaData.DocumentMetaDataAuthorization

Class representing a document's authorization metadata.

DocumentMetaData.DocumentMetaDataCollaboration

Collaboration information in document metadata.

DocumentMetaData.DocumentMetaDataDocumentInfo

Document information in the document metadata.

DocumentMetaData.DocumentMetaDataLicensing

Licensing information in document metadata.

DocumentMetaData.DocumentMetaDataServer

Represents the server where the document should be available.

DocumentMetaData.DocumentMetaDataServer.DocumentMetaDataServerAccess

Server access level in the document metadata.

DocumentMetaData.DocumentMetaDataServer.DocumentMetaDataServerDocumentLoad

The Document Load element of the document metadata object.

DocumentNode

Represents the document node.

DocumentTask

Represents a document task.

DocumentTask.TaskDistribute

Task distribution settings.

DocumentTask.TaskDistribute.TaskDistributeCloudNative

Represents the distribution output.

DocumentTask.TaskDistribute.TaskDistributeDynamic

The Distribute Dynamic element of the document task data object.

DocumentTask.TaskDistribute.TaskDistributeNotification

Email notification settings.

DocumentTask.TaskDistribute.TaskDistributeOutput

Represents the distribution output.

DocumentTask.TaskDistribute.TaskDistributeOutput.TaskDistributeOutputPDF

Represents PDF distribution output.

DocumentTask.TaskDistribute.TaskDistributeStatic

Static distribution settings.

DocumentTask.TaskDocumentInfo

Document information - category, description and attributes.

DocumentTask.TaskGeneral

General settings for the task.

DocumentTask.TaskReduce

Reduction settings for the task.

DocumentTask.TaskReduce.TaskReduceDynamic

Dynamic reduction task settings.

DocumentTask.TaskReduce.TaskReduceStatic

Static reduction task settings.

DocumentTask.TaskReload

Represents reload settings for the task.

DocumentTask.TaskServer

Server related settings for the task.

DocumentTask.TaskServer.TaskServerAccess

Server access settings for the task.

DocumentTask.TaskServer.TaskServerCollaboration

Settings related to server collaboration.

DocumentTask.TaskServer.TaskServerDocumentLoading

The Server document loading element of the document task data object.

DocumentTask.TaskServer.TaskServerDocumentLoading.TaskServerDocumentLoadServerSetting

The Document Load element of the document metadata object.

DocumentTask.TaskServer.TaskServerDocumentLoading.TaskServerDocumentLoadServerSetting.TaskDocumentLoadClusterSetting

The Document Load element of the document metadata object.

DocumentTask.TaskTriggering

Triggering settings for the task.

DSProvider

Represents a Directory Service Provider (DSP).

DSPSettings

Represents the settings for a Directory Service Provider.

DSResource

Represents a Directory Service Resource (DSResource).

EDXStatus

EDX status.

EnumSupport
ExtensionUploadHandle

Holds information about an extension object upload.

Feature
GeneralLicenseOverview
License

Contains license information.

LicenseAllotment
LicenseAllotment.ProvisionType
LicenseDefinition

Represents signed key license definition.

LicenseDefinitionAllotment
LicenseFeature

Represents a license feature. A feature has a name and a value. Since the type of the value varies depending on the feature, it is of an object type.

LicenseOverview

Represents signed key license overview.

LicenseServerReturnValue
LicenseServerStatus
LogFileEntry

Represents a single log entry.

Provision
QDSDocumentSession

Represents a QDS session for a specific document.

QDSDocumentSessionConfiguration

Represents the configuration of a QDSDocumentSession and is used when creating a new session.

QDSSettings

Holds all the settings for a QlikView Distribution Service. Some of the settings applies only to unlicensed services.

QDSSettings.QDSAdvanced

Advanced QDS settings.

QDSSettings.QDSClusterInfo

Contains a references to a clustered Distribution Services.

QDSSettings.QDSEmail

Alert QDS email settings.

QDSSettings.QDSGeneral

General QDS settings.

QDSSettings.QDSLogin

Login for QDS administered on another computer.

QDSSettingsConstants
QMSVersion

Represents the QMS version in the following format: Major.Minor.Patch

QVLCModel
QVPRAPISettings

Represents all configurable settings of the QVPR.

QVSClusterMember

Represents a QlikView Server cluster member.

QVSFolderAdministrator

Represents a QlikView Server folder administrator.

QVSMessage

Represents a message received from a QlikView Server.

QVSMount

Represents QlikView Server mounted folder.

QVSSettings

Represents all configurable settings for a QlikView Server.

QVSSettings.QVSCluster

QlikView cluster settings.

QVSSettings.QVSCluster.QVSClusterLicense

QlikView Server cluster license.

QVSSettings.QVSDistribution

QlikView Server Distribution settings.

QVSSettings.QVSDocuments

Document related QlikView Server settings.

QVSSettings.QVSDocuments.QVSDocumentsObjects

QlikView Server document object settings.

QVSSettings.QVSDocuments.QVSDocumentsServer

QlikView Server document server settings.

QVSSettings.QVSFolders

Contains folder related QlikView Server settings, such as root folder and mounts.

QVSSettings.QVSFolders.QVSFoldersSystem

System of QlikView Server folders.

QVSSettings.QVSGeneral

Contains general QlikView Server settings, such as server name and login information.

QVSSettings.QVSLogging

Logging related QlikView Server settings, such as log folder and level.

QVSSettings.QVSLogging.QVSLoggingLevel

QlikView Server logging level.

QVSSettings.QVSPerformance

Represents the QlikView Server performance settings.

QVSSettings.QVSPerformance.QVSPerformanceCPU

Affinity and throttle for the QlikView Server.

QVSSettings.QVSPerformance.QVSPerformanceDocument

QlikView Server document performance settings.

QVSSettings.QVSPerformance.QVSPerformanceSessions

QlikView Server sessions performance settings.

QVSSettings.QVSPerformance.QVSPerformanceWorkingSetMemory

Minimum and maximum physical RAM that is allocated to, and can be used by QlikView Server.

QVSSettings.QVSSecurity

QlikView Server security settings.

QVSSettings.QVSSecurity.QVSSecurityAuthentication

QlikView Server authentication settings.

QVSSettings.QVSSecurity.QVSSecurityAuthorization

QlikView Server authorization settings.

QVSSupervisionAccount

Represents a supervision account.

QVWSAuthentication

QlikView WebServer authentication.

QVWSSettings

Represents the settings for a QlikView WebServer.

SectionAccessTable

Represents a table which defines how a document is to be reduced combined with which user that should see each reduction.

SectionAccessTable.SectionAccessCell

Represents a single cell.

SectionAccessTable.SectionAccessColumn

Represents a single column

SectionAccessTable.SectionAccessRow

Represents a single row.

ServerObject

Represents a server object which can be shared with other users.

ServerObjectMetaData

Represents metadata about a server object.

ServiceInfo

Holds information about a single service.

ServiceStatus

Represents the status of a service. Depending on the type of the service, its composition can be either clustered or single. A clustered service has at least one member, a single service has only one member.

ServiceStatusDetail

This class provides details about the status of a service member. A service can contain one or several members, depending on the type of service and current configuration.

TaskDistributionDestination

Represents the destination of a distribution.

TaskDistributionDestination.TaskDistributionDestinationFolder

Represents distribution destination of the type Folder.

TaskDistributionDestination.TaskDistributionDestinationQlikViewServer

Represents distribution destination of the type QlikView Server.

TaskDistributionEntry

Represents a taks distribution entry.

TaskExecutionItem

Task execution item.

TaskInfo

Represents task info.

TaskLogHistoryEntries
TaskReduction

Represents task reduction.

TaskReduction.TaskReductionBookmark

Represents the bookmark the data is reduced on.

TaskReduction.TaskReductionField

Represents the field the data is reduced on.

TaskStatus

The Task Status data object.

TaskStatus.TaskStatusExtended

The Extended element of the task status node request data object.

TaskStatus.TaskStatusGeneral

The General element of the task status node request data object.

TaskStatusFilter

A filter class used when requesting task statuses.

TaskStatusFilter.Interval

Base class for interval filter.

TaskStatusFilter.LastExecutionInterval

Represents a Date/Time interval.

TaskStatusFilter.ScheduleInterval

Schedule task status filter.

TaskStatusNode

The Task Status Node data object.

TaskStatusNodeRequest

The Task Status Node Request data object.

TriggerEDXTaskResult

Represents the result of an EDX task.

Unit
Usage
UserNxLicenseUsage

Enums

CALConfigurationScope

Represents the various CAL types and can be used when retrieving the CAL configuration.

This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

DirectoryServiceObjectType

Directory Service object type.

DocumentAccessEntryMode

Document access entry mode (applicable for DMS mode).

DocumentAccessMethods

Represents the possible methods for accessing a document.

DocumentCollaborationCreationMode

Allow server object creation.

DocumentFolderScope

Scope of the document folder.

DocumentFolderType

Type of the document folder.

DocumentLoadMode

Document load mode.

DocumentMetaDataScope

Document metadata scope.

DocumentTaskScope

Document task scope.

DocumentType

Type of the document.

DSPType

Directory service provider type.

DSResourceType

Directory Service resource type.

EDXTaskStartResult

The result types when starting an EDX task.

eStatusFlag

QlikView Distribution Service status flag.

LogType

Log type.

NamedCALIdentificationMode

Represents the various modes for identifying a named CAL.

QDSSectionAccessMode

QlikView Distribution Service section access mode.

QVPRBackupSchedule

QVPR backup schedule.

QVPRDbProvider

QVPR database provider.

QVSAuditLogLevel

QlikView Server audit log level.

QVSAuthenticationLevel

Authentication level for the QlikView Server.

QVSCacheObjects

The different available cache objects that can be used when calling PIX.Services.IQMS.ClearQVSCache(PIX.QMSAPI.DataObjects.QVSCacheObjects).

This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

QVSLogFileSplitMode

Way of splitting QlikView Server log file.

QVSLogVerbosity

Logging SystemLogVerbosity for the QlikView Server.

QVSSettingsScope

The different available scopes for a QVSSettings object.

This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

QVSSupervisionAccountType

Supervision account type for the QlikView Server.

QVSUserDocumentFolderType

All available QVSUserDocumentFolderType parameters. Sub folders are only available through the node interface.

QvWsAuthenticationType

QlikView WebServer authentication type.

QvWsLogginLevel

QlikView WebServer logging level.

QvWsLoginType

QlikView WebServer login address.

ServerDocumentLoadMode

Server document load mode.

ServiceTypes

The different service types.

This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

A combination of these can be used when calling IQMS.GetServices for example.

SQLConnectionModel

SQL connection model.

TaskDistributionDestinationType

Distribution destination type.

TaskDistributionOutputType

Distribution output type.

TaskReductionType

Task reduction type.

TaskReloadMode

Reload mode of the task.

TaskStatusNodeType

Type of task status node in the task tree.

TaskStatusScope

Determines how much of the task status information that should be retrieved when calling IQMS.GetTaskStatus for example.

This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

TaskStatusValue

Task status value.

TaskTriggerType

Task trigger type.

TaskType

The various task types.

TaskWizardTrack

Settings available in the task wizzard.

UserIdentityValueType

The different types of user identities.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Join the Analytics Modernization Program

Remove banner from view

Modernize without compromising your valuable QlikView apps with the Analytics Modernization Program. Click here for more information or reach out: ampquestions@qlik.com