Worksheet Extract plugin

Identifying worksheets to extract

PolicyCenter calls the buildWorksheetCandidatesQuery method to determine which worksheets to extract.

In PCWorksheetExtractPlugin, this method identifies WorksheetContainer objects attached to a Policy on which all jobs are closed. Closed jobs have a non-null Job.CloseDate. The method ignores WorksheetContainer objects that have already been extracted.

Extracting worksheet data

PolicyCenter calls the extractWorksheets method to extract the worksheet data into a file and flag the worksheet container for purging.

In PCWorksheetExtractPlugin, the worksheet data is extracted to XML and compressed into Gzip format. The format of the file name is:

PolicyNumber_TermNumber_JobNumber_BranchPublicID.gz

Can purge extracted worksheets

PolicyCenter calls the isExtracted method. The method returns a value which indicates whether data has been extracted from a worksheet container.

In PCWorksheetExtractPlugin, this method retrieves the value of the CanPurge Boolean property on the worksheet container. The CanPurge flag is false by default. This flag is true if:

• Data has been extracted
• There is no data to extract

The Purge Worksheet Containers batch process uses the CanPurge flag.