QueueSystem.ReadQueueConfiguration Method

Article
10/17/2013

Gets the configuration settings of the specified queue in Project Server.

Namespace: WebSvcQueueSystem
Assembly: ProjectServerWebServices (in ProjectServerWebServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/office/project/server/webservices/QueueSystem/ReadQueueConfiguration", RequestNamespace := "http://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",  _
    ResponseNamespace := "http://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ReadQueueConfiguration ( _
    queueId As QueueID _
) As String

'Usage
Dim instance As QueueSystem
Dim queueId As QueueID
Dim returnValue As String

returnValue = instance.ReadQueueConfiguration(queueId)

[SoapDocumentMethodAttribute("http://schemas.microsoft.com/office/project/server/webservices/QueueSystem/ReadQueueConfiguration", RequestNamespace = "http://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", 
    ResponseNamespace = "http://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public string ReadQueueConfiguration(
    QueueID queueId
)

Parameters

queueId
Type: WebSvcQueueSystem.QueueID
One of the QueueID enumeration values ProjectQ or TimesheetQ.

Return Value

Type: System.String
Queue settings in XML format.

Remarks

You can create settings for the Project and Timesheet queues on the Queue Settings page in Project Web Access (http://ServerName/ProjectServerName/_layouts/pwa/Admin/queuesettings.aspx).

Project Server Permissions

Permission	Description
ManageQueue	Manage the Project Server queue. Global permission.

Examples

. . .
QueueSystemWS.QueueID qType = QueueSystemWS.QueueID.ProjectQ;
string qConfig = q.ReadQueueConfiguration(qType);

The example code fragment returns the following default results for the Project queue.

<?xml version="1.0" encoding="utf-8"?>
<queueconfigurationsettings>
  <setting name="MaxThreads" value="4" />
  <setting name="QueueTimeout" value="3" />
  <setting name="MsgRetryInterval" value="1000" />
  <setting name="MsgRetryLimit" value="5" />
  <setting name="GrpRetryLimit" value="5" />
  <setting name="SqlRetryInterval" value="1000" />
  <setting name="SqlRetryLimit" value="5" />
  <setting name="PollingInterval" value="1000" />
  <setting name="RestartThrottle" value="60000" />
  <setting name="EnablePerfMon" value="1" />
  <setting name="PeriodicTasksInterval" value="10000" />
  <setting name="CleanupSuccessAgeLimit" value="24" />
  <setting name="CleanupNonSuccessAgeLimit" value="168" />
  <setting name="CleanupInterval" value="24" />
  <setting name="CleanupIntervalOffset" value="0" />
  <setting name="SqlCommandTimeout" value="1800" />
  <setting name="FastPolling" value="1" />
</queueconfigurationsettings>