QueueSystem.UnblockCorrelation method

  • Article

Unblocks a job correlation in the Project Server Queuing Service.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/UnblockCorrelation", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",  _
    ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Sub UnblockCorrelation ( _
    correlationGUID As Guid _
)
'Usage
Dim instance As QueueSystem
Dim correlationGUID As Guid

instance.UnblockCorrelation(correlationGUID)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/UnblockCorrelation", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", 
    ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public void UnblockCorrelation(
    Guid correlationGUID
)

Parameters

  • correlationGUID
    Type: System.Guid

    GUID of the correlation.

Remarks

If the job state is not CorrelationBlocked, UnblockCorrelation generates a SOAP exception.

UnblockCorrelation sets the state of the blocked job to FailedNotBlocking and sets the other blocked jobs in the correlation from CorrelationBlocked to ReadyForProcessing.

Warning

The Project Server Queuing Service blocks a correlation to prevent corruption of data. Arbitrarily unblocking a correlation can produce undesired results. Use UnblockCorrelation only if you are confident the remaining jobs behind the blocked job can proceed without harm.

A Project Server administrator can use the Manage Queue Jobs page in Project Web App (https://ServerName/ProjectServerName/_layouts/pwa/Admin/queue.aspx) to view and unblock correlated jobs.

Project Server Permissions

Permission

Description

ManageQueue

Allows the user to manage the Project Server queue. Global permission.

See also

Reference

QueueSystem class

QueueSystem members

WebSvcQueueSystem namespace