Create a Connection Contract πŸš€

Connection Contracts define how the producer connects to Data Mover to send files (in the input phase) or the consumer connects with Data Mover to retrieve files (in the output phase). In both scenarios, Data Mover acts as a protocol server.

This contract defines:

  • the actor that sends files to Data Mover or collects them from Data Mover

  • the server

  • the virtual file system (VFS) and its path.

In input, the Connection Contract defines when Data Mover receives files from the producer. The producer, acting as the protocol client, initiates the connection to Data Mover, which acts as the protocol server​. ​

In output, it defines when the consumer connects to Data Mover to retrieve the files. The consumer acts as the protocol client, establishing the connection, while Data Mover remains the protocol server.​

Connection Contracts tab

To create a Connection contract, follow these steps:

  1. Navigate to the Actors section and open the Actor.

  2. Access the Connection contracts tab and click New.

  3. On the New Connection contract page, enter the name of the Connection Contract. This field is mandatory. You can enter up to 128 characters. The name must be unique within the actor.

  4. Optionally, provide a description for the Connection Contract. This text helps identify the purpose or usage of the Contract. The field accepts up to 255 characters.

Server association

To select the server that will be used to access the VFS, follow these steps:

  1. Click SELECT to open the list of available servers. Once a server is assigned to a Connection contract - and therefore linked to an Actor - it is removed from the Select server window. This is because each server can be associated with only one Connection Contract.

triangle-exclamation

Warning!

  1. Click Confirm and the selected server will be displayed with the following information:

  • Server – The name of the selected server.

  • Protocol – The communication protocol used by the server (e.g., HTTPS, SFTP).

  • Cluster – The cluster the server belongs to.

  • Port – The port number used for the connection.

To change the assigned server, click the edit icon on the right.

User/Group association

When you click ADD in the VFS and Users/Groups section, the New User/Group Association window opens. Here you can define how Users and Groups are granted access to the selected VFS.

Access through

Choose how access to the VFS will be granted:

  • Direct assignment: explicitly select the VFS and VFS path to which access will be granted.

  • Provide VFS access through assigned groups: access to the VFS is granted via the Groups the users belong to. Manage access from the Groups tab; users inherit permissions from their assigned groups.

triangle-exclamation

Virtual File System

This section is displayed only when the Direct assignment option is selected in the Access through field.

Here you define which part of the VFS the Users and Groups will be allowed to access.

  • VFS (*): select the VFS you want to grant access to.

  • VFS path (*): select the specific path within the VFS.

Both fields are mandatory.

Users and Groups

Use the Users and Groups tabs to specify which external Users and Groups should be granted access to the selected VFS.

Users Tab

  1. Choose a User from the Select User drop‑down menu.

    • Type at least 3 characters to filter the list.

    • The search is case‑sensitive.

    • Wildcards are not supported.

    • Users must already be created in Actor > Users.

  2. Click ADD to add the User to the association list.

Once added, Users appear in the table at the bottom of the window.

  • The list displays 10 users per page.

  • A navigation bar allows you to search and move between pages: First, Previous, Next, Last.

  • You can run the search even by typing a single character (letter or number).

πŸš€ Upload Limit per User

For the FTP, FTPS, SFTP, HTTP, HTTPS, PR4, PR5, and PESIT protocols, you can configure a custom upload limit for each User.

For each User in the list:

  1. Switch Upload limit to ON to enable the configuration.

  2. Enter the maximum file size.

  3. Select a unit of measurement:

    • KB (default)

    • MB

    • GB

    • TB

circle-info

Note: Upload limits defined for Users override limits defined for Groups.

You can enable or modify upload limits individually for each User directly from this table.

To remove a User from the association list, click the bin icon on the corresponding row.

Groups Tab

The Groups tab works in the same way as the Users tab.

Remember that upload limits defined for Users override limits defined for Groups.

Autosave

All changes in this window are saved automatically in real time.

No additional confirmation is required.

πŸš€ Important (Data Watcher Source/Destination display)

When Provide VFS access through assigned groups is selected and internal users perform uploads/downloads via Connection Contracts, Data Watcher displays, by default, a flow from/to the Company in the Source/Destination column.

To display the VFS owner actor instead of the Company, use the advanced property overrideSourceDestinationWithActor:

  • Set overrideSourceDestinationWithActor = true β†’ the owner of the identified VFS is shown.

  • Not set or set to false β†’ a flow from/to the Company is shown.

The value of this advanced setting is applied immediately - no restart of Data One or Data Watcher is required.

File Processing Rules tab

The New File Processing Rule window allows you to define how incoming or outgoing files should be processed when they match a specified pattern. All required fields must be completed before the rule can be saved.

Once created, File Processing Rules must be associated with a Virtual Path in the relevant Connection Contract. This association determines which files within that path will trigger the rule.

Fill in these fields:

  • Default File Processing Rule (optional): enable this toggle to set the rule as the default rule for the Actor. The default rule is applied to all paths when selected in a Connection Contract, unless another rule matches a more specific file pattern.

  • File processing rule (*): enter the name of the rule. This field is mandatory.

  • Description: optionally enter a description to clarify the context or purpose of the rule.

  • File pattern (*): specify the file name pattern to which the rule applies. For example:

    • *.* β†’ any file (default)

    • *.csv β†’ all CSV files

    • report_*.xml β†’ all XML reports beginning with "report_"

    This field is mandatory.

triangle-exclamation
  • File resources: select one or more File Resources to apply to files that match the pattern. Refer to the File Resources tab section for details on creating and configuring File Resources.

  • Virtual boxes: select one of the available Virtual Boxes or create a new one by clicking the New option. Refer to the Virtual Boxes section for details.

Click SAVE to create the rule.

The new rule will immediately appear in the list of File Processing Rules associated with the Actor.

File Processing Rules list

Already configured File Processing Rules are listed on the page with the following details:

  • Modified: the date and time when the File Processing Rule was last updated. The date is displayed on the first line, and the time on the second line.

  • File Processing Rule: the name of the File Processing Rule.

  • File pattern: the file name pattern that triggers the rule (for example: *.*, *.csv). You can use the File pattern field to filter which files the File Processing Rule applies to, or you can leave the pattern generic. When the pattern is generic (for example *.*), the File Processing Rule is applied to every file within the selected Virtual Path.

  • File resources: the File Resources associated with the rule. Clicking the icon next to a File Resource name opens its details.

  • Virtual Box: the Virtual Boxes linked to the rule. When multiple Virtual Boxes are associated, the first two are shown followed by a +X indicator, displaying how many additional Virtual Boxes are included.

  • Default: indicates whether the rule is marked as the default File Processing Rule (True or False).

Each row also includes the three‑dot menu, which provides options to edit or delete the File Processing Rule.

Results can be sorted in chronological and reverse chronological order by selecting the Modified column header.

File Processing Rules menu options

The 3‑dot icon next to each File Processing Rule provides the following options:

  • Edit: opens the File Processing Rule window so you can modify fields.

  • Delete: permanently deletes the File Processing Rule.

File Processing Rules filters panel

File Processing Rules can be filtered using the Filters panel.

In the Search File Processing Rules field, enter the full file processing rule name or part of it, then press Enter on your keyboard or click Apply.

  • The search field is case‑insensitive.

  • You can run a search even by typing a single character (letter or number).

  • Wildcard characters are not supported.

You can also filter the list to display only default File Processing Rules by enabling the corresponding toggle.

To reset all filters, click Clear all.

Virtual Path Rules tab

File Processing Rules must be associated with a Virtual Path in the Connection Contract. This association determines which files under that Virtual Path will activate the corresponding rule.

To associate a File Processing Rule with a Virtual Path, follow these steps:

  1. In the Virtual Path Rules tab, click New.

  2. In the New Virtual Path rules page, select the VFS and the Virtual Path where the rule will be applied. The Storage Class and the Retention Class of the selected VFS will be applied.

  3. In the Rules section, perform one of the following actions:

    1. Select one or more File Processing Rules and specify their processing direction (INBOUND or OUTBOUND).

    2. Create a new File Processing Rule by selecting New from the drop‑down list. The configuration options for creating a new rule are described in the Define File Processing Rules section.

  4. Click Add and verify that the configuration is correct.

  5. If necessary, adjust the processing direction for a rule. Use the 3-dot icon to modify or remove the File Processing Rule associated with the selected VFS.

  6. Select Save to apply the configuration.

Sample use cases for File Processing Rules

To better describe the usage guidelines for File Processing Rules, these are some sample use cases:

Data Mover receives a file through SFTP and saves it in DATA format File Resource configuration:

  • mime remote = text/plain

  • charset local = 819

  • mime local = text/plain (or null)

  • charset local = 819 (or null)

Data Mover receives and saves a file through PR4 with PGP encrypted File Resource configuration:

  • secure remote = NONE

  • secure local = PGP

Data Mover receives an uncompressed file through PR4, with compressed saving in Data Mover File Resource configuration:

  • compression type remote = null

  • compression type local = SPZIP

Data Mover receives a compressed file through PR4, with compressed save in Data Mover File Resource configuration:

  • compression type remote = SPZIP

  • compression type local = SPZIP

Data Mover has an uncompressed file and sends it compressed through PR4 File Resource configuration:

  • compression type remote = null

  • compression type remote = SPZIP

Last updated