Skip to main content

3.1. Mass Export

(available when the dfx-mass-export package is installed)

Mass export allows the system to export attached files and group them into folders. Mass export is available in all document registries: the system Documents shortcut, shortcuts of the Documents type, and search results by template.

Only users with the dfx_massexporter role can perform mass export.

To use mass export, open one of the document registries, for example search results, select the button in the upper-right corner, and then select Mass Export.

In the Mass Export window, select the columns that should be used to group documents into folders. You can select up to three columns. Each column contains attributes corresponding to the columns available in the document registry, except attributes of the link and multiple link types.

After configuring the columns, you can enable additional mass export settings by activating the following toggles:

  • Only signed — exports only signed documents;

  • Including related documents — also exports related documents;

    Note:

    If the Including related documents option is enabled, the system exports only the first level of relationships — the parent document and its direct child documents. Only relationships with the Another document refers to this document direction are considered. Other relationship types or deeper relationship levels (second level and beyond) are not included in the mass export.

  • Including signatures — exports signatures in addition to documents;

  • Including images and attachments with signatures — available only after enabling the Including signatures toggle. Allows exporting documents and signatures from the standard Document Attachments attribute.

Mass Export – Columns

After configuring the parameters, select the Export button. The system displays a notification indicating that the export process has started.

Mass Export – Start Notification

After the export is completed, the system displays another notification containing a link to the archive file with the mass export results.

Mass Export – Completion Notification

To download the archive, select the link. To open the link in a new tab, use Ctrl + click.

Note:

Links become available only after configuring the UB_DFX_MASSEXPORT_PATH_EXTERNAL variable in the server parameters. This variable must contain the path to the file storage where the system uploads exported files.

For each document type, you can configure export rules. To do this, in the document type designer select the Document Image attribute and find the Mass Export section in the settings. These rules are applied when mass export is performed with the Including images and attachments with signatures option enabled.

Administrators can modify the notifications displayed by the system when a mass export starts, completes, or fails. To do this, in the Administration workspace, select the Settings folder, and then select System Settings. In the notifications registry, select the required templates.

3.1.1. Export Selected Documents During Mass Export​

In addition to exporting all documents from a shortcut, you can now select only specific documents to include in the mass export.

  1. Open the shortcut of the Documents type 1 from which you want to export selected documents.

  2. In the toolbar, select the icon 2 to enable multiple selection mode.

  3. Select the checkboxes next to the documents 3 that you want to include in the mass export.

  4. In the toolbar, select the icon 1, and then select Mass Export 2.

  5. In the Mass Export window, select the required attachment export settings 1, and then select the Export button 2.

  6. When the export is completed, you will receive a system notification in the upper-right corner of the screen. Select the link in the notification to download the folder with files to your device.

Note:

To optimize system performance, mass export notifications are automatically deleted after a specified period of time. You can change this setting according to your needs.

3.1.2. Delete Mass Export Notification History​

System notifications now contain links to files prepared for download during mass export. You can configure automatic deletion of such notifications after a certain period of time.

To configure the number of days after which notifications are automatically deleted, follow these steps:

  1. In the navigation pane, select the Administration workspace 1.

  2. Select the Settings shortcut group 2, and then select the System Settings shortcut 3.

  3. Select the dfx.massExport.history.days key 4.

  4. In the Value field 1, enter the required number of days after which notifications should be automatically deleted from the system. Then in the toolbar select Save 2.

Note:

By default, notifications are deleted after 5 days.