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
  • 👥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 🚀
  • 📝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 🚀
  • 🧱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) 🚀
  • 🔓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 an element
        • When do I use the Keys tab?
        • When do I use the Certificates tab?
      • PGP Key Store / PGP Trust Store
        • Configuring the PGP Key Store
        • Importing keys into the PGP Trust Store
  • 🛸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 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
      • Appendix
    • 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
    • Stopping all servers in one go
  • 🛰️DMZ GATEWAYS
    • DMZ Gateways
    • DMZ Clusters
  • 🎧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
  • 🔍ICAP
    • ICAP Engines
    • Configuring an ICAP Engine
    • Defining an ICAP rule
  • 📚CLUSTERING
    • STENG, Clusters and Servers
    • Adding a cluster and a STENG
    • Deleting a STENG
  • 🕒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
  • 🤓ADMINISTRATION
    • Storage Classes 🚀
      • Storage Class: File System 🚀
      • Storage Class: SMB v3 or later versions 🚀
      • Storage Class: Amazon S3 🚀
      • Storage Class: Google Cloud Storage 🚀
      • Storage Class: Azure Blob Storage 🚀
    • Retention Classes
    • Virtual File Systems (VFS) 🚀
      • Creating a VFS 🚀
      • Configuring a VFS
      • Adding Virtual Paths
      • Modifying and Deleting a VFS
      • Searching files in all VFS
    • File Resources
      • Creating File Resources
      • Navigating File Resources
      • How to use File Resources
    • Advanced Settings
  • 👑FILE MANAGER
    • Getting started
    • 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 page
      • 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
  • 💬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
  • 📩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
  • 🟣DATA MOVER + DATA WATCHER
    • Data Mover in a bundle with Data Watcher
    • Attributes 🚀
    • Cut-off Board
      • Cut-off Calendars
    • Dataflow Inquiry
  • 🟠DATA MOVER + DATA SHAPER
    • Data Mover in a bundle with Data Shaper
    • Monitoring
    • Execution History
    • Sandboxes
  • 💻API
    • HTTP MFT Rest API
    • Job Manager APIs 🚀
    • SFTP Server sessions APIs 🚀
    • Audit Logs APIs 🚀
  • 🧐HOW TO...
    • ... use different DNS names - NEW! 🚀
    • ... configure a Cron Expression
    • ... configure an Application
    • ... customize a header
    • ... run searches in Data Watcher 🚀
    • ... use Data Shaper graphs in Data Mover contracts
    • ... modify DMCFG and deploy it
    • ... tune Data One data retention
  • 🗒️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
  1. MONITORING
  2. File Transfers Rules

Configuring Rules

PreviousFile Transfers RulesNextStorage Classes 🚀

Last updated 11 days ago

To create a new Rule, click the New Rule button at the top right-hand corner. The New Rule dialog window will appear.

Depending on your needs, in this window you can:

  • Use one of the 4 templates already configured

  • Create a new rule from scratch

On the left of the window, 4 configured Rule Templates are listed:

As you can see in the figure above, 2 templates define rules to limit the Jobs executed in parallel and 2 templates assign priorities to the Jobs to be executed. In other words, there are 2 templates of “limit” type and 2 templates of “priority” type.

To see the attributes defined for each Template, simply click the template name on the list. Its values will be loaded on the right. As you can see in the figure above, the second template is of limit type, it has 100 maximum parallel transfers in output, for protocol PR4 and the rule is applied to a specific Actor.

Once you have identified the template that best suits your needs, click the Use button at the top right-hand corner to proceed with its configuration. The New Rule dialog window will appear, loading the attributes defined for the template and allowing you to add the attributes you need to further customize your Rule.

To customize your Rule, assign it a name in the New rule field.

Then, you can set the limit of concurrent transfers in the TO edit box – in the figure above, the limit is set to 100. If you are creating a priority-type Rule, in this field you will assign the priority to the Jobs to be executed.

Now you can select the conditions in the drop-down lists on the left and the attribute on the right.

Note: The Direction, Data One Role, and Cluster Name attributes are mandatory and cannot be deleted.

This is the list of the existing attributes and their relevant description:

Attribute
Description

LIMIT (*) or PRIORITY (*)

The Rule sets the maximum number of parallel transfers allowed or The Rule assigns a priority to the Job executed

TO

Limit-type Rule: enter the maximum number of parallel transfers Priority-type Rule: enter the priority of the Job. The higher the number, the higher the priority

DIRECTION (*)

Direction of the transfer: Input or Output

DATA ONE ROLE (*)

PRIMEUR Data One can be a Client or a Server

CLUSTER NAME (*)

Select one of the configured Clusters

SOURCE

DESTINATION

PROTOCOL

Select the Transfer Protocol to which the Rule will be applied

SERVER

Choose the Server configured on the selected peer

PARTNER

Select the Partner to which the Rule will be applied

DESCRIPTION

Define a Description for the Rule

PEER NAME

Select the endpoint Peer Name for the Rule

If you prefer to create a new rule without using a template, click the CREATE YOUR RULE button in the New Rule window.

The same window shown for the template-created Rule will appear without loading any value in the attributes fields. The same options and attributes as for the pre-configured Rules apply, so refer to the section above for details.

Once you have defined the attributes for your Rule – either based on a Template or not – click the Save button. Your Rule will be added to the Home Page where the standard search, visualization, sorting, editing, and deleting options are available.

To fill in this field, keep the values entered in the Client Connection Tab close at hand. Refer to Configuring an Actor > for details. The content of the Source field depends on the Protocol and other attributes. For PR4, PR5 and PR5S Protocols: - when DIRECTION is set to Input, the SOURCE is the value entered in the QMANAGER NAME field when creating the client connection. - when DIRECTION is set to Output, the SOURCE is the value entered in the LOCAL QM field when creating the client connection. For all protocols different from PR4, PR5 and PR5S: - when ROLE is set to SERVER, the SOURCE is the name of the Actor. - when ROLE is set to CLIENT, the SOURCE is not needed.

To fill in this field, keep the values entered in the Client Connection Tab close at hand. Refer to Configuring an Actor → for details. The content of the Destination field depends on the Protocol and other attributes. For PR4, PR5 and PR5S Protocols: - when DIRECTION is set to Input, the DESTINATION is the value entered in the LOCAL QM field when creating the client connection. - when DIRECTION is set to Output, the DESTINATION is the value entered in the QMANAGER NAME field when creating the client connection. For all protocols different from PR4, PR5 and PR5S: - when ROLE is set to CLIENT, the DESTINATION is the name of the Client Connection - when ROLE is set to SERVER, the DESTINATION is not needed.

On the right of the value, the buttons allow you to add a new Attribute and remove it from the list. On the right of the window, use the WHEN section to define the time interval when the Rule will be applied. As you can see, you can define multiple time slots by simply clicking the option. Leave this field empty to have the Rule enabled all day long. To remove a Time slot, click the icon.

🕒
Client Connection Tab
Client Connection Tab