Skip to main content
Version: 25.x

File Bundles

A file bundle is a named collection of files that can be distributed to agents as part of a workflow. Bundles are used with the Distribute File Bundle built-in step to send files to target systems during workflow execution.

Bundle types​

Every file bundle must be assigned to a bundle type. Bundle types categorise bundles by system type and namespace, controlling which bundles are available for use on which systems.

Create a bundle type​

  1. Choose Automation > File Bundles.
  2. Click Bundle Types.
  3. Click New.
  4. Enter a Name and select a System Type. This is the type of system this bundle can be distributed to. Options are: All, Server, SAP Instance, SAP System, Database, SAP Business Object, or Cloud Service.
  5. Optionally, select a Namespace and Customer.
  6. Click New to save.

Creating a file bundle​

  1. Choose Automation > File Bundles.
  2. Click New.
  3. Enter a Name.
  4. Choose how the bundle's files are managed:
    • File managed by Avantra (ticked by default) — Files are uploaded directly through the Avantra UI and stored on the Avantra server.
    • Externally managed (untick the checkbox) — Files are loaded from a directory on the Avantra server. Enter the path in the External Directory field. The path must match one of the directories configured in Settings > Avantra UI: FileBundleLocations. If no allowed paths are configured, externally managed bundles cannot be created.
  5. Optionally select a Customer.
  6. Select a Bundle Type.
  7. Optionally enter a Description.
  8. Click Create.

Externally managed bundles​

Externally managed bundles load files from a directory on the Avantra server rather than storing them in Avantra directly. To use externally managed bundles, an administrator must first configure the allowed directories in Settings > Avantra UI: FileBundleLocations.

Allowed paths​

The FileBundleLocations setting defines which directories are permitted for use as external bundle sources. Sub-directories of configured paths are also accepted. Separate multiple paths with a semicolon, for example: C:\bundles\sap;C:\bundles\db.

When the setting is empty (the default), no externally managed bundles can be created or opened.

Path validation​

When creating or opening an externally managed bundle, Avantra validates the configured External Directory path against the allowed paths in FileBundleLocations:

  • If the path matches, the bundle opens and its files are listed normally.
  • If the path does not match, the bundle cannot be saved or opened, an error is displayed, and no directory contents are listed.

Bundles created before FileBundleLocations was configured are also subject to this validation when opened.

Managing files in a bundle​

Open a bundle to view and manage its contents. The Files section shows the server path where files are stored, and lists each file with its order, path, upload timestamp, size, and any assigned tags.

Uploading a file​

  1. Open the bundle and go to the Files section.
  2. Click Upload and select the file to upload.

If an uploaded file is not being displayed, click Refresh to update the list.

Assigning tags to a file​

Tags allow the Distribute File Bundle step to selectively send only the files matching specific tags, rather than the entire bundle.

  1. Select a file in the Files section.
  2. Click Tags and assign the required tags. Select an existing tag from the list, or enter a new tag with a unique name.

Reordering files​

Use the arrow buttons in the Files toolbar to change the order of files within the bundle.

Downloading or deleting a file​

Select a file and click Download or Delete as required.

note

Deleting a file from an Avantra-managed bundle removes the file from the Avantra server. Deleting a file from an externally managed bundle only removes it from the bundle record, and the file itself remains in the external directory.

Deleting a bundle​

Select a bundle in the list and click Delete.

  • For Avantra-managed bundles, deletion removes all files from the server and deletes the bundle record. A confirmation prompt lists the bundle contents before proceeding.
  • For externally managed bundles, deletion removes only the bundle record from the database. Files in the external directory are not affected.

Exporting bundles​

Select one or more bundles and click More > Export to download the bundle list as a CSV file.