Get started free
Get started free

Extension Kit for M-Files | Documentation

View Categories

Action: Merge or Undo merge documents

Configuration options when Action is MergeDocuments #

How this action works: Merging two PDF files results in a single PDF file. Merging two Word files produces a single Word file. Merging a PDF file with a Word file results in a PDF file.

If the selected action is MergeDocuments, the following configuration options are available:

Filename Wildcards (placeholderText) #

State Actions > State Action [1] > Action: MergeDocuments > Configuration > Filename Wildcards > PlaceholderText

Filename wildcards are used to select files from the object on which the action will be executed.

The selected file will be used as the source object. If you choose to add another file, it will be merged into this one.

Merged file action #

State Actions > State Action [1] > Action: MergeDocuments > Configuration > Merged file action

Displayed only when Action is MergeDocuments.

Specifies an action that will be executed with the merged file.

  • AddToSourceFile (default): Merging is performed within the existing file on the source object. This means that the defined files are added to the existing file as specified in the merge action.
  • CreateNewFileOnSource: A new file is created, which includes the merged content of all defined files, and added to the source object. Selecting this option opens the Merged file name and Delete original file options.
  • CreateNewObject: A new object is created, containing a new file that includes the merged content of all defined files. Selecting this option opens the New object section and Merged file name and Delete original file options.

Merged file name #

State Actions > State Action [1] > Action: MergeDocuments > Configuration > Merged file action: CreateNewFileOnSource > Merged file name

Displayed only when Action is MergeDocuments and Merged file action is CreateNewFileOnSource.

Specifies the name of the merged file, which can be either a static or dynamic value that references properties from the source.

Delete original file #

State Actions > State Action [1] > Action: MergeDocuments > Configuration > Merged file action: CreateNewFileOnSource > Delete original file

Displayed only when Action is MergeDocuments and Merged file action is CreateNewFileOnSource.

Specifies whether to delete the original file that is going to be merged. Choose one of the options:

  • No (default)
  • Yes

New object #

State Actions > State Action [1] > Action: MergeDocuments > Configuration > Merged file action: CreateNewObject > New object

Displayed only when Action is MergeDocuments and Merged file action is CreateNewObject.

This section allows you to configure the new object that will be created from the merged file. When expanded, you can set the Object type, Class, Name and Properties.

Merge files #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files

Displayed only when Action is MergeDocuments.

  1. Expand Merge files.
  2. Click on Add Merge file.
  3. Expand Merge file [1].

Within this section, you’ll find the following fields by default: Insert location, Delete file on merge, File.

Insert location #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge file [1] > Insert location

Displayed only when Action is MergeDocuments.

Specifies the location in the document where the file(s) will be inserted.

  • Start: File(s) will be added at the beginning of the ‘source’ document.
  • End (default): File(s) will be added at the end of the ‘source’ document.
  • AfterPage: File(s) will be inserted immediately after the selected page. The Page field will be available for specifying the exact page number.

Page #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge file [1] > Insert location: Afterpage> Page

Displayed only when Action is MergeDocuments and Insert Location is Afterpage.

Specifies the page number of the original document after which the file(s) will be inserted. The default page number is 1.

Delete file on merge #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge file [1] > Delete file on merge

Displayed only when Action is MergeDocuments.

Specifies whether the file should be deleted from the object after merging. Choose one of the following options:

  • No (default): The file will not be deleted after merging.
  • Yes: The file will be deleted after merging. If selected, the Delete object on merge field will become available for further configuration.

Delete object on merge #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge file [1] > Delete file on merge: Yes > Delete object on merge

Displayed only when Action is MergeDocuments and Delete file on merge is Yes.

Specifies whether the object should be deleted after the merge. Choose one of the following options:

  • No (default): The object will not be deleted after the merge.
  • Yes: The object will be deleted after the merge.

File #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge file [1] > File

Displayed only when Action is MergeDocuments.

Specifies the file(s) to add to the document. When expanded, the Mode and Filename wildcard fields will become available for further configuration.

Mode #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge file [1] > File > Mode

Displayed only when Action is MergeDocuments.

Specifies the object selection mode.

  • CustomObject: Select any custom object from the vault. If selected, the Custom object and Search timeout (sec) options are available.
  • SourceObject: Select the current source object.
  • Reference: Select any reference of the source object. If selected, the Reference expression field is available.

Filename wildcard #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge files [1] > File > Filename wildcard

Displayed only when Action is MergeDocuments.

Specifies a filename wildcard used to select a file from the object. For example, if the system finds a multi-file document as a source, you can specify which file will be used for merging. Also, a universal wild card pattern * is supported.

Custom object #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge files [1] > File > Mode: CustomObject > Custom object

Displayed only when Action is MergeDocuments and Mode is CustomObject.

When expanded, the Search conditions field is available for setting the conditions to find the custom object.

Search timeout (sec) #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge files [1] > File > Mode: CustomObject > Search timeout (sec)

Displayed only when Action is MergeDocuments and Mode is CustomObject.

Search timeout applied to object search operation, expressed in seconds. The default is 0.

Reference expression #

State Actions > State Action [1] > Action: MergeDocuments> Configuration > Merge files > Merge files [1] > File > Mode: Reference > Reference expression

Displayed only when Action is MergeDocuments and Mode is Reference.

Specifies the property reference expression for files to be merged from related objects. Use this field if the files to be merged are located on related objects. For example: If the source object has a property named Documents that contains the objects with files, the expression should be: {Documents}.

Configuration options when Action is UndoMergeDocuments #

If the selected action is UndoMergeDocuments, the following configuration options are available:

  • Filename Wildcards
  • placeholderText

For details, please click here.