|
Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Siebel Analytics Web SOAP API Methods >
ReplicationService
Provides methods for use with catalog replication. Table 48 shows the supported methods.
export Method
Exports catalog changes to a specified log file. Signature
void export (String filename, CatalogItemsFilter filter, bool bExportAll, String sessionID);
|
|
String filename |
The name of the log file. |
CatalogItemsFilter filter |
Defines the subset of changes to be exported. The filter.items field cannot be null. |
bool bExportAll |
When TRUE then the contents of folders specified in filter.items and their descendants are written to the export file as if they were inserted right before that method was called. The filter's to and from date fields are ignored. |
String sessionID |
A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
import Method
Import changes from the log file. Signature
ImportError[] import (String importFilePath, DateTime lastPurgedLog, bool updateReplicationLog, bool returnErrors, CatalogItemsFilter filter, String sessionID);
|
|
String importFilePath |
The path of the log file to import. |
DateTime lastPurgedLog |
The date and time of when the log was last cleaned up. If the change in the export file was made after that time, then import uses local logs to determine if it should be replayed, otherwise it uses the last access time. |
bool updateReplicationLog |
If FALSE then the replication log is not updated. |
bool returnErrors |
If TRUE then the function returns an array of ImportError objects which describes cases when changes recorded in the import file which satisfy filter conditions were not replayed. |
CatalogItemsFilter filter |
Used to filter changes made within a particular time period, and to catalog items in specified folders. Can be null. |
String sessionID |
A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
Returns
Returns an ImportError structure containing the list of errors encountered. For more information, see ImportError Structure. markForReplication
Change the "replicable" flag on a specified folder and its descendants. Signature
void markForReplication (String item, bool replicate, String sessionID);
|
|
String item |
The path of the folder. |
bool replicate |
To mark the folder as replicable, set this to TRUE. To remove the replicable flag, set this to FALSE. |
String sessionID |
A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
purgeLog Method
Clean replication the specified logs. Signature
void purgeLog (String[] items, DateTime timestamp, String sessionID);
|
|
String[] items |
List of folder paths to clean. |
DateTime timestamp |
Cleans only those log items where the last modified time is earlier than the timestamp |
String sessionID |
A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
|
