Archive Web Service

  • Article

The Archive class is the primary class in the [Archive Web service] namespace. The Archive class includes methods that manage backup and restore of projects and other Project Server entities.

Note

In the ASMX web service, Archive is a class. In the WCF service, Archive is an interface that is implemented in the ArchiveClient class. For information about using the ArchiveClient class in a WCF-based application, see the Archive class constructor.

The [Archive Web service] namespace is an arbitrary name for a reference to the Archive.asmx web service (or the Archive.svc service) of the PSI in Microsoft Project Server 2010. The Archive class methods support the Daily Schedule Backup, Administrative Backup, and Administrative Restore page links in the Database Administration section of the Server Settings page in Project Web App.

The Archive class methods enable you to read and update the archive schedule. You can archive all projects in the Draft and Published databases. You can save a specified project and version description to the Archive database or delete a project in the Archive database. You can also save to the Archive database, or restore from the Archive to the Published database, the following Project Server entities:

  • Projects

  • Enterprise resource pool and calendars

  • Enterprise custom fields

  • The Enterprise Global data

  • View definitions

  • System settings

  • Security category and group settings

Archive methods typically use or return one of the following objects:

Classes

  Class Description
Public class Archive Includes methods for managing backup and restore operations by using the Archive database in Project Server.
Public class ArchivedProjectsDataSet Used to maintain collections of archived project information.
Public class ArchivedProjectsDataSet.ProjectsDataTable Supplies table management methods and class information including methods, extensions, properties, and fields that are associated with indexing; provides row and column operations for ArchivedProjectsDataSet.ProjectsRow data.
Public class ArchivedProjectsDataSet.ProjectsRow Contains a row of archived project information.
Public class ArchivedProjectsDataSet.ProjectsRowChangeEvent The event that occurs when data in a ProjectsRow is changed.
Public class ArchiveScheduleDataSet Used to maintain collections of archive schedule data.
Public class ArchiveScheduleDataSet.ArchiveScheduleDataTable Supplies table management methods and class information including methods, extensions, properties, and fields that are associated with indexing; provides row and column operations for ArchiveScheduleDataSet.ArchiveScheduleRow data.
Public class ArchiveScheduleDataSet.ArchiveScheduleRow Contains a row of archive schedule information.
Public class ArchiveScheduleDataSet.ArchiveScheduleRowChangeEvent The event that occurs when data in an ArchiveScheduleRow is changed.
Public class ProjectArchiveRetentionDataSet Used to maintain collections of project archive retention information for managing backups and restore operations.
Public class ProjectArchiveRetentionDataSet.ProjectsDataTable Supplies table management methods and class information including methods, extensions, properties, and fields that are associated with indexing; provides row and column operations for ProjectsRowArchiveScheduleRow data.
Public class ProjectArchiveRetentionDataSet.ProjectsRow Contains a row of archived project retention information.
Public class ProjectArchiveRetentionDataSet.ProjectsRowChangeEvent The event that occurs when data in a ProjectsRow is changed.

Delegates

  Delegate Description
Public delegate ArchivedProjectsDataSet.ProjectsRowChangeEventHandler Represents the method that handles events which occur when an action is performed on ProjectArchiveRetentionDataSet.ProjectsRow data.
Public delegate ArchiveScheduleDataSet.ArchiveScheduleRowChangeEventHandler Represents the method that handles events which occur when an action is performed on ArchiveScheduleDataSet.ArchiveScheduleRow data.
Public delegate ProjectArchiveRetentionDataSet.ProjectsRowChangeEventHandler Represents the method that handles events which occur when an action is performed on ProjectArchiveRetentionDataSet.ProjectsRow data.

Enumerations

  Enumeration Description
Public enumeration ArchiveOpcode Specifies the type of object to save to the Archive database.