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
  • Modifying DMCFG
  • Altering an existing parameter value
  • Injecting a new parameter into Extended Configuration
  • Deploying a modified DMCFG
  1. HOW TO...

... modify DMCFG and deploy it

Previous... use Data Shaper graphs in Data Mover contractsNext... tune Data One data retention

Last updated 11 days ago

Modifying DMCFG

DMCFG (read for details) is a YAML file located on the Data One Control Node in <DOIM_HOME>/config/dmcfg.yaml.

You may need to modify it for two reasons:

  1. To alter an existing variable value.

  2. To inject a new configuration parameter into the Extended Configuration section.

Before starting, read this section about the YAML syntax carefully

DMCFG is a YAML file. YAML is a formal language. When editing a YAML file with an editor that does not provide YAML syntax checking, you must be aware of these typical mistakes:

  • Improper Indentation

    • YAML uses indentation to represent the structure of the data. Inconsistent indentation can lead to errors in parsing the data.

    • Indentation in dmcfg.yaml is done with two space characters!

  • Mixing Tabs and Spaces

  • YAML does NOT allow mixing of tabs and spaces for indentation.

    • Indentation in dmcfg.yaml is done with two space characters. NEVER use tabs in this file!

  • Incorrect use of Colons

    • YAML uses colons to separate keys from their corresponding values.

  • Misspelled Keywords

    • YAML has a set of predefined keywords, such as "true", "false", "null", etc.

  • Missing or Extra Commas

    • YAML uses commas to separate items in a list or key-value pairs.

  • Improper Quoting

    • YAML allows strings to be quoted or unquoted. It is important to use quotes appropriately

Altering an existing parameter value

In order to alter an existing parameter, simply edit DMCFG and change its value, then proceed to deploy the change as described at the end of this topic page.

Not all existing parameters can be modified after the initial installation. Change only those that are explicitly mentioned as modifiable in the product documentation.

Injecting a new parameter into Extended Configuration

The DMCFG YAML document generated by the installation process also contains an empty Extended Configuration section named ext_cfg.

############################################################################
#
#                   Extended configuration (optional)
#
ext_cfg:

This section is meant to receive additional tuning directives and special configurations. These settings will be manually added to DMCFG after the initial configuration.

Each injected setting is a name value pair as the one shown below:

############################################################################
#
#                   Extended configuration (optional)
#
ext_cfg:
  my_new_key_name: my_new_key_value
  my_other_new_key_name: my_other_new_key_value

Product documentation and/or Primeur technical support agents will direct you to specific settings for specific purposes.

Deploying a modified DMCFG

Once you are satisfied with your changes to dmcfg.yaml, you can proceed to deploy those changes on the affected managed nodes by running the doim.sh domain-deploycfg command.

This command will analyze the changes, determine which managed nodes are affected, and deploy the changes to them.

Actual changes will become effective after Data One is stopped and started again on each affected node.

You can find more information in the YAML reference resources: .

🧐
YAML Ain’t Markup Language
Domain Master Configuration Reference