An origin represents a location from which one or more records are imported More...

Inheritance diagram for TRIM.SDK.Origin:

Public Member Functions
	Origin (Database database, TrimURI uri)
	Constructor for a new Origin object, initialising it to be the specified origin type. More...

	Origin (Database database, string name)

	Origin (Database inDatabase, OriginType initializeAsType)

OriginHistory	StartBatch (string itemsSource)
	Indicates a start of a new import batch - returns an OriginHistory object for associating with any imported records in this batch More...

Record	NewRecord (OriginHistory batchIdentifier)
	Initializes a new record object with defaults from this origin. More...

Record	NewRecordEx (RecordType altRecordType, OriginHistory partOfBatch)
	Initializes a new record object with defaults from this origin, specify an alternative record type. More...

void	EndBatch (OriginHistory batchIdentifier, long totalRecordsCreated, long totalRecordsInError)
	Indicates the end of an import batch More...

long	CreateRecord (string recordMetadataXML, string documentToAttach)
	Creates and saves a new record object with defaults from this origin, specify an alternative record type and also pass in an XML string for the additional record properties. More...

void	AllocateContainer (Record forNewRecord)
	Sets the container on the supplied record based on the Origin container allocation policy. More...

void	AllocateContainer (Record forNewRecord, bool crossProcessLock)
	Sets the container on the supplied record based on the Origin container allocation policy. You should set the crossProcessLock to true if this Origin could be being used simultaneously by other processes. More...

void	SetNotes (string newValue, NotesUpdateType TypeOfNotesUpdate)
	Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them. More...

void	SetDocument (string fromFileName)
	Set the document associated with this Trim object as a copy of the supplied file name More...

void	LoadDocumentIntoClientCache ()
	Loads the document associated with this object into the client document cache, if one is available. More...

string	GetDocumentPathInClientCache (Events logAccessAs)
	Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type. More...

string	GetDocumentPathInWGSCache (Events logAccessAs)

ExtractDocument	GetExtractDocument ()

Public Member Functions inherited from TRIM.SDK.TrimMainObject
virtual void	Save ()
	Permanently commits all changes made to this object (and all its child objects). For new objects a new unique identifier will be allocated (Uri). More...

string	MakeReference (string SuggestName)
	Creates a TRIM reference file for this object, given the path and filename. A reference file can be associated with the Open command of various of the TRIM executables - TRIM.exe, TRIMDesktop.exe, etc. When the reference file is double-clicked, the associated application will then launch (or activate if it already running) and the object will then be displayed inside that executable. Returns a string containing the path and filename of the reference file created. More...

virtual void	Delete ()
	Permanently removes this object and all its associated child objects from the database. More...

bool	IsDeleteOk ()
	Determines if this object can be deleted. If it returns false, check the ErrorMessage details for more information. It is possible that the ErrorMessage property could contain a warning message even though the function returns true. More...

bool	Verify (bool failOnWarning)
	Verifies all properties that have been modified since this object was last saved. Returns a Boolean value indicating whether the function succeeded. If false, the error description is stored in the ErrorMessage property. More...

TrimChildObjectList	GetChildObjectList (BaseObjectTypes childType)
	Retrieves the child object collection of the nominated child object type. More...

TrimMainObject	GetNewCopy ()
	Creates a new TrimMainObject which is a copy of this TrimMainObject. Where appropriate, property values are copied from this TrimMainObject to the new TrimMainObject. You will generally need to set any unique properties manually afterwards, prior to committing this new TrimMainObject to the TRIM database with the Save() method. See also the NewCopy function of the derived objects that implement this capability. Will return NULL if this object does not support the Copy function. More...

virtual void	Refresh ()
	Resets this object to the current state on the database, will revert any changes that might have been made. Only required if you are not using BOBnotifications, or need to guarantee a really up-to-date version of the object state. More...

virtual void	Reindex (bool doWordIndex, bool doAdditionalFields, bool doContentEngine)
	Sends an indexing request to the event processor to update main text index on the object, indexes for additional fields or indexes for the content engine. More...

Public Member Functions inherited from TRIM.SDK.TrimObject
bool	IsMandatory (FieldDefinition field)
	Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...

bool	IsValidFor (int purpose)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...

bool	IsValidFor (int purpose, TrimMainObject purposeExtraObject)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...

bool	IsValidFor (int purpose, int purposeExtraEnumValue)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...

bool	HasPermission (GenericPermissions prm)
	Checks to see if the currently logged in user has permission to perform the generic action on this object More...

bool	HasPropertyPermission (GenericPermissions prm, PropertyIds propId)
	Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object More...

Public Member Functions inherited from TRIM.SDK.TrimPropertySet
TrimIcon	GetPropertyIcon (PropertyIds propertyId)
	Gets the icon value associated the a property of this object. More...

TrimMainObject	GetPropertyTrimObject (PropertyIds dnPropId)

string	GetPropertyString (PropertyIds dnPropId)

int	GetPropertyLong (PropertyIds dnPropId)

long	GetPropertyLong64 (PropertyIds dnPropId)

bool	GetPropertyBool (PropertyIds dnPropId)

TrimDateTime	GetPropertyDate (PropertyIds dnPropId)

TrimDecimal	GetPropertyDecimal (PropertyIds dnPropId)

TrimCurrency	GetPropertyCurrency (PropertyIds dnPropId)

TrimURI	GetPropertyUri (PropertyIds dnPropId)

bool	SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)

bool	SetPropertyString (PropertyIds dnPropId, string newValue)

bool	SetPropertyLong (PropertyIds dnPropId, int newValue)

bool	SetPropertyLong64 (PropertyIds dnPropId, long newValue)

bool	SetPropertyBool (PropertyIds dnPropId, bool newValue)

bool	SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)

bool	SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)

bool	SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)

bool	SetPropertyDouble (PropertyIds dnPropId, double newValue)

bool	SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)

bool	ClearProperty (PropertyIds dnPropId)

object	GetProperty (PropertyIds propId)

bool	SetProperty (PropertyIds propId, object newValue)

string	GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
	Gets a string representation of a property value in a format appropriate for a specific use. More...

bool	IsMandatory (PropertyIds propertyId)
	Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...

bool	VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
	Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...

bool	CanModifyProperty (PropertyIds propertyId)
	Indicates whether the current user has the permission to modify the specified property. More...

Properties
bool	AutoStart `[get, set]`
	Gets or sets a boolean variable indicating whether this origin is automatically started when a data load program is started on the machine designated for this origin. More...

bool	ContainerCreation `[get, set]`
	Gets or sets a boolean value indicating whether containers should be created when importing records using this origin. More...

DateIntervalSing	ContainerDateInterval `[get, set]`
	Gets or sets an enumerated value indicating whether the date range for the container should be a day, a week, a month or a year More...

bool	ContainerHasDateRange `[get, set]`
	Gets or sets a boolean parameter indicating whether containers should be allocated based on a date range for contained items. More...

bool	ContainerPerOwner `[get, set]`
	Gets or sets a boolean value indicating whether the origin should allocate a new container based on the Owner Location of the document being added More...

FieldDefinition?	ContainerPerUserField `[get, set]`
	Gets or sets a field Definition object indicating that the origin should allocate a new container based on the value of the specified user defined field More...

int	ContainerSizeThreshold `[get, set]`
	Gets or sets a number which determines the maximum number of contained items for containers used by this Origin More...

string	ContainerTitleTemplate `[get, set]`
	Gets or sets a string value containing a template to be used when constructing the title of the container record if creating containers. More...

RecordType?	ContainerType `[get, set]`
	Gets or sets the record type to use when creating containers for records imported using this origin. More...

TrimDateTime	DateLastLoaded `[get, set]`
	Gets or sets a dateTime value indicating when the last time data was loaded into Content Manager from this origin. More...

TrimDateTime	DateModified `[get]`
	Gets the dateTime representing the date last modified of the configuration file associated with this origin. More...

Location?	DefaultAuthor `[get, set]`
	Gets or sets the default author location to be used when creating records from this origin. More...

Classification?	DefaultClassification `[get, set]`
	Gets or sets the default classification to be used when creating records from this origin. More...

Record?	DefaultContainer `[get, set]`
	Gets or sets the default container to be used when creating records from this origin. More...

Location?	DefaultCreator `[get, set]`
	Gets or sets the default creator location to be used when creating records from this origin. More...

Location?	DefaultHomeLocation `[get, set]`
	Gets or sets the default home location to be used when creating records from this origin. More...

Location?	DefaultOwnerLocation `[get, set]`
	Gets or sets the default owner location to be used when creating records from this origin. More...

RecordType?	DefaultRecordType `[get, set]`
	Gets or sets the default record type to be used when creating records from this origin. More...

Schedule?	DefaultSchedule `[get, set]`
	Gets or sets the default retention scheduleto be used when creating records from this origin. More...

string	Extension `[get]`
	Gets the extension of the configuration file associated with this origin. More...

bool	KeepCheckedOut `[get, set]`
	Gets or sets a boolean property indicating that if a document is added to a record whether the record should remain checked out after the process. More...

LocationMatchType	LocationMatching `[get, set]`
	Gets or sets a LocationMatchType value to indicate how locations are to be imported for this origin. More...

bool	MakeNewRevision `[get, set]`
	Gets or sets a boolean property indicating whether any new document that is added to a record should create a new revision. More...

ElectronicStore?	ManageInPlaceStore `[get, set]`
	Gets or sets the document store to be used for a manage in place origin. More...

new string	Name `[get, set]`
	Gets or sets a string containing the descriptive name of this origin. More...

string	OriginLocation `[get, set]`
	Gets or sets a string containing details of the location of the source documents (e.g. a folder name, a text file name containing metadata, etc.). More...

string	RunsOnMachine `[get, set]`
	Gets or sets a string value indicating the name of the machine that is responsible for running the data import process for this origin. More...

long	Size `[get]`
	Gets the size of the configuration file associated with this origin. More...

ElectronicStore?	Store `[get]`
	Gets the electronic store used to store the configuration file associated with this origin. More...

string	StoreId `[get]`
	Gets the storeId used to store the configuration file associated with this origin. More...

int	TimeFrom `[get, set]`
	Gets or sets an integer containing the number of seconds since midnight indicating when to start processing items in this origin. More...

int	TimeTo `[get, set]`
	Gets or sets an integer containing the number of seconds since midnight indicating when to stop processing items in this origin. More...

OriginType	TypeOfOrigin `[get]`
	Gets an originType enum value indication what type of data source this origin represents. More...

PropertyOrFieldDefList?	RecordInputProperties `[get, set]`
	For an origin of type "text file", the user can specify which properties or fields of a Record are contained in the input data source. More...

PropertyOrFieldDefList?	LocationInputProperties `[get, set]`
	For an origin of type "text file", the user can specify which properties or fields of a Location are contained in the input data source. More...

bool	ExcludeBinaryFiles `[get, set]`
	WindowsFolder type Origin boolean property to flag that binary type files should be excluded from processing. More...

bool	ExcludeHiddenFiles `[get, set]`
	WindowsFolder type Origin boolean property to flag that hidden files should be excluded from processing. More...

bool	ExcludeSystemFiles `[get, set]`
	WindowsFolder type Origin boolean property to flag that system files should be excluded from processing. More...

bool	ExcludeRenditions `[get, set]`
	WindowsFolder type Origin boolean property to flag that rendition type files should be excluded from processing. More...

bool	ExcludeTRIMReferenceFiles `[get, set]`
	WindowsFolder type Origin boolean property to flag that TRIM Reference files should be excluded from processing. More...

string	FilterRegex `[get, set]`
	A Regular expression string used to match files that should not be processed. More...

StringArray?	ExcludeFileList `[get, set]`
	An array of strings that specify specific files that should be excluded from processing. It only makes sense to include files that are contained by the Windows Folder being processed. More...

StringArray?	ExcludeDirectoryList `[get, set]`
	An array of strings that specify specific directories that should be excluded from processing. It only makes sense to include directories that are subdirectories of the Windows Folder being processed. More...

OriginBulkLoaderSettings?	BulkLoaderSettings `[get, set]`
	Gets or sets the set of properties associated with the Bulk Data Loader to be used when importing from this Origin More...

OriginEmailCaptureSettings?	EmailCaptureSettings `[get, set]`
	Gets or sets the set of properties used to determine how the email bulk capture tool should work when using this origin More...

bool	CanModifyExistingNotes `[get]`

bool	CanAddToNotes `[get]`

string	Notes `[get, set]`

TrimAccessControlList?	AccessControlList `[get, set]`

bool	IsDocumentInClientCache `[get]`

string	DocumentPathInClientCache `[get]`

string	DocumentPathInWGSCache `[get]`

Properties inherited from TRIM.SDK.TrimMainObject
TrimDateTime	LastUpdatedOn `[get]`
	Returns the date and time that changes to this object were last committed. More...

Location?	LastUpdatedBy `[get]`
	Returns the user that committed the most recent change to this object. More...

string	Name `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

bool	Verified `[get]`
	Gets a Boolean value indicating whether the object has been verified. That is, whether a call to the 'Verify' method has been made and has succeeded. More...

string	WebURL `[get]`

bool	IsInFavorites `[get]`
	Gets a boolean value indicating whether this object is in the current user's list of favorites More...

string	UpdateComment `[get, set]`
	Gets or sets a string value to be recorded with any audit entries related to the update of this object More...

Properties inherited from TRIM.SDK.TrimObject
BaseObjectTypes	TrimType `[get]`
	Gets a BaseObjectTypes enum value indicating the type of this object. More...

TrimURI	Uri `[get]`
	Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...

string	URN `[get]`
	Gets the uniform resource name for this object. More...

string	NameString `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

string	NameStringExtra `[get]`
	Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...

bool	IsReadOnly `[get]`
	Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...

bool	PossiblyHasSubordinates `[get]`
	Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. More...

Properties inherited from TRIM.SDK.TrimPropertySet
string	ErrorMessage `[get]`
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...

TrimException	Error `[get]`
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Database	Database `[get]`
	Gets the TRIM Database object in which this object resides. All TRIM objects live within a particular TRIM database and cannot be created without one. More...

virtual string	Caption `[get]`
	Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...

virtual TrimIcon	Icon `[get]`
	Gets the icon value associated this TrimPropertySet. More...

bool	IsModified `[get]`
	Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...

Properties inherited from TRIM.SDK.ITrimNotes
bool	CanModifyExistingNotes `[get]`
	Gets a boolean parameter indicating whether the current user can modify the existing notes attached to this object. More...

bool	CanAddToNotes `[get]`
	Gets a boolean value indicating whether the current user can either append or prepend some text to the existing notes. More...

string	Notes `[get, set]`
	Gets or sets a string value corresponding to the notes attached to this object. More...

Properties inherited from TRIM.SDK.ITrimAccessControl
TrimAccessControlList	AccessControlList `[get, set]`
	Gets or sets the access control list attached to this object. More...

Properties inherited from TRIM.SDK.ITrimDocument
bool	IsDocumentInClientCache `[get]`
	Gets a boolean value indicating whether the document associated with this object is currently inside the client document cache. More...

string	DocumentPathInClientCache `[get]`
	Gets a String value representing the path to a copy of the document associated with this object within the client document cache. For records, access is logged as a 'View'. More...

Detailed Description

An origin represents a location from which one or more records are imported

Constructor & Destructor Documentation

◆ Origin() [1/3]

TRIM.SDK.Origin.Origin	(	Database	database,
		TrimURI	uri
	)

Constructor for a new Origin object, initialising it to be the specified origin type.

◆ Origin() [2/3]

TRIM.SDK.Origin.Origin	(	Database	database,
		string	name
	)

◆ Origin() [3/3]

TRIM.SDK.Origin.Origin	(	Database	inDatabase,
		OriginType	initializeAsType
	)

Member Function Documentation

◆ AllocateContainer() [1/2]

void TRIM.SDK.Origin.AllocateContainer ( Record forNewRecord )

Sets the container on the supplied record based on the Origin container allocation policy.

◆ AllocateContainer() [2/2]

void TRIM.SDK.Origin.AllocateContainer	(	Record	forNewRecord,
		bool	crossProcessLock
	)

Sets the container on the supplied record based on the Origin container allocation policy. You should set the crossProcessLock to true if this Origin could be being used simultaneously by other processes.

◆ CreateRecord()

long TRIM.SDK.Origin.CreateRecord	(	string	recordMetadataXML,
		string	documentToAttach
	)

Creates and saves a new record object with defaults from this origin, specify an alternative record type and also pass in an XML string for the additional record properties.

◆ EndBatch()

void TRIM.SDK.Origin.EndBatch	(	OriginHistory	batchIdentifier,
		long	totalRecordsCreated,
		long	totalRecordsInError
	)

Indicates the end of an import batch

◆ GetDocumentPathInClientCache()

string TRIM.SDK.Origin.GetDocumentPathInClientCache ( Events logAccessAs )

Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type.

Implements TRIM.SDK.ITrimDocument.

◆ GetDocumentPathInWGSCache()

string TRIM.SDK.Origin.GetDocumentPathInWGSCache ( Events logAccessAs )

◆ GetExtractDocument()

ExtractDocument TRIM.SDK.Origin.GetExtractDocument ( )

◆ LoadDocumentIntoClientCache()

void TRIM.SDK.Origin.LoadDocumentIntoClientCache ( )

Loads the document associated with this object into the client document cache, if one is available.

Implements TRIM.SDK.ITrimDocument.

◆ NewRecord()

Record TRIM.SDK.Origin.NewRecord ( OriginHistory batchIdentifier )

Initializes a new record object with defaults from this origin.

◆ NewRecordEx()

Record TRIM.SDK.Origin.NewRecordEx	(	RecordType	altRecordType,
		OriginHistory	partOfBatch
	)

Initializes a new record object with defaults from this origin, specify an alternative record type.

◆ SetDocument()

void TRIM.SDK.Origin.SetDocument ( string fromFileName )

Set the document associated with this Trim object as a copy of the supplied file name

Implements TRIM.SDK.ITrimDocument.

◆ SetNotes()

void TRIM.SDK.Origin.SetNotes	(	string	NewNotesText,
		NotesUpdateType	TypeOfNotesUpdate
	)

Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them.

Implements TRIM.SDK.ITrimNotes.

◆ StartBatch()

OriginHistory TRIM.SDK.Origin.StartBatch ( string itemsSource )

Indicates a start of a new import batch - returns an OriginHistory object for associating with any imported records in this batch

Property Documentation

◆ AccessControlList

TrimAccessControlList? TRIM.SDK.Origin.AccessControlList

getset

◆ AutoStart

bool TRIM.SDK.Origin.AutoStart

getset

Gets or sets a boolean variable indicating whether this origin is automatically started when a data load program is started on the machine designated for this origin.

◆ BulkLoaderSettings

OriginBulkLoaderSettings? TRIM.SDK.Origin.BulkLoaderSettings

getset

Gets or sets the set of properties associated with the Bulk Data Loader to be used when importing from this Origin

◆ CanAddToNotes

bool TRIM.SDK.Origin.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.Origin.CanModifyExistingNotes

get

◆ ContainerCreation

bool TRIM.SDK.Origin.ContainerCreation

getset

Gets or sets a boolean value indicating whether containers should be created when importing records using this origin.

◆ ContainerDateInterval

DateIntervalSing TRIM.SDK.Origin.ContainerDateInterval

getset

Gets or sets an enumerated value indicating whether the date range for the container should be a day, a week, a month or a year

◆ ContainerHasDateRange

bool TRIM.SDK.Origin.ContainerHasDateRange

getset

Gets or sets a boolean parameter indicating whether containers should be allocated based on a date range for contained items.

◆ ContainerPerOwner

bool TRIM.SDK.Origin.ContainerPerOwner

getset

Gets or sets a boolean value indicating whether the origin should allocate a new container based on the Owner Location of the document being added

◆ ContainerPerUserField

FieldDefinition? TRIM.SDK.Origin.ContainerPerUserField

getset

Gets or sets a field Definition object indicating that the origin should allocate a new container based on the value of the specified user defined field

◆ ContainerSizeThreshold

int TRIM.SDK.Origin.ContainerSizeThreshold

getset

Gets or sets a number which determines the maximum number of contained items for containers used by this Origin

◆ ContainerTitleTemplate

string TRIM.SDK.Origin.ContainerTitleTemplate

getset

Gets or sets a string value containing a template to be used when constructing the title of the container record if creating containers.

◆ ContainerType

RecordType? TRIM.SDK.Origin.ContainerType

getset

Gets or sets the record type to use when creating containers for records imported using this origin.

◆ DateLastLoaded

TrimDateTime TRIM.SDK.Origin.DateLastLoaded

getset

Gets or sets a dateTime value indicating when the last time data was loaded into Content Manager from this origin.

◆ DateModified

TrimDateTime TRIM.SDK.Origin.DateModified

get

Gets the dateTime representing the date last modified of the configuration file associated with this origin.

◆ DefaultAuthor

Location? TRIM.SDK.Origin.DefaultAuthor

getset

Gets or sets the default author location to be used when creating records from this origin.

◆ DefaultClassification

Classification? TRIM.SDK.Origin.DefaultClassification

getset

Gets or sets the default classification to be used when creating records from this origin.

◆ DefaultContainer

Record? TRIM.SDK.Origin.DefaultContainer

getset

Gets or sets the default container to be used when creating records from this origin.

◆ DefaultCreator

Location? TRIM.SDK.Origin.DefaultCreator

getset

Gets or sets the default creator location to be used when creating records from this origin.

◆ DefaultHomeLocation

Location? TRIM.SDK.Origin.DefaultHomeLocation

getset

Gets or sets the default home location to be used when creating records from this origin.

◆ DefaultOwnerLocation

Location? TRIM.SDK.Origin.DefaultOwnerLocation

getset

Gets or sets the default owner location to be used when creating records from this origin.

◆ DefaultRecordType

RecordType? TRIM.SDK.Origin.DefaultRecordType

getset

Gets or sets the default record type to be used when creating records from this origin.

◆ DefaultSchedule

Schedule? TRIM.SDK.Origin.DefaultSchedule

getset

Gets or sets the default retention scheduleto be used when creating records from this origin.

◆ DocumentPathInClientCache

string TRIM.SDK.Origin.DocumentPathInClientCache

get

◆ DocumentPathInWGSCache

string TRIM.SDK.Origin.DocumentPathInWGSCache

get

◆ EmailCaptureSettings

OriginEmailCaptureSettings? TRIM.SDK.Origin.EmailCaptureSettings

getset

Gets or sets the set of properties used to determine how the email bulk capture tool should work when using this origin

◆ ExcludeBinaryFiles

bool TRIM.SDK.Origin.ExcludeBinaryFiles

getset

WindowsFolder type Origin boolean property to flag that binary type files should be excluded from processing.

◆ ExcludeDirectoryList

StringArray? TRIM.SDK.Origin.ExcludeDirectoryList

getset

An array of strings that specify specific directories that should be excluded from processing. It only makes sense to include directories that are subdirectories of the Windows Folder being processed.

◆ ExcludeFileList

StringArray? TRIM.SDK.Origin.ExcludeFileList

getset

An array of strings that specify specific files that should be excluded from processing. It only makes sense to include files that are contained by the Windows Folder being processed.

◆ ExcludeHiddenFiles

bool TRIM.SDK.Origin.ExcludeHiddenFiles

getset

WindowsFolder type Origin boolean property to flag that hidden files should be excluded from processing.

◆ ExcludeRenditions

bool TRIM.SDK.Origin.ExcludeRenditions

getset

WindowsFolder type Origin boolean property to flag that rendition type files should be excluded from processing.

◆ ExcludeSystemFiles

bool TRIM.SDK.Origin.ExcludeSystemFiles

getset

WindowsFolder type Origin boolean property to flag that system files should be excluded from processing.

◆ ExcludeTRIMReferenceFiles

bool TRIM.SDK.Origin.ExcludeTRIMReferenceFiles

getset

WindowsFolder type Origin boolean property to flag that TRIM Reference files should be excluded from processing.

◆ Extension

string TRIM.SDK.Origin.Extension

get

Gets the extension of the configuration file associated with this origin.

◆ FilterRegex

string TRIM.SDK.Origin.FilterRegex

getset

A Regular expression string used to match files that should not be processed.

◆ IsDocumentInClientCache

bool TRIM.SDK.Origin.IsDocumentInClientCache

get

◆ KeepCheckedOut

bool TRIM.SDK.Origin.KeepCheckedOut

getset

Gets or sets a boolean property indicating that if a document is added to a record whether the record should remain checked out after the process.

◆ LocationInputProperties

PropertyOrFieldDefList? TRIM.SDK.Origin.LocationInputProperties

getset

For an origin of type "text file", the user can specify which properties or fields of a Location are contained in the input data source.

◆ LocationMatching

LocationMatchType TRIM.SDK.Origin.LocationMatching

getset

Gets or sets a LocationMatchType value to indicate how locations are to be imported for this origin.

◆ MakeNewRevision

bool TRIM.SDK.Origin.MakeNewRevision

getset

Gets or sets a boolean property indicating whether any new document that is added to a record should create a new revision.

◆ ManageInPlaceStore

ElectronicStore? TRIM.SDK.Origin.ManageInPlaceStore

getset

Gets or sets the document store to be used for a manage in place origin.

◆ Name

new string TRIM.SDK.Origin.Name

getset

Gets or sets a string containing the descriptive name of this origin.

◆ Notes

string TRIM.SDK.Origin.Notes

getset

◆ OriginLocation

string TRIM.SDK.Origin.OriginLocation

getset

Gets or sets a string containing details of the location of the source documents (e.g. a folder name, a text file name containing metadata, etc.).

◆ RecordInputProperties

PropertyOrFieldDefList? TRIM.SDK.Origin.RecordInputProperties

getset

For an origin of type "text file", the user can specify which properties or fields of a Record are contained in the input data source.

◆ RunsOnMachine

string TRIM.SDK.Origin.RunsOnMachine

getset

Gets or sets a string value indicating the name of the machine that is responsible for running the data import process for this origin.

◆ Size

long TRIM.SDK.Origin.Size

get

Gets the size of the configuration file associated with this origin.

◆ Store

ElectronicStore? TRIM.SDK.Origin.Store

get

Gets the electronic store used to store the configuration file associated with this origin.

◆ StoreId

string TRIM.SDK.Origin.StoreId

get

Gets the storeId used to store the configuration file associated with this origin.

◆ TimeFrom

int TRIM.SDK.Origin.TimeFrom

getset

Gets or sets an integer containing the number of seconds since midnight indicating when to start processing items in this origin.

◆ TimeTo

int TRIM.SDK.Origin.TimeTo

getset

Gets or sets an integer containing the number of seconds since midnight indicating when to stop processing items in this origin.

◆ TypeOfOrigin

OriginType TRIM.SDK.Origin.TypeOfOrigin

get

Gets an originType enum value indication what type of data source this origin represents.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Origin() [1/3]

◆ Origin() [2/3]

◆ Origin() [3/3]

Member Function Documentation

◆ AllocateContainer() [1/2]

◆ AllocateContainer() [2/2]

◆ CreateRecord()

◆ EndBatch()

◆ GetDocumentPathInClientCache()

◆ GetDocumentPathInWGSCache()

◆ GetExtractDocument()

◆ LoadDocumentIntoClientCache()

◆ NewRecord()

◆ NewRecordEx()

◆ SetDocument()

◆ SetNotes()

◆ StartBatch()

Property Documentation

◆ AccessControlList

◆ AutoStart

◆ BulkLoaderSettings

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ ContainerCreation

◆ ContainerDateInterval

◆ ContainerHasDateRange

◆ ContainerPerOwner

◆ ContainerPerUserField

◆ ContainerSizeThreshold

◆ ContainerTitleTemplate

◆ ContainerType

◆ DateLastLoaded

◆ DateModified

◆ DefaultAuthor

◆ DefaultClassification

◆ DefaultContainer

◆ DefaultCreator

◆ DefaultHomeLocation

◆ DefaultOwnerLocation

◆ DefaultRecordType

◆ DefaultSchedule

◆ DocumentPathInClientCache

◆ DocumentPathInWGSCache

◆ EmailCaptureSettings

◆ ExcludeBinaryFiles

◆ ExcludeDirectoryList

◆ ExcludeFileList

◆ ExcludeHiddenFiles

◆ ExcludeRenditions

◆ ExcludeSystemFiles

◆ ExcludeTRIMReferenceFiles

◆ Extension

◆ FilterRegex

◆ IsDocumentInClientCache

◆ KeepCheckedOut

◆ LocationInputProperties

◆ LocationMatching

◆ MakeNewRevision

◆ ManageInPlaceStore

◆ Name

◆ Notes

◆ OriginLocation

◆ RecordInputProperties

◆ RunsOnMachine

◆ Size

◆ Store

◆ StoreId

◆ TimeFrom

◆ TimeTo

◆ TypeOfOrigin