Share via


CReplicationProject Class

Administers Commerce Server Staging (CSS) projects on a server.

Note

If a project includes more than one server, you must create the project on every server in the staging topology.

Methods

Method

Description

AddDestination

Adds a destination to a CSS project.

AddSchedule

Adds a new schedule to a CSS project.

ApplyTransaction

Applies pending transactions to a CSS Web content project.

Cancel

Cancels the replication that is currently running for a CSS project.

CheckAccess

Retrieves the CSS user rights that have been assigned to the current user.

Commit

Commits changes that have been made to a CSS project.

Enum

Retrieves the properties that are assigned to a CSS project.

EnumAccess

Retrieves the user name and CSS user rights for users who are authorized to modify or run a CSS project.

EnumDestination

Retrieves the destinations that are defined for a CSS project.

EnumItems

Retrieves the items that are contained in a source directory for the CSS project.

EnumReplications

Retrieves the replication instances, that is, the deployments that are currently running on a server, for the CSS project.

EnumSchedules

Retrieves the schedules that are defined for the CSS project.

Get

Gets the value of a specified property that is defined for a CSS project.

GetProjectStatus

Gets the status of a replication that was initiated for a CSS project.

GrantAccess

Assigns user or group rights to a CSS project.

Put

Sets the value of a property for a CSS project.

RemoveAccess

Removes the specified user’s or group's rights to a CSS project.

RemoveDestination

Removes a destination that was defined for a CSS project.

Rollback

Reverts the files that were replicated for a Web content project to a previous CSS replication.

Start

Starts the replication of a CSS project.

StartReplicationClient

Invokes a CReplicationClient object for a Web content project.

Properties

Property

Description

BusinessDataProject

Gets or sets a Boolean value that indicates whether the project is used to replicate business data.

BusinessDataProjectXml

Gets or sets the full path of the file that contains the XML configuration for the business data project.

Flags

Gets or sets a bitmask that contains the flag assignments for a CSS project. For more information about these flags, see CSS API Flags.

LocalDirectory

Gets or sets the local directory for the CSS project.

Name

Gets or sets the name of the CSS project.

Remarks

You can access all projects on a server by using the EnumProjects method on the CReplicationServer object.

You can create a new CReplicationProject object by calling the OpenProject method on the CReplicationServer object and using the projectFlag parameter to specify that you want to open a new project.

You can open an existing CReplicationProject object by calling the OpenProject method on the CReplicationServer object and using the projectFlag parameter to specify that you want to open an existing project.

The following table provides additional information about the CReplicationProject class.

Assembly

CSSAPILib

Namespace

Microsoft.CommerceServer.Staging.Interop

Dd442436.alert_note(en-US,CS.90).gifNote:
You must also add a using directive for the System.ServiceProcesses namespace.

Corresponding COM class

ReplicationProject

CLSID

7F1D931C-DEB9-4D07-BCCA-0B78B458B80A

ProgID

CssApi.ReplicationProject

See Also

Other Resources

Commerce Server Staging Reference

Projects

Routes

Schedules

How to Create and Modify a Staging Project

How to Manage Routes

How to Manage Staging Schedules

How to Start and Stop Project Replication

How to Retrieve Project Information

CReplicationServer Class

Commerce Server Staging Reference