ResourcesAccessCompleted Method

  • Article

Description

The PDS notifies Microsoft Office Project Server 2003 that the user no longer requires access to the specified resources. ResourcesAccessCompleted supports both Enterprise Resource Outline Code (EROC) values and Enterprise Resource Multi-Value (ERMV) codes.

Syntax

<Request>
   <ResourcesAccessCompleted>
      <SPID></SPID>
      <ProjectID></ProjectID>
      <ProjectName></ProjectName>
      <Resource>
         <ResourceUID></ResourceUID>
         <ResourceName></ResourceName>
      </Resource>
      <Mode></Mode>
      <RBS></RBS>
      <IncludeParent></IncludeParent>
      <OutlineCodeValues>
         <OutlineCodeValue>    <!--For standard EROC values -->
            <UID></UID>
            <Value></Value>
         </OutlineCodeValue>
         <OutlineCodeValue>    <!-- For ERMV codes -->
            <UID></UID>            <Values>               <ValueUID></ValueUID>               <Value></Value>            </Values>         </OutlineCodeValue>
      </OutlineCodeValues>
   </ResourcesAccessCompleted>
</Request>

Parameters

SPID

Required. The SQL Process ID.

ProjectID

Optional. Completes access for the resources for the specified project ID.

ProjectName

Optional. Completes access for the resources for the specified project name. ProjectName is the project name as stored in the PROJ_NAME field of the MSP_PROJECTS table (the concatenation of the project identifier and the version name, separated by a period).

ResourceUID

Optional. Completes access for the specified resource ID.

ResourceName

Optional. Completes access for the specified resource name.

Mode

Optional. The default for the Mode parameter is 0. There is only one mode valid for the entire method call, even if multiple resources or resource sets are specified. If multiple modes are required, the client must call ResourcesAccessCompleted multiple times. Valid values for Mode are as follows:

Value Description
0 Read-only access (default)
1 Read/write access
5 Read access + auto checkin
6 Read/write access + auto checkin

The resource must already be checked out in order to specify a Mode value of 1.

RBS

Optional. Filters the list based on the RBS level of the resource. If specified, the PDS returns resources below the specified RBS level. If RBS is specified, IncludeParent can also be specified.

IncludeParent

Optional. If IncludeParent is specified without RBS, the PDS returns an error. IncludeParent defaults to 0, and has valid values of 0 or 1. If IncludeParent is 1, the returned set of resources includes all resources at or below the specified RBS level.

OutlineCodeValues

Optional. Filters the list based on outline codes. Contains an XML structure of one or more pair of data corresponding to the outline code value of the Enterprise Resource Outline Code field. If more than one pair is included, the filter combines the values as if they were in an AND statement.

Return Value

If all requested resources are successful, the method returns only a successful HRESULT and STATUS. However, if one of the requested resources fails, they all fail, and the return value includes each resource that failed and an error code.

<Reply>
   <HRESULT></HRESULT>
   <STATUS></STATUS>
   <UserName></UserName>
</Reply>

Remarks

Request and reply elements that are new or changed since Microsoft Project 2002 are shown in bold.

The PDS deletes the row or rows in the Resource Security table for each requested resource based on the SPID. If a valid SPID is passed in, then all entries corresponding to that SPID will be deleted in the resource security table, regardless of the remaining parameters. See The PDS and Project Server Security Architecture for more information about how Project Professional uses ResourcesAccessCompleted.

If the mode is 5 or 6, the PDS does the following:

  • Marks the resource as checked in.

  • If ProjectID or ProjectName is specified, clears access to all enterprise resources in that particular project.

  • After the check-in is complete, starts the process that populates the resource availability tables for each checked-in resource.

The only required parameter is the SPID. The PDS processes the optional parameters ProjectID, ProjectName, ResourceUID, and ResourceName according to the following rules:

  • If ProjectID is specified, the other three parameters (ProjectName, ResourceUID, and ResourceName) are ignored (even if present).

  • If ProjectName is specified, the remaining two parameters (ResourceUID and ResourceName) are ignored.

  • If ResourceUID is specified, ResourceName is ignored.