mySobek Home   |   Help
Skip Navigation Links.
MISSING BANNER

Builder_Modules Class



Collection of builder modules to run for an instance of SobekCM / builder


Namespace: SobekCM.Builder_Library.Settings
Assembly: SobekCM_Builder_Library (in SobekCM_Builder_Library.dll) Version: 4.8.7.0 (4.8.7.0)

Syntax

C#
public class Builder_Modules : Builder_Settings

Inheritance Hierarchy

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

Constructors

  NameDescription
Public methodBuilder_Modules
Constructor for a new instance of the Builder_Modules class

Methods

  NameDescription
Public methodBuilder_Modules_From_Settings
Build the modules for the non-folder specific builder modules
Public methodClear
Clear all the settings and the list of modules
(Overrides Builder_Settings..::..Clear()()()().)
Public methodGet_Folder_Module_By_Key
Get a folder module by key, avoiding multiple instances of folder modules from being created
Public methodShouldSerializeIncomingFolders
Method suppresses XML Serialization of the IncomingFolders collection if it is empty
(Inherited from Builder_Settings.)
Public methodShouldSerializeItemDeleteModulesSettings
Method suppresses XML Serialization of the ItemDeleteModulesSettings collection if it is empty
(Inherited from Builder_Settings.)
Public methodShouldSerializeItemProcessModulesSettings
Method suppresses XML Serialization of the ItemProcessModulesSettings collection if it is empty
(Inherited from Builder_Settings.)
Public methodShouldSerializeOCR_Command_Prompt
Method suppresses XML Serialization of the OCR_Command_Prompt flag property if it is NULL or empty
(Inherited from Builder_Settings.)
Public methodShouldSerializeOverride_Seconds_Between_Polls
Method suppresses XML Serialization of the Override_Seconds_Between_Polls flag property if it is NULL
(Inherited from Builder_Settings.)
Public methodShouldSerializePostProcessModulesSettings
Method suppresses XML Serialization of the PostProcessModulesSettings collection if it is empty
(Inherited from Builder_Settings.)
Public methodShouldSerializePreProcessModulesSettings
Method suppresses XML Serialization of the PreProcessModulesSettings collection if it is empty
(Inherited from Builder_Settings.)

Properties

  NameDescription
Public propertyAdd_PageTurner_ItemViewer
Flag indicates if the page turner should be added automatically
(Inherited from Builder_Settings.)
Public propertyAllFolderModules
Get the list of incoming folder module objects to when checking incoming folders for new packages to process
Public propertyComplete_Package_Required_Aging
Number of ticks that a complete package must age before being processed
(Inherited from Builder_Settings.)
Public propertyConvert_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
(Inherited from Builder_Settings.)
Public propertyDeleteItemModules
Get the list of item delete modules objects to use when deleting an object during a SobekCM builder execution
Public propertyGhostscript_Executable
Ghostscript executable file
(Inherited from Builder_Settings.)
Public propertyIIS_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
(Inherited from Builder_Settings.)
Public propertyImageMagick_Executable
ImageMagick executable file
(Inherited from Builder_Settings.)
Public propertyIncomingFolders
[DataMember] List of all the incoming folders which should be checked for new resources
(Inherited from Builder_Settings.)
Public propertyItemDeleteModulesSettings
[DataMember] List of all the builder modules to use for item deletes (processed by the builder)
(Inherited from Builder_Settings.)
Public propertyItemProcessModules
Get the list of item processing module objects to use for processing a new item or update an existing item during a SobekCM builder execution
Public propertyItemProcessModulesSettings
[DataMember] List of all the builder modules used for new packages or updates (processed by the builder)
(Inherited from Builder_Settings.)
Public propertyKakadu_JP2_Create_Command
Kakadu JPEG2000 script will override the specifications used when creating zoomable images
(Inherited from Builder_Settings.)
Public propertyLog_Expiration_Days
Number of days builder logs remain before the builder will try to delete it
(Inherited from Builder_Settings.)
Public propertyMain_Builder_Input_Folder
Returns the network location for the main builder, which runs essentially without restrictions
(Inherited from Builder_Settings.)
Public propertyMETS_Only_Package_Required_Aging
Number of ticks that a metadata only package must age before being processed
(Inherited from Builder_Settings.)
Public propertyOCR_Command_Prompt
Command to launch the OCR engine against a single TIFF to produce a single TEXT file
(Inherited from Builder_Settings.)
Public propertyOverride_Seconds_Between_Polls
Number of seconds between polls, from the configuration file (not the database)
(Inherited from Builder_Settings.)
Public propertyPostProcessModules
Get the list of post-process module objects to use for post-processing during a SobekCM builder execution
Public propertyPostProcessModulesSettings
[DataMember] List of modules to run after doing any additional processing
(Inherited from Builder_Settings.)
Public propertyPreProcessModules
Get the list of pre-process module objects to use for pre-processing during a SobekCM builder execution
Public propertyPreProcessModulesSettings
[DataMember] List of modules to run before doing any additional processing
(Inherited from Builder_Settings.)
Public propertySeconds_Between_Polls
Number of seconds the builder waits between polls
(Inherited from Builder_Settings.)
Public propertySend_Usage_Emails
Flag indicates is usage emails should be sent automatically after the stats usage has been calculated and added to the database
(Inherited from Builder_Settings.)
Public propertyVerbose_Flag
Flag indicates if the builder should be extra verbose in the log files (used for debugging purposes mostly)
(Inherited from Builder_Settings.)
Public propertyVerifyCheckSum
Flag indicates whether checksums should be verified
(Inherited from Builder_Settings.)

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )