IReplicationTarget Interface Ingeniux CMS Content Store API
Represents a destination location to which published content is replicated as well as corresponding settings for this location.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax
Copy
public interface IReplicationTarget : IEntity, 
	IEntityEvents

The IReplicationTarget type exposes the following members.

Properties
  NameDescription
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyDescription
Gets and sets the detailed description of this target.
Public propertyDisabled
Gets and sets whether this target is disabed. Disabled targets cannot perform replications.
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyPostReplicationCommand
Gets and sets the commands that are executed after replication on this target. Use standard Command Prompts (DOS) command syntax.
Public propertyPostReplicationCommandTimeout
Gets and sets the timeout (in seconds) for PostReplicationCommand.
Public propertyPreReplicationCommand
Gets and sets the commands that are executed before replication on this target. Uses standard Command Prompts (DOS) command syntax.
Public propertyPreReplicationCommandTimeout
Gets and sets the timeout (in seconds) for PreReplicationCommand.
Public propertyPublishingTargetDirectory
Gets the full path of the Publishing Target Folder to which this replication target belongs.
Public propertyReplicating
Gets whether this target is currently performing a replication.
Public propertyRepTaskDetails
Gets the details of the last-completed replication.
Public propertyRepTaskMonitor
Gets the Monitor object that tracks an ongoing replication. This object will stick around.
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Public propertyCode exampleType
Gets the full Type name of the target.
Public propertyUseCommands
Gets and sets whether to execute the PreReplicationCommand and PostReplicationCommand.
Top
Methods
  NameDescription
Public methodAddAdditionalLocation
Adds a new Additional Location to this replication target.
Public methodAddCleanupExemption
Adds a new Cleanup Exempt Location to this replication target.
Public methodAddExemptLocation
Adds a new Exempt Location to this replication target.
Public methodAdditionalLocations
Retrieves the collection of Additional Locations for this replication target, in a paginated fashion.
Public methodAdditionalLocationsCount
Gets the count of Additional Locations for this replication target.
Public methodCancelReplication
Cancels an ongoing replication and updates the Task Monitor to the cancelled state.
Public methodCleanReplicate
Performs a replication that removes all Files from the replication destination that no longer exist in the Publishing Target Folder.
Public methodCleanupExemptLocations
Retrieves the collection of Cleanup Exempt Locations for this replication target, in a paginated fashion.
Public methodCleanupExemptLocationsCount
Gets the count of Cleanup Exempt Locations for this replication target.
Public methodClearExemptionAndAdditionalLocations
Removes all Exempt, Additional and Cleanup Exempt locations.
Public methodExemptLocations
Retrieves the collection of Exempt Locations for this Replication Target, in a paginated fashion.
Public methodExemptLocationsCount
Gets the count of Exempt Locations for this replication target.
Public methodReplicate
Performs replication on this target.
Public methodSetExclusiveReplicateItems
Sets the files to be replicated, besides the Additional Locations. Once this method is called, these are the only files from the Publishing Target Folder that will be replicated.
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity.)
Top
Events
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Top
Examples
Serialization example:
Copy
<ReplicationTarget Disabled="false" ID="FileReplicationTarget/21" Type="IGX.Replication.FileReplicationTarget" Name="dss04" Description="" UseCommands="false" TargetLocation="\\it-webcms04.eastern.ewu.edu\external_dss_content" ChangeDetectionOnContent="false" UseImpersonation="true" TargetLocationAccessUserName="s-webcmsrpl" TargetLocationAccessUserDomain="eastern.ewu.edu" TargetLocationAccessPassword="RDNxA5JhNQV8P481I5yuWCGtP6VLLKY99C8ApDQKF62BdHRp987hsgagrOlWrGEJ">
  <PreReplicationCommand Timeout="10">
  </PreReplicationCommand>
  <PostReplicationCommand Timeout="480">E:\igxsites\Sites\external\xml\Custom\media-servers-replication.bat</PostReplicationCommand>
  <ExemptLocations>
    <Exempt RelativePath="/PreBuilt/.svn/" ExemptAllFiles="true" ExemptDescendantDirectories="true" SearchPatterns=""/>
    <Exempt RelativePath="/StyleSheets/.svn/" ExemptAllFiles="true" ExemptDescendantDirectories="true" SearchPatterns=""/>
  </ExemptLocations>
  <AdditionalLocations/>
  <CleanupExemptLocations>
    <CleanupExempt RelativePath="/prebuilt/aspnet_client/" ExemptAllFiles="true" ExemptDescendantDirectories="true" SearchPatterns="" IsFile="false"/>
  </CleanupExemptLocations>
</ReplicationTarget>
See Also

Reference

Ingeniux.CMS Namespace