Previous Topic: Archive ParameterNext Topic: Connection Parameters


Operation Parameters

These parameters configure the extraction operation. For example, they specify the maximum size for files of extracted data, and the maximum number of events per file. They also specify whether data receipt acknowledgements from the target system are required.

DataIntegrity

Defaults to False. If set to True, this parameter specifies that the archive must supply acknowledgements that it has received extracted events.

BatchSize

Defaults to 0. This parameter specifies the maximum number of events for which XML Metadata is to be extracted in one request. It provides scalability, allowing a large value of MaxRecords without overloading the database resources. This parameter is independent of MaxFileSize.

BulkAcknowledgement

Defaults to True. This parameter specifies whether bulk acknowledgements are required. If set to True, all events extracted at a particular time are acknowledged in bulk. If False, events are acknowledged individually. This parameter can be overridden by the acknowledgement file.

MaxRecords

Defaults to 1000. This defines the maximum number of records (that is, events) that can be extracted in a single operation.

MaxFileSize

Defaults to 0. If this parameter is set to:

RetryPeriod

Defaults to 1440 (equivalent to 24 hours). This defines the period (in minutes) after which extracted events that have not been acknowledged are retried.

StartDate

Defaults to empty. This parameter specifies the ‘event timestamp’ date before which events will not be considered for export. If specified as an integer, it specifies a relative offset in days. For example, a value of -28 indicates a start date of 4 weeks ago.

EndDate

Defaults to empty. This parameter specifies the ‘event timestamp’ date after which events will not be considered for export. If specified as an integer, it specifies a relative offset in days. For example, a value of -7 indicates an end date of 1 week ago.

More information:

Archive Acknowledgements