Primeur Online Docs
Data Mover 1.20
Data Mover 1.20
  • ๐Ÿš€GETTING STARTED
    • What is Primeur Data Mover
    • Main features of Primeur Data Mover
    • Primeur Data Mover deployment
    • Navigate through Primeur Data Mover
  • ๐Ÿ“šINFRASTRUCTURE
    • STENG, clusters and servers
      • Adding a cluster and a STENG
      • Deleting a STENG
    • DMZ Gateways
      • Blocking users automatically at the DMZ level ๐Ÿš€
    • DMZ Clusters
      • Load balancing across active DMZ clusters for outbound file transfers ๐Ÿš€
  • ๐Ÿ‘ฅActors
    • Who are the actors
    • Create your first actor
    • Configure an actor ๐Ÿš€
      • Users Tab
      • Groups Tab
      • VFS Tab
      • File Resource Tab
      • Connection Contract Tab
      • Client Connections Tab
    • Search files by actor
    • Actor Lineage ๐Ÿš€
      • Aggregation of flows by protocol ๐Ÿš€
      • Lineage with connection contracts ๐Ÿš€
      • Lineage with input, mediation and output contracts ๐Ÿš€
      • Lineage with any contract type ๐Ÿš€
  • ๐Ÿ—„๏ธVIRTUAL FILE SYSTEMS
    • Virtual File Systems (VFS) ๐Ÿš€
      • Creating a VFS ๐Ÿš€
      • Configuring a VFS
      • Adding Virtual Paths
      • Modifying and Deleting a VFS
    • Searching files in all VFS
    • Storage Classes ๐Ÿš€
      • Storage Class: SMB v3 or later versions ๐Ÿš€
      • Storage Class: Azure Blob Storage ๐Ÿš€
      • Storage Class: Amazon S3 ๐Ÿš€
      • Storage Class: Google Storage ๐Ÿš€
      • Storage Class: Local File System ๐Ÿš€
    • Retention Classes
  • ๐Ÿ“Contracts
    • What is a contract
    • Create your first contract
      • Create an Input Contract
        • Define the contract info
        • Associate the contract with the actor
        • Define the contract actions
        • Set the contract variables
      • Create a Mediation Contract
      • Create an Output Contract
      • Create a Connection Contract
        • Create a contract clause
        • Associate the VFS with file processing rules
        • File Processing Rules
    • Managing contracts ๐Ÿš€
    • File Resources
      • Creating File Resources
      • Navigating File Resources
      • How to use File Resources
  • ๐ŸงฑWorkflows
    • What is a workflow
    • Create your first workflow template
    • Trigger types
      • Trigger types for input contracts
      • Trigger types for mediation and output contracts
    • Service tasks
      • Standard service tasks
      • Triggerable service tasks ๐Ÿš€
      • Spazio selectors and filebox metadata management
      • Error management
    • Variables
      • Variables in workflows and contracts
      • Handling process variables
    • Workflow templates
      • System workflow templates
        • Workflow templates for input contracts
        • Workflow templates for mediation contracts
        • Workflow templates for output contracts
      • Custom workflow templates
        • Workflow template toolbar
        • Workflow template Shape repository panel
        • Workflow template working area
        • Workflow template BPMN-diagram panel
      • Error workflow templates
    • Editing workflow templates
    • DataFlow Instance Context (DFIC) ๐Ÿš€
  • ๐Ÿ›ธTRANSPORT PROTOCOLS AND CONNECTORS
    • Data Mover client and server roles
    • Client Connections
      • Client Connection: FTP
      • Client Connection: FTPS
      • Client Connection: SFTP
      • Client Connection: HTTP
      • Client Connection: HTTPS
      • Client Connection: PESIT
      • Client Connection: SMB v3 or later versions
      • Client Connection: POP3 or IMAP
      • Client Connection: SMTP
      • Client Connection: PR4/PR4S
      • Client Connection: PR5
      • Client Connection: PR5S
      • Client Connection: HDFS
      • Client Connection: HDFSS
      • Client Connection: Amazon S3 ๐Ÿš€
      • Client Connection: Google Cloud Storage
        • Credentials
      • Client Connection: Azure Blob Storage
      • Client Connection: IBM Sterling Connect:Direct
      • Client Connections retry settings
    • Server Connections ๐Ÿš€
      • Server Connection: FTP
      • Server Connection: FTPS
      • Server Connection: SFTP
      • Server Connection: HTTP
      • Server Connection: HTTPS
      • Server Connection: PeSIT
      • Server Connection: PR4
      • Server Connection: PR5
      • Server Connection: PR5S ๐Ÿš€
      • Server Connection: IBM Sterling Connect:Direct
    • Protocol Connections Reference
    • Stopping all servers in one go
  • ๐Ÿ’ปAPI
    • HTTP MFT Rest API
    • Job Manager APIs ๐Ÿš€
    • SFTP Server sessions APIs ๐Ÿš€
    • Audit Logs APIs ๐Ÿš€
  • ๐Ÿ”“Security
    • Identity and Access Management
    • Users & Groups
      • Setting the password policy
      • Creating Internal Users ๐Ÿš€
      • Creating Internal Groups
      • Creating External Users
      • Creating External Groups
    • Key Stores and Trust Stores
      • Key Store ๐Ÿš€
        • Creating a Key ๐Ÿš€
        • Creating a Certificate ๐Ÿš€
        • Importing a Key or a Certificate
        • Creating a Symmetric key
        • Examples
      • Trust Store ๐Ÿš€
        • Importing Keys ๐Ÿš€
        • Importing Certificates
      • Untrusted Cache ๐Ÿš€
      • Trusting Keys and Certificates
      • PGP Key Store and PGP Trust Store
        • PGP Key Store
        • Importing keys into the PGP Trust Store
    • ICAP
      • Configuring ICAP
      • Defining an ICAP rule
  • ๐ŸŽงFILE EVENT LISTENER
    • What is the File Event Listener
    • Configuring File Event Listeners
      • Setting the File Event Listener Engine
      • Defining a contract for the File Event Listener
      • Setting events to be monitored ๐Ÿš€
    • RegEx Rules ๐Ÿš€
    • Monitoring File Event Listeners
  • ๐Ÿ‘‘FILE MANAGER
    • What is the File Manager
    • Logging into File Manager
    • Managing the File Manager ๐Ÿš€
      • The list of results
      • Creating new folders
      • Uploading files
      • Downloading files ๐Ÿš€
      • Searching for files and folders
      • Deleting files ๐Ÿš€
      • Bulk actions ๐Ÿš€
    • File Manager and VFS
    • Customizing File Manager externals
      • The configuration-wui.json file ๐Ÿš€
      • How to customize the Login window and the logo
      • How to customize the footer
      • How to configure the Upload with Metadata option
      • How to customize bulk actions ๐Ÿš€
  • ๐Ÿง‘โ€โš–๏ธFILE ROUTING
    • What is File Routing ๐Ÿš€
    • Routing Rules
      • The Rules tab
      • The Categories tab
      • The Output tab
    • How to create a rule ๐Ÿš€
      • Add metadata ๐Ÿš€
      • Select ACTIONS
      • Select OUTPUTS
      • Policy for the selection of metadata rules
    • Configuration of the environment in Data One
      • Set up Storage Classes
      • Set up Retention Classes
      • Configure the Actor
      • Set up File Resources
    • Associate the Routing Rule with a Contract
    • Example
  • ๐Ÿ“ฉNOTIFICATION CHANNELS
    • What are Notification Channels
    • Configuring the default Email Notification Channel
    • Configuring a new Email Notification Channel
    • Trusting Certificates
    • Managing Templates
      • Data Watcher Macros
      • Contract Macros
      • ICAP Macros
      • Central Log Macros
      • Email Templates
      • Editing default templates
      • Loading a new template
  • ๐Ÿ’ฌLOGS & AUDIT
    • Logs ๐Ÿš€
      • Logs options ๐Ÿš€
      • Troubleshooting error analysis in Logs
    • Audit Options ๐Ÿš€
      • Export audit logs ๐Ÿš€
      • List of Audit entity types ๐Ÿš€
      • Audit message codes ๐Ÿš€
    • Log Notifiers ๐Ÿš€
      • FEL message codes
  • ๐Ÿ•’MONITORING
    • Jobs
      • Details about Jobs ๐Ÿš€
      • jobman.sh CLI
    • Job Manager
    • Job Queues
      • Managing Job Queues
    • File Transfers
      • Ongoing
      • Finished
      • Reports
    • File Transfers Rules
      • Configuring Rules
  • ๐ŸงHOW TO...
    • ... use different DNS names ๐Ÿš€
    • ... configure a Cron Expression
    • ... configure an application
    • ... customize the header
    • ... run searches in Data Watcher ๐Ÿš€
    • ... use Data Shaper graphs in Data Mover contracts
    • ... modify DMCFG and deploy it
    • ... tune Data One data retention
    • ... fine tune Data Mover
      • Email sender for the Notification Channel
  • ๐Ÿ—’๏ธRELEASE NOTES
    • Data One 1.20.10
    • Data One 1.20.9
    • Data One 1.20.8
    • Data One 1.20.7
      • Data One 1.20.7.1
    • Data One 1.20.6
    • Data One 1.20.5
    • Data One 1.20.4
    • Data One 1.20.3
    • Data One 1.20.2
    • Data One 1.20.1
    • Data One 1.20.0
Powered by GitBook
On this page
  • What you need to know before starting
  • The VFS main page
  • The filters panel
  • The limits panel
  • The toolbar
  • Virtual File Systems and Spazio 2 Protocols PR4 and PR5
  1. VIRTUAL FILE SYSTEMS

Virtual File Systems (VFS) ๐Ÿš€

PreviousLineage with any contract type ๐Ÿš€NextCreating a VFS ๐Ÿš€

Last updated 17 days ago

In PRIMEUR Data Mover, data is displayed in the clear and well-known view of the Virtual File System (VFS). A Virtual Path is a non-physical directory where files are located. Virtual Paths associated with each Virtual File System are the folders where files will transit or will be stored.

What you need to know before starting

Files are structured and made available only to users and groups that have specific authorizations.

PRIMEUR Data One manages Virtual File Systems as attributes (metadata) assigned to files. The relationship between files and Virtual File Systems is one to multi and vice versa: many files can be associated with the same Virtual File System, and a single file can be associated with more than one Virtual File System.

Virtual File Systems belong to specific Actors (Partners, Applications, or Mediators). This association enables to manage the actions of the contracts. All actions are executed by Workflow instances.

Virtual File Systems are used in the Incoming Calls. From the Actor Contractโ€™s point of view, the Incoming Call manages Input and Output Connectors when these actions are performed directly by Actors using Protocol Clients (FTP, SFTP, HTTP, etc.).

An Actor can have 2 VFS named โ€œprimeurโ€ and โ€œPRImeuRโ€. These are 2 different VFS. A VFS can have 2 virtual paths named โ€œvpโ€ and โ€œVPโ€. These are 2 different virtual paths. A virtual path can have 2 files named โ€œfile.txtโ€ and โ€œFile.txtโ€. These are 2 different files. While Unix is case-sensitive, Microsoft Windows and MacOS are case-preserving: they show the different case but โ€œfile.txtโ€ and โ€œFile.txtโ€ collide when located in the same path.

The VFS main page

The VFS home page is in Setup โ†’ Virtual File Systems.

The filters panel

VFS can be searched and filtered according to multiple criteria using the options in the Filters panel:

  • By name: if you are looking for a specific VFS, enter its name in the Search VFS edit box. All VFS matching the name will be listed. If you read what Capt. Eddie said above, you already know that the query is case-sensitive. If you did not read it, this is too bad and if the query returns unconventional results don't tell us we didn't warn you.

  • By type: the All VFS radio button is selected by default and all results are listed but you can also filter results and list only VFS assigned or not assigned to an Actor.

The limits panel

Below the Filters panel, the Limits panel shows the maximum number of folders and nested levels that can be created. Are you wondering why on earth you should use these options? To keep things under control. Setting the maximum number of folders and sub-folders depth that can be created guarantees that the folder structure does not get out of control.

Now comes the fun part. Are you ready? 0 means that there is no limit to the number of folders and nested levels. Isn't this funny? And it's also the default! Click the panel to set new values, which will be applied at a global level: if these are the only values set, they will be applied to any VFS created. The maximum number of nested levels refers to the VFS depth: setting 1, new folders can only be created under the VFS root folder and they will not have sub-folders. Setting 2, new folders created under the VFS root folder can have only one level of sub-folders. And so on. The maximum number of folders refers to the total number of folders in the VFS: setting 10, only 10 folders or sub-folders can be created in the VFS. Now, this is where things get really funny! Let's say you set the maximum number of folders to 10 and the maximum number of nested levels to 0. You can then create 10 folders all under the root or you can create multiple sub-folders of 1 folder created under the root. You can create as many nested levels as you want. The sky's the limit, if the sky is 10 folders obviously! But what if you change the maximum number of nested levels to 2? Here is what happens: you can still create a maximum of 10 folders, but now only one level of nesting is possible. So, no children of sub-folders.

Remember that 0 means that the number of folders and nested levels is unlimited!

The maximum number of folders and the maximum number of nested levels options are available in the Add new Virtual File System window as well. The values set in this window will be applied to the VFS being created or edited, overwriting the values set at a global level.

The toolbar

Virtual File Systems and Spazio 2 Protocols PR4 and PR5

A special convention must be followed when defining Virtual File Systems for Spazio 2 Local PR4 and PR5 Protocol Servers. The Spazio 2 architecture is based on QManager/Queue paradigm and the configuration is done using local configuration files that control access to an existing Queue defined for a particular QManager. In Spazio 2 architecture, files must belong only to the pre-defined set of a Queue. PRIMEUR Data One has a completely open architecture, so a file can belong to any Virtual File System defined. To emulate the QManager/Queue paradigm, the VFS used by a PR4/PR5 local server must be organized as follows:

  • VFS Name = Emulated Spazio 2 Node Name

  • VFS = <QManager Name>/<Queue Name> (repeated for all QManager/Queues defined)

At the top of the list of results, a toolbar is available. If you need an explanation of the options, read the section. When VFS are listed, the system shows the total number of VFS listed together with how many of these are assigned or not to an Actor. This information is available below the SEARCH VFS edit box.

๐Ÿ—„๏ธ
toolbar