| IQMS2 Interface |
The QMS backend interface, hosting all of the available QlikView Management Service API methods.
Namespace: PIX.Services.V12.Api2
Assembly:
SyntaxThe IQMS2 type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AbortTask |
Aborts a single task.
|
| AddSelections |
Adds or toggles the currently selected fields within a document.
|
| ClearLicense |
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 |
Clears the QlikView Server cache of the QlikView Management Service from the specified cache objects.
|
| ClearSelections |
Clears or unlocks the selection of the specified field. If the field is empty, all fields will be cleared/unlocked.
|
| CloseAndInstallExtensionObject |
Finalizes the uploads. This involves verifying that the upload is a valid package and that the installation is successful.
|
| CloseSession |
Closes a previously opened session towards a document on a QDS server.
|
| CreateSession |
Creates a session towards a document on a QDS server.
|
| DeleteSectionAccessTable |
Removes a single SectionAccessTable.
|
| DeleteServerObject |
Removes a server object from a document.
|
| DeleteTask |
Deletes a single task.
|
| FindEDX |
Finds all matching EDX tasks.
|
| FindTask |
Finds a single task given its name.
|
| 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
|
| GetAvailableDirectories |
Returns a list of available directory paths for a certain type of Directory Service Provider.
|
| GetAvailableDSProviders |
Returns the available Directory Service Providers supported by a certain Directory Service Connector.
|
| GetCALConfiguration |
Gets the current session/document and named CAL configuration from a QVS.
|
| GetCALInfoForUser |
Gets the licenses currently used by a certain user.
|
| GetCategories |
Returns all categories matching the given scope.
|
| GetDistributionGroups |
Gets QDS loadbalancer groups for specific QDS.
|
| GetDistributionGroupsDefinition |
Gets QDS loadbalancer group definition for specific QDS.
|
| GetDocumentBookmarkNames |
Retrieves a list of all document book marks defined in the document.
|
| GetDocumentFolder |
Gets the document folder with the specified ID.
|
| GetDocumentMetaData |
Gets the document metadata.
|
| GetDocumentTask |
Gets the document task. The scope parameter is used to define what information to retrieve about the task.
|
| GetDSCAPISettings |
Gets Directory Service Connector (DSC) settings.
|
| GetDSPAPISettings |
Gets Directory Service Provider (DSP) settings.
|
| GetDSResources |
Returns all Directory Services managed by a certain Directory Service Connector.
|
| GetEDXTaskStatus |
Gets the EDX task status.
|
| GetFieldContentList |
Retrieves the values for a specific field. It is possible to retrieve only the currently selected values or all values for the field.
|
| GetFieldList |
Retrieves all available fields from a document.
|
| GetLicense |
Retrieves the currently set license for a service.
|
| GetQDSSettings |
Retrieves the current settings for the QlikView Distribution service with the specified ID.
|
| GetQMSVersion |
Get the current QlikView version.
|
| GetQVPRAPISettings |
Gets QVPR settings.
|
| GetQVSDocumentsAndUsers |
Gets each document loaded on the QVS and the users connected to each on respectively.
|
| GetQVSDocumentsPerUser |
Gets the number of documents each user on the QVS is connected to.
|
| GetQVSPerformanceData |
Gets QVS performance data.
|
| GetQVSSettings |
Gets settings for the QlikView Server with the specified ID.
|
| GetQVSUtilizationData |
Gets QVS utilization data.
|
| GetQVWSAuthentication |
Gets the authentication type for the QlikView WebServer (QVWS).
|
| GetQVWSSetting |
Gets QlikView WebServer (QVWS) settings.
|
| GetReloadEngineServices |
Gets all reload engine services.
|
| GetReports |
Retrieves reports defined within a document.
|
| GetSectionAccessTable |
Retrieves a single SectionAccessTable. The scope parameter is used to control how much information that
should be included.
|
| GetSectionAccessTableByName |
Retrieves a SectionAccessTable by name.
|
| GetSectionAccessTables |
Retrieves all defined SectionAccessTable's. Each table contains information about its columns, but no table data is returned.
|
| GetServerObjectMetaDataForUser |
Retrieves a list of all ServerObjectMetaData objects from a QlikView Server, accessible to a certain user.
|
| GetServerObjects |
Retrieves a list of server objects from a document.
|
| GetServices |
Gets information about all registered services of the specified type.
|
| GetServiceStatuses |
Gets the status of all services which matches the provided list of service ID's.
|
| GetSourceDocumentFolders |
Gets all source document folders for the QlikView Distribution Service with the specified ID.
|
| GetSourceDocumentNodes |
Gets source document nodes for the specified relative path and the specified source document folder and QlikView Distribution Service ID.
|
| GetSourceDocuments |
Gets all source documents for the QlikView Distribution Service with the specified ID.
|
| GetTask |
Retrieves a single task using its id.
|
| GetTasks |
Retrieves all task from a QDS.
|
| GetTasksForDocument |
Gets the tasks for document.
|
| GetTaskStatus |
Gets the status of a task.
|
| GetTaskStatuses |
Gets the task statuses.
|
| GetTaskStatusNodes |
Gets the task status nodes.
|
| GetTemplateFolderId |
Gets ID for QDS template source document folder
|
| GetTimeLimitedServiceKey |
Gets a time limited service key.
|
| GetUserDocumentFolders |
Gets all user document folders for the QlikView Server with the specified ID.
|
| GetUserDocumentNodes |
Gets user document nodes for the specified relative path and the specified user document folder and QlikView Server ID.
|
| GetUserDocuments |
Gets all user documents for the QlikView Server with the specified ID.
|
| HasAnyDistributionGroups |
Check if any QDS loadbalancer groups exist.
|
| ImportAllDocumentTasksForQds |
Imports all document tasks from a remote QlikView Distribution Server.
|
| ImportDocumentTask |
Imports a single document task from a remote QlikView Distribution Server.
|
| InitiateUploadExtensionObject |
Initiates an new upload of an extension object.
|
| IsPublisherQDS |
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.
|
| LookupNames |
Given a list of user or group names, this method performs a lookup of each name on a Directory Service Connector.
|
| Ping |
Pings this instance.
|
| QdsLoadBalancerConfigHasErrors |
Checks if there are new errors in the QDS load balancer configuration file.
|
| QDSNeedRestart |
Sets that the QDS needs a restart.
|
| QVSNeedRestart |
Sets that the QVS needs a restart.
|
| RemoteGetDocumentTask |
Retrieves a single task from a remote QlikView Management Service.
|
| RemoteGetServices |
Retrieves information about services managed by a remote QlikView Management Console.
|
| RemoteGetSourceDocumentFolders |
Gets all source document folders for a QlikView Distribution Service, managed by a remote QlikView Management Service, with the specified ID.
|
| RemoteGetSourceDocumentNodes |
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 |
Retrieves a list of all tasks for a specific document from a remote QlikView Management Service.
|
| RemoteGetTasks |
Retrieves all tasks from a remote QlikViewDistribution Service.
|
| ResolveUserGroups |
This method returns all groups that a certain user is a member of.
|
| RestartQDS |
Restarts the QDS.
|
| RestartQVS |
Restarts the QVS.
|
| RunTask |
Runs a single task.
|
| SaveCALConfiguration |
Saves the CAL configuration.
|
| SaveDocumentMetaData |
Saves the document metadata.
|
| SaveDocumentTask |
Saves the document task.
|
| SaveLicense |
Sets a license on a service. The license includes a LicenseType which is used together with the serviceID parameter to
find the correct service.
|
| SaveQDSSettings |
Updates the settings for a certain QlikView Distribution service.
|
| SaveQVSSettings |
Saves the specified QlikView Server settings.
|
| SaveSectionAccessTable |
Saves a SectionAccessTable. If the table does not exist, it will be created. Otherwise it will be updated.
|
| SelectServer |
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).
|
| SendDistributionServiceWorkorder |
Updates the configuration of a QlikView Distribution Service, includning task definitions.
|
| ServiceHasValidLicense |
Checks a service to see whether it has a valid license or not.
|
| SetDSCAPISettings |
Sets Directory Service Connector (DSC) Settings.
|
| SetDSPAPISettings |
Sets Directory Service Provider (DSP) Settings.
|
| SetQVPRAPISettings |
Sets QVPR settings.
|
| SetQVWSAuthentication |
Sets the authentication type for the QlikView WebServer (QVWS).
|
| SetQVWSSetting |
Sets QlikView WebServer (QVWS) settings.
|
| TakeServerObject |
Changes the owner of a server object.
|
| TriggerEDXTask |
Triggers an EDX task.
|
| UpdateLicense |
Updates the service with the current license. This will refresh the license for all the members of the service.
|
| UpdateServices(IDUrlDictionary, ServiceTypes) | |
| UpdateServices(DictionaryGuid, Uri, ServiceTypes) |
Updates the service with the specified URLs of the specified type.
|
| ValidateLicense |
Validates a license, making sure that the information that it contains is correct.
|
| WriteExtensionObject |
Uploads a piece of an extension object. The handle returned contains the current state of the upload.
|
See Also