Grooper.Core.ImportProvider

Import providers enable import of file-based content from a variety of sources such as file systems, mail servers, and content repositories. Import providers can be used in two ways:


Inherits from: Grooper.ConnectedObject

Constructors

Signature Description
New (gdb As GrooperDb)
Parameters
gdb
          Type: GrooperDb
          

Fields

Field Name Field Type Description
ContentTypeId As System.Guid System.Guid
Context As Grooper.Core.ImportProvider+OperationContext Grooper.Core.ImportProvider.OperationContext
Database As Grooper.GrooperDb Grooper.GrooperDb

Properties

Property Name Property Type Description
BatchNamePrefix System.String An optional prefix to be prepended onto each batch name.

Example

Given the date is 01-02-2019 and the time is 1:39:00 PM, entering "Tommy Oliver's AP batch_:_" will result in the batch being named:

"Tommy Oliver's AP batch_:_ 2019-01-02 01:39:00 PM"
ContentType Grooper.Core.ContentType Optionally assign a content type to created batch folders.
FolderLevels System.Collections.Generic.List(Of T) Defines the number of folder levels which will be translated into subfolders within the Grooper Batch.
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
MaxItems System.Int32 Indicates the maximum number of items to process. This can be used with Skip Count to perform incremental imports.
MaxItemsPerBatch System.Int32 The maximum number of items to be imported into a single batch.
Priority System.Int32 The priority of the batch. The Priority value controls the order in which tasks are processed, with the value 1 representing the highest priority level, and the value 5 representing the lowest priority level. (i.e. Items of priority 1 are processed before items of Priority 2, and so on). The batch must be paused before this property can be edited.
Root Grooper.GrooperRoot Returns the root node
SkipCount System.Int32 Indicates the number of items to skip at the beginning of the sequence. Use this property to restart an import which was previously stopped.
SparseImport System.Boolean If true, documents will be imported in sparse mode. Sparse documents avoid duplicating storage in Grooper when the content can be accessed through a link. Sparse imports serve two general purposes:
  • To speed up imports. Afterwards, content can then be loaded in parallel in a Batch Process, using the Execute activity.
  • To avoid duplicating storage in Grooper unnecessarily. All Grooper modules can work with sparse documents in the same way they can work with normal documents.
StartingStep Grooper.Core.BatchProcessStep The step within a batch process where batches will be started.
StartPaused System.Boolean If true, created batches will be started in a paused state.

Methods

Method Name Description
CancelOperation()
CreateNewBatch() Creates a new batch, storing a reference in the class member CurBatch.
CreateOperationContext() As OperationContext
DetermineHasMinimumItemCount(MinimumItems As Int32) As Boolean
Parameters
MinimumItems
          Type: Int32
          
GetFileTypeInfo() As Dictionary(Of String, FileTypeInfo)
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
HasMinimumItemCount(MinimumItems As Int32) As Boolean
Parameters
MinimumItems
          Type: Int32
          
ImportItem(Item As BatchFolder, Size As Int64) Addes the provided Batch Folder to the current Batch.
Parameters
Item
          Type: BatchFolder
          
 
Size
          Type: Int64
          
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
RegisterContentItem(Extension As String, Size As Int64)
Parameters
Extension
          Type: String
          
 
Size
          Type: Int64
          
RegisterContentPart(Extension As String, Size As Int64)
Parameters
Extension
          Type: String
          
 
Size
          Type: Int64
          
RunOperation()
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
StartOperation(ImportBatch As Boolean)
Parameters
ImportBatch
          Type: Boolean
          
ToString() As String Returns a string value representation of the connected object.
ValidateProperties() As ValidationErrorList Validates the properties of the object, returning a list of validation errors.
WriteLogEntry(Message As String, pa() As Object())
Parameters
Message
          Type: String
          
 
pa
          Type: Object