Optional Export Package Settings - Document Transfer - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - Standard - external - Standard - Premier

Document Transfer

Document Transfer
Foundation 23.1

You can optionally add the contents of a selected Envelope to the package and adjust the maximum number of documents that is included in a single package. You can also change the auto-name string of the package.


It is a best practice to create an Envelope for each Export Package. This is because documents are only added to the package upon import, re-indexing, or other document change events (such as re-ordering pages). In order to add existing documents that have not changed to the package, you must add them to an Envelope that is configured to be included in the package. Envelopes must be created in the OnBase Client.

To adjust the package settings:

  1. From the Document menu, select Package Transfer | Export Packages. The Export Packages dialog is displayed.
  2. Select the package to configure and click Settings. The Export Package Settings dialog is displayed.
  3. To adjust the maximum number of documents that can be added to a package before a new package is created, change the number in the Maximum Package field under Creation Options. This is the number of documents that is automatically added to the package by the Document Transfer Processor before the package is closed and a new package is created. The default value is 500. If the value is set to 0, the package size is unlimited.

    Documents added to the package in an Envelope do not count against this size limit; only documents added automatically by Document Transfer are limited. Changes to the size limit are applied day-forward; packages created before the updated limit do not respect the adjusted value.

  4. To assign an Envelope to the package, select the Envelope to add from the drop-down list under Creation Options. Documents contained in the selected Envelope are added to the package. Auto-Publishing Envelopes cannot be used with Document Transfer.

    The Document Types contained in the Envelope must match the Document Types configured for the package. The contents of an Envelope are only included in a package if all of the documents in the Envelope belong to Document Types configured to be included in the package. Furthermore, if a package requires a certain Document Type, the Envelope must contain at least one document of that Document Type for the Envelope to be included in the package.

  5. Click Save.
  6. To change the auto-name string for a package, select the package in the Export Packages dialog and click Auto-Name. The Package Auto-Name dialog is displayed.
  7. Enter an autoname string in the Auto-Name String field. This is how the package is referred to in the processing dialogs once it has been staged at the sending site. It is displayed in the Batch Name column of the Document Transfer Processing Console.

    The autoname string of a package is truncated at 200 characters.

    Click the buttons at the right to include system-defined elements in the autoname string of the package.



    Space - Space

    Adds a dash with a space on each side. This element is designed to be used as a separator between the other elements.

    Date Created

    Adds the date the package was created (staged) by the sending site.

    Package Configuration Name

    The Package Name, as set in the Package Configuration dialog when the export package was configured.

    Package Number

    The number assigned to the package by the system when it was created.

    Total Documents

    The number of documents included in the package, which is not necessarily the total number of pages in the package, since some documents may have multiple pages.

    Page Count

    The total number of pages for all of the documents included in the package.

    User Name

    The OnBase User Name of the user who created the package at the sending site.

    Real User Name

    The User's Real Name of the user who created the package at the sending site, as configured in the User Settings dialog.

    Creator Workstation Name

    The machine name of the workstation used to created the export package.


    For quick reference and troubleshooting purposes, it is a best practice to include the Package Configuration Name, Package Number, and Date Created elements in the autoname string. For example, %P - package # %N created %D.

    Click Clear to clear the current contents of the Auto-Name String field.

  8. Click Save.
  9. Click Clear to deselect all packages in the list so you can begin configuring a new package, or click Close to close the Export Packages dialog.

    Packages are sent using the OnBase Client. See the Usage chapter of this manual for sending packages using the OnBase Client.