Builder_Settings Class

[DataContract] Class stores the all the settings used by the builder

Namespace: SobekCM.Core.Settings
Assembly: SobekCM_Core (in SobekCM_Core.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
[SerializableAttribute] [DataContractAttribute] [ProtoContractAttribute] [XmlRootAttribute("builderSettings")] public class Builder_Settings

Inheritance Hierarchy

System..::..Object
SobekCM.Core.Settings..::..Builder_Settings

Constructors

	Name	Description
	Builder_Settings	Constructor for a new instance of the Builder_Settings class

Methods

	Name	Description
	Clear	Clear all these settings
	ShouldSerializeIncomingFolders	Method suppresses XML Serialization of the IncomingFolders collection if it is empty
	ShouldSerializeItemDeleteModulesSettings	Method suppresses XML Serialization of the ItemDeleteModulesSettings collection if it is empty
	ShouldSerializeItemProcessModulesSettings	Method suppresses XML Serialization of the ItemProcessModulesSettings collection if it is empty
	ShouldSerializeOCR_Command_Prompt	Method suppresses XML Serialization of the OCR_Command_Prompt flag property if it is NULL or empty
	ShouldSerializeOverride_Seconds_Between_Polls	Method suppresses XML Serialization of the Override_Seconds_Between_Polls flag property if it is NULL
	ShouldSerializePostProcessModulesSettings	Method suppresses XML Serialization of the PostProcessModulesSettings collection if it is empty
	ShouldSerializePreProcessModulesSettings	Method suppresses XML Serialization of the PreProcessModulesSettings collection if it is empty

Properties

	Name	Description
	Add_PageTurner_ItemViewer	Flag indicates if the page turner should be added automatically
	Complete_Package_Required_Aging	Number of ticks that a complete package must age before being processed
	Convert_Office_Files_To_PDF	Flag indicates if the builder should try to convert office files (Word and Powerpoint) to PDF during load and post-processing
	Ghostscript_Executable	Ghostscript executable file
	IIS_Logs_Directory	IIS web log location (usually a network share) for the builder to read the logs and add the usage statistics to the database
	ImageMagick_Executable	ImageMagick executable file
	IncomingFolders	[DataMember] List of all the incoming folders which should be checked for new resources
	ItemDeleteModulesSettings	[DataMember] List of all the builder modules to use for item deletes (processed by the builder)
	ItemProcessModulesSettings	[DataMember] List of all the builder modules used for new packages or updates (processed by the builder)
	Kakadu_JP2_Create_Command	Kakadu JPEG2000 script will override the specifications used when creating zoomable images
	Log_Expiration_Days	Number of days builder logs remain before the builder will try to delete it
	Main_Builder_Input_Folder	Returns the network location for the main builder, which runs essentially without restrictions
	METS_Only_Package_Required_Aging	Number of ticks that a metadata only package must age before being processed
	OCR_Command_Prompt	Command to launch the OCR engine against a single TIFF to produce a single TEXT file
	Override_Seconds_Between_Polls	Number of seconds between polls, from the configuration file (not the database)
	PostProcessModulesSettings	[DataMember] List of modules to run after doing any additional processing
	PreProcessModulesSettings	[DataMember] List of modules to run before doing any additional processing
	Seconds_Between_Polls	Number of seconds the builder waits between polls
	Send_Usage_Emails	Flag indicates is usage emails should be sent automatically after the stats usage has been calculated and added to the database
	Verbose_Flag	Flag indicates if the builder should be extra verbose in the log files (used for debugging purposes mostly)
	VerifyCheckSum	Flag indicates whether checksums should be verified