IQMS5 Interface
Assembly: PIX.dll
The QMS backend interface, hosting all of the available QlikView Management Service API methods.
Syntax
public interface IQMS5Methods
| Name | Description |
|---|---|
| AbortDocument(Guid, String) | |
| AbortTask(Guid) |
Aborts a single task. |
| AddSelections(QDSDocumentSession, List<FieldContent>, Boolean, Boolean, Boolean) |
Adds or toggles the currently selected fields within a document. |
| BackupNow(String) | |
| CheckLicenseServerStatus() |
Gets license service status. |
| ClearLicense(LicenseType, Guid) |
Clears the license for a service. After this method has been called, the service will be unlicensed and might not be available until a new license has been applied. Only the QlikViewServer-license type is currently supported. |
| ClearQVSCache(QVSCacheObjects) |
Clears the QlikView Server cache of the QlikView Management Service from the specified cache objects. |
| ClearReportManagerLicenseCache() | |
| ClearSelections(QDSDocumentSession, String, DocumentClearOptions) |
Clears or unlocks the selection of the specified field. If the field is empty, all fields will be cleared/unlocked. |
| CloseAndInstallExtensionObject(ExtensionUploadHandle) |
Finalizes the uploads. This involves verifying that the upload is a valid package and that the installation is successful. |
| CloseSession(QDSDocumentSession) |
Closes a previously opened session towards a document on a QDS server. |
| CreateDefaultDocumentTask(Guid, DocumentNode) | |
| CreateSession(QDSDocumentSessionConfiguration) |
Creates a session towards a document on a QDS server. |
| DeleteAssignedUsers(List<AssignedUserDeletion>) |
Deletes assigned users. |
| DeleteCustomGroup(Guid, String) | |
| DeleteCustomUser(Guid, String) | |
| DeleteDocumentAdministrators(Guid, List<String>) |
Delete a list of users as document administrators |
| DeleteSectionAccessTable(Guid) |
Removes a single SectionAccessTable. |
| DeleteServerObject(Guid, String, String) |
Removes a server object from a document. |
| DeleteTask(Guid, TaskType) |
Deletes a single task. |
| DistributeCertsIfPossible(IEnumerable<Uri>, ServiceTypes) | |
| FindEDX(String) |
Finds all matching EDX tasks. |
| FindTask(Guid, TaskType, String) |
Finds a single task given its name. |
| GenerateCloudDeploymentConfig(String, Boolean) | |
| GetActiveTaskTriggersFromCache(Guid) | |
| GetAdminDocList(Guid, QvsDocList.eDocumentListType, String) | |
| GetAdminDocListForUser(Guid, String, List<String>, Boolean) | |
| GetAlertText() |
Returns a simple text message describing the current state of the QMS. |
| GetAllDistributionGroups() |
Gets all QDS loadbalancer groups. |
| GetAllMissingDistributionGroups() |
Gets all missing QDS loadbalancer groups from the cache |
| GetAllowedQlikviewNodesNxLicense(LicenseDefinition, String) | |
| GetAllSchedules(Guid) | |
| GetAssignedUsers(String) |
Gets assigned users. |
| GetAvailableDirectories(Guid, String) |
Returns a list of available directory paths for a certain type of Directory Service Provider. |
| GetAvailableDSProviders(Guid) |
Returns the available Directory Service Providers supported by a certain Directory Service Connector. |
| GetCALConfiguration(Guid, CALConfigurationScope) |
Gets the current session/document and named CAL configuration from a QVS. |
| GetCALInfoForUser(Guid, String) |
Gets the licenses currently used by a certain user. |
| GetCategories(CategoriesScope) |
Returns all categories matching the given scope. |
| GetCloudDeploymentSettings(Guid) | |
| GetConfig(Guid) | |
| GetCustomGroupList(Guid) | |
| GetCustomUserList(Guid) | |
| GetDBCommandTask(Guid, Guid) | |
| GetDBCommandTasks(Guid) | |
| GetDefaultServiceAddress(ServiceTypes) | |
| GetDistributionGroups(Guid) |
Gets QDS loadbalancer groups for specific QDS. |
| GetDistributionGroupsDefinition(Guid) |
Gets QDS loadbalancer group definition for specific QDS. |
| GetDistributionResourceList(Guid) | |
| GetDocumentBookmarkNames(QDSDocumentSession) |
Retrieves a list of all document book marks defined in the document. |
| GetDocumentFolder(Guid, DocumentFolderScope) |
Gets the document folder with the specified ID. |
| GetDocumentFolderAdministrators(Guid) |
Get a list of document folder administrators |
| GetDocumentLog(Guid, Guid) | |
| GetDocumentMetaData(DocumentNode, DocumentMetaDataScope) |
Gets the document metadata. |
| GetDocumentTask(Guid, DocumentTaskScope) |
Gets the document task. The scope parameter is used to define what information to retrieve about the task. |
| GetDSCAPISettings(Guid) |
Gets Directory Service Connector (DSC) settings. |
| GetDSCChangedConfigSettings(Guid) | |
| GetDSCSettings(Guid) | |
| GetDSPAPISettings(Guid, DSPType) |
Gets Directory Service Provider (DSP) settings. |
| GetDSPSettings(Guid, String) | |
| GetDSResources(Guid) |
Returns all Directory Services managed by a certain Directory Service Connector. |
| GetEDXTaskStatus(Guid, Guid) |
Gets the EDX task status. |
| GetExternalProgramTask(Guid, Guid) | |
| GetExternalProgramTasks(Guid) | |
| GetFieldContentList(QDSDocumentSession, String, FieldContentType, Int32, Int32) |
Retrieves the values for a specific field. It is possible to retrieve only the currently selected values or all values for the field. |
| GetFieldList(QDSDocumentSession) |
Retrieves all available fields from a document. |
| GetFiles(Guid, String, String) | |
| GetLatestTaskLog(Guid, Int32) | |
| GetLicense(LicenseType, Guid) |
Retrieves the currently set license for a service. |
| GetLicenseOverview() |
Returns overview of signed key license. |
| GetLicenseServiceSettings(Guid) | |
| GetLicenseStatus() | |
| GetLoadedDocuments(Guid) | |
| GetLoadedDocuments(Guid, QueryTarget) | |
| GetMailSettings() | |
| GetMyComputer(Guid) | |
| GetMyNetworkPlaces(Guid) | |
| GetNewLicense() |
Retrieves the currently set signed key license. |
| GetNewLicenseStatus() | |
| GetOldTaskCategories() | |
| GetPauseTask(Guid, Guid) | |
| GetPauseTasks(Guid) | |
| GetPossibleCustomGroupMembers(Guid, String) | |
| GetQDSChangedConfigSettings(Guid) | |
| GetQDSDiagnosticsDocumentAddress() | |
| GetQDSDocumentInfo(Guid, String) | |
| GetQDSSettings(Guid, QDSSettingsScope) |
Retrieves the current settings for the QlikView Distribution service with the specified ID. |
| GetQMSChangedConfigSettings(String) | |
| GetQMSSettings() | |
| GetQMSVersion() |
Get the current QlikView version. |
| GetQvdCreationTask(Guid, Guid) | |
| GetQvdCreationTasks(Guid) | |
| GetQVPRAPISettings() |
Gets QVPR settings. |
| GetQVPRSettings() | |
| GetQVSDiagnosticsDocumentAddress() | |
| GetQVSDocumentsAndUsers(Guid, QueryTarget) |
Gets each document loaded on the QVS and the users connected to each on respectively. |
| GetQVSDocumentsPerUser(Guid, QueryTarget) |
Gets the number of documents each user on the QVS is connected to. |
| GetQVSLicenseInfo(Guid) |
Gets QlikView Server license model. |
| GetQVSPerformanceData(Guid, QueryTarget) |
Gets QVS performance data. |
| GetQVSSettings(Guid, QVSSettingsScope) |
Gets settings for the QlikView Server with the specified ID. |
| GetQVSUtilizationData(Guid, QueryTarget) |
Gets QVS utilization data. |
| GetQvWebSettings(Guid) | |
| GetQVWSAuthentication(Guid) |
Gets the authentication type for the QlikView WebServer (QVWS). |
| GetQVWSChangedConfigSettings(Guid) | |
| GetQVWSSetting(Guid) |
Gets QlikView WebServer (QVWS) settings. |
| GetReloadEngineServices() |
Gets all reload engine services. |
| GetRemoteQmsSettings(Guid) | |
| GetReports(QDSDocumentSession) |
Retrieves reports defined within a document. |
| GetSectionAccessTable(Guid, SectionAccessScope) |
Retrieves a single SectionAccessTable. The scope parameter is used to control how much information that should be included. |
| GetSectionAccessTableByName(String, SectionAccessScope) |
Retrieves a SectionAccessTable by name. |
| GetSectionAccessTables(SectionAccessScope) |
Retrieves all defined SectionAccessTable's. Each table contains information about its columns, but no table data is returned. |
| GetServerObjectMetaDataForUser(Guid, String) |
Retrieves a list of all ServerObjectMetaData objects from a QlikView Server, accessible to a certain user. |
| GetServerObjects(Guid, String) |
Retrieves a list of server objects from a document. |
| GetServiceByAddress(ServiceTypes, Uri) | |
| GetServices(ServiceTypes) |
Gets information about all registered services of the specified type. |
| GetServiceStatuses(List<Guid>) |
Gets the status of all services which matches the provided list of service ID's. |
| GetShares(Guid, String) | |
| GetSourceDocumentFolders(Guid, DocumentFolderScope) |
Gets all source document folders for the QlikView Distribution Service with the specified ID. |
| GetSourceDocumentNodes(Guid, Guid, String) |
Gets source document nodes for the specified relative path and the specified source document folder and QlikView Distribution Service ID. |
| GetSourceDocuments(Guid) |
Gets all source documents for the QlikView Distribution Service with the specified ID. |
| GetSubFolders(Guid, String) | |
| GetSysInfoForLogging(Assembly) | |
| GetSystemInformation(eServiceTypes) | |
| GetTask(Guid) |
Retrieves a single task using its id. |
| GetTaskAvgExecutionTimeForSuccessfullExecutions(Guid) | |
| GetTaskCachedExecutionHistory(Guid, String, String) | |
| GetTaskExecutionHistory(Guid) | |
| GetTaskInfoListForUser(String) | |
| GetTaskLog(Guid, Guid, Int32) | |
| GetTaskLogHistory(Guid) | |
| GetTaskLogHistoryEntries(Guid) | |
| GetTasks(Guid) |
Retrieves all task from a QDS. |
| GetTasksForDocument(Guid) |
Gets the tasks for document. |
| GetTaskStatus(Guid, TaskStatusScope) |
Gets the status of a task. |
| GetTaskStatuses(TaskStatusFilter, TaskStatusScope) |
Gets the task statuses. |
| GetTaskStatusNodes(List<TaskStatusNodeRequest>, TaskStatusFilter, TaskStatusScope) |
Gets the task status nodes. |
| GetTemplateFolderId() |
Gets ID for QDS template source document folder |
| GetTimeLimitedServiceKey() |
Gets a time limited service key. |
| GetUserDocumentFolders(Guid, DocumentFolderScope) |
Gets all user document folders for the QlikView Server with the specified ID. |
| GetUserDocumentNodes(Guid, Guid, String) |
Gets user document nodes for the specified relative path and the specified user document folder and QlikView Server ID. |
| GetUserDocuments(Guid) |
Gets all user documents for the QlikView Server with the specified ID. |
| GetUserDocumentSchedule(Guid, String) | |
| GetWizardConfig() | |
| HasAnyDistributionGroups() |
Check if any QDS loadbalancer groups exist. |
| ImportAllDocumentTasksForQds(Guid, Guid, Guid) |
Imports all document tasks from a remote QlikView Distribution Server. |
| ImportDocumentTask(Guid, Guid, Guid, DocumentNode) |
Imports a single document task from a remote QlikView Distribution Server. |
| InitiateUploadExtensionObject(Guid) |
Initiates an new upload of an extension object. |
| IsDocumentFolderAdministrator() |
Check if cucrent user is document administrator |
| IsDocumentFolderAdministratorForFolder(Guid) |
Check if cucrent user is document administrator for a specified folder |
| IsDocumentFolderAdministratorForType(ePermissionObjectType) |
Check if cucrent user is document administrator for a specified type |
| IsNxLicenseOk() | |
| IsOEMLicensed() | |
| IsPublisherQDS(Guid) |
This method checks if a QlikView Distribition Service has a publisher license or not. |
| IsQdsLoadbalancerConfigured() |
Check if the QDS load balancing setting has been configured. |
| IsSupervisionAccount(String) | |
| IsSystemRunningWithNewLicenseModel() | |
| IsUserDocumentFolderAdministrator(String) |
Check if a user is document administrator |
| IsUserDocumentFolderAdministratorForFolder(String, Guid) |
Check if a user is document administrator for a folder |
| LookupNames(Guid, List<String>) |
Given a list of user or group names, this method performs a lookup of each name on a Directory Service Connector. |
| MigrateStandardEditionSchedule(Guid) | |
| Ping() |
Pings this instance. |
| PingQVS(Guid) | |
| QDSDiagnosticsEnabled() | |
| QdsLoadBalancerConfigHasErrors() |
Checks if there are new errors in the QDS load balancer configuration file. |
| QDSNeedRestart(Guid, out String) |
Sets that the QDS needs a restart. |
| QVSDiagnosticsEnabled() | |
| QVSGetDocumentInfo(Guid, String) | |
| QVSNeedRestart(Guid, out String) |
Sets that the QVS needs a restart. |
| ReloadDocument(Guid, String) | |
| RemoteGetDocumentTask(Guid, Guid, DocumentTaskScope) |
Retrieves a single task from a remote QlikView Management Service. |
| RemoteGetServices(Guid, ServiceTypes) |
Retrieves information about services managed by a remote QlikView Management Console. |
| RemoteGetSourceDocumentFolders(Guid, Guid, DocumentFolderScope) |
Gets all source document folders for a QlikView Distribution Service, managed by a remote QlikView Management Service, with the specified ID. |
| RemoteGetSourceDocumentNodes(Guid, Guid, Guid, String) |
Connects to a remote QlikView Management Service and retrieves the source document nodes for the specified relative path and the specified source document folder and QlikView Distribution Service ID. |
| RemoteGetTaskListForDocID(Guid, Guid) |
Retrieves a list of all tasks for a specific document from a remote QlikView Management Service. |
| RemoteGetTasks(Guid, Guid) |
Retrieves all tasks from a remote QlikViewDistribution Service. |
| RemoveAdditionalServices(IDUrlDictionary) | |
| RemoveUserAsTaskRecipient(String, Guid) | |
| ResolveEmailAddresses(Guid, String) | |
| ResolveUserGroups(Guid, String) |
This method returns all groups that a certain user is a member of. |
| RestartQDS(Guid) |
Restarts the QDS. |
| RestartQVS(Guid) |
Restarts the QVS. |
| RunTask(Guid) |
Runs a single task. |
| SaveCALConfiguration(CALConfiguration) |
Saves the CAL configuration. |
| SaveCustomGroup(Guid, String, CustomGroupObject) | |
| SaveCustomUser(Guid, String, CustomUserObject) | |
| SaveDBCommandTask(DBCommandTask) | |
| SaveDocumentMetaData(DocumentMetaData) |
Saves the document metadata. |
| SaveDocumentTask(DocumentTask) |
Saves the document task. |
| SaveExternalProgramTask(ExternalProgramTask) | |
| SaveLicense(License, Guid) |
Sets a license on a service. The license includes a LicenseType which is used together with the serviceID parameter to find the correct service. |
| SaveNewLicense(License, Guid, String) |
Sets a signed key license. |
| SaveNewLicenseEx(License) |
Sets a signed key license from version 12.50. |
| SavePauseTask(PauseTask) | |
| SaveQDSSettings(QDSSettings) |
Updates the settings for a certain QlikView Distribution service. |
| SaveQvdCreationTask(QvdCreationTask) | |
| SaveQVSSettings(QVSSettings) |
Saves the specified QlikView Server settings. |
| SaveSectionAccessTable(SectionAccessTable) |
Saves a SectionAccessTable. If the table does not exist, it will be created. Otherwise it will be updated. |
| SaveWizardConfig(MidSizeConfiguration) | |
| Search(Guid, List<String>, eDDDValueType, eSearchTypePix, String) | |
| SelectServer(Guid, String) |
Selects the QlikView Server (QVS) currently most suitable for opening the specified document according to the load balancing settings of the given QlikView WebServer (QVWS). |
| SelectServerEx(Guid, String) |
Selects the QlikView Server (QVS) currently most suitable for opening the specified document according to the load balancing settings of the given QlikView WebServer (QVWS) and return fully qualified host name. |
| SendDistributionServiceWorkorder(Guid) |
Updates the configuration of a QlikView Distribution Service, includning task definitions. |
| ServiceHasValidLicense(LicenseType, Guid) |
Checks a service to see whether it has a valid license or not. |
| SetAssignedUsers(List<AssignedUser>) |
Sets assigned users. |
| SetCloudDeploymentSettings(CloudDeploymentSettings) | |
| SetConfig(Guid, QvWebServerConfig) | |
| SetDocumentFolderAdministrator(Guid, String, ePermissionObjectType) |
Assign a user as a document administrator on a folder |
| SetDocumentFolderAdministratorForEmail(Guid, String) |
Assign a user as a document adminstrator for email |
| SetDSCAPISettings(DirectoryServiceConnectorAPISettings) |
Sets Directory Service Connector (DSC) Settings. |
| SetDSCSettings(DirectoryServiceConnectorSettings) | |
| SetDSPAPISettings(DSPSettings) |
Sets Directory Service Provider (DSP) Settings. |
| SetDSPSettings(DSPSettings) | |
| SetLicenseServiceSettings(LicenseServiceSettings) | |
| SetMailSettings(MailSettings) | |
| SetQMSSettings(QlikViewManagementServiceSettings) | |
| SetQVPRAPISettings(QVPRAPISettings, Boolean) |
Sets QVPR settings. |
| SetQVPRSettings(QVPRSettings, Boolean) | |
| SetQvWebSettings(QvWebSettings) | |
| SetQVWSAuthentication(Guid, QVWSAuthentication) |
Sets the authentication type for the QlikView WebServer (QVWS). |
| SetQVWSSetting(Guid, QVWSSettings) |
Sets QlikView WebServer (QVWS) settings. |
| SetRemoteQmsSettings(RemoteQmsSettings) | |
| SetTaskEnabled(Guid, Boolean) | |
| SetUserDocumentSchedule(Guid, UserDocumentSchedule) | |
| ShouldMigrateStandardEditionSchedule(Guid) | |
| ShutdownDistributionService(Guid, Guid, String) |
Stops the QDS service in a graceful maner |
| TakeServerObject(Guid, String, String, String) |
Changes the owner of a server object. |
| TriggerEDXTask(Guid, String, String, String, List<String>) |
Triggers an EDX task. |
| UpdateDocumentAdministratorEmail(Guid) |
Updates alert emails on tasks for documents that has a document admistrator |
| UpdateLicense(LicenseType, Guid) |
Updates the service with the current license. This will refresh the license for all the members of the service. |
| UpdateServices(IDUrlDictionary, ServiceTypes) | |
| UpdateServices(Dictionary<Guid, Uri>, ServiceTypes) |
Updates the service with the specified URLs of the specified type. |
| ValidateLicense(License) |
Validates a license, making sure that the information that it contains is correct. |
| WriteExtensionObject(ExtensionUploadHandle, Byte[]) |
Uploads a piece of an extension object. The handle returned contains the current state of the upload. |
Extension Methods
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!
