spMFSynchronizeFilesToMFiles

Signature

EXEC dbo.spMFSynchronizeFilesToMFiles
    @SourceTableName = N'<source>',
    @FileUniqueKeyColumn = N'<key column>',
    @FileNameColumn = N'<name column>',
    @FileDataColumn = N'<data column>',
    @MFTableName = N'MFCustomer',
    @TargetFileUniqueKeycolumnName = N'<MF property name>',
    @BatchSize = 1000,
    @Process_ID = 0,
    @RetainDeletions = 0,
    @IsDocumentCollection = 0,
    @ProcessBatch_ID = NULL OUTPUT,
    @Debug = 0;

Returns

INT: 1 on success; -1 on error.

Parameters

@SourceTableName
  • Type: NVARCHAR(100)

  • Required: Yes

  • Description: Name of source table.

@FileUniqueKeyColumn
  • Type: NVARCHAR(100)

  • Required: Yes

  • Description: Column with unique key to reference file.

@FileNameColumn
  • Type: NVARCHAR(100)

  • Required: Yes

  • Description: Column name for file name.

@FileDataColumn
  • Type: NVARCHAR(100)

  • Required: Yes

  • Description: Column referencing the file content.

@MFTableName
  • Type: NVARCHAR(100)

  • Required: Yes

  • Description: Valid class table name (e.g., ‘MFCustomer’).

@TargetFileUniqueKeycolumnName
  • Type: NVARCHAR(100)

  • Required: Yes

  • Description: Property name of unique key in M-Files.

@BatchSize
  • Type: INT

  • Required: No (default varies)

  • Description: Manage import in batches.

@Process_ID
  • Type: INT

  • Required: No (default = 0)

  • Description: Process id for referencing the objects in the class table.

@RetainDeletions
  • Type: BIT

  • Required: No (default = 0)

  • Description: Set to 1 to retain deletions in the class table.

@IsDocumentCollection
  • Type: BIT

  • Required: No (default = 0)

  • Description: Set to 1 if the class table refers to a document collection.

@ProcessBatch_ID
  • Type: INT

  • Required: No (OUTPUT)

  • Description: Process batch id for logging.

@Debug
  • Type: SMALLINT

  • Required: No (default = 0)

  • Description: Debug level. - 1 = Standard Debug Mode

Purpose

Procedure to synchronize files from a table to M-Files

Examples

Changelog

Date

Author

Description

2019-01-10

LC

Fix bug with file import using GUID as unique ref; improve logging messages

2019-08-30

JC

Added documentation