Description

A Configuration File or Config File is a file that helps to merge data created from different Domains (in Segment format) for a selected format. The configuration file defines the following elements of information:

  1. fileNameSegments - contains sub-elements that define how file names are created for each generated nested file.

  2. segmentFiles - contains sub-elements that define the file names of the segment data files to be merged.

  3. elements - contains nested sub-elements that define the format of the output.


This file is required when using a Merge Receiver to generate nested output (e.g., JSONSegmentMergeReceiver, AvroSegmentMergeReceiver). Configuration files can manually be created, and they are also created automatically when using certain Domain import methods (e.g., JSON, XML).  


What Receivers Require this Configuration File? 

Supported configuration types are shown in the image below:


How to Access and View Configuration Files

Configuration files are created and managed from the Configuration Tab within the Management pane for a selected Project Version. 



Option
Description
Create a new configuration file.
Preview a configuration file.
Edit a configuration file.
Remove a configuration file from a selected Project Version.
Arrange elements for the configuration file. You can drag and drop elements into another location within the dialog window.
Download a configuration file to your local machine.
Modify and remove configuration file elements. You can also access the dialog window to arrange segments.
Copy a configuration file. 



How to Create a Configuration File 

We will show how to create a JSON configuration file in this example. Depending on the selected config type (e.g., Avro, Delimited File, Parquet), additional options and screens may appear when creating the configuration file. 

  1. Select New Configuration. 



  2. Select a Config Type and click Select.



  3. Enter a unique Name and a Config File Name (name used in the configName parameter of the Merge Receiver).
  4. Define the Output File Name Format (how each output file will be named)
    • Select an option in the first drop-down menu (e.g., Constant, Counter).
    • Enter the value for that line (e.g., text, number, file extension).
  5. Select the segment by using the drop-down menu. 
    • Use the Add button to add additional lines for segments. 
    • Note: The SegmentDataCreatorReceiver is assigned to each Domain to create the required segment.
  6. Select Save.


    Note: The screen above is different for the XML and SOAP options. Please see one of these pages to view a complete example: 
  7. Add Elements (Avro, JSON, Parquet, ORC, and Swift only). Please note that the image below is for JSON, and this screen varies for other config types. To see format-specific instructions, please see the Merge Receiver documentation.
    • Select a Domain from the drop-down menu.
    • Make the required changes for that Domain (unselect a Tag, modify the Tag Name, etc.). 
    • Select Save and Next to select another Domain and repeat the steps above.
    • Select Save once finished to go to the next step.



  8. Arrange Segments in a hierarchy by dragging/dropping the segments (appears for every config type except XSD). 



Sample Preview of Configuration File



Steps After Creating the Configuration File

  1. Specify the Configuration File Name in each Merge Receiver's configName parameter. This should match the value entered for the Config File Name in the Configuration File. 
     

  2. Download the Configuration file to your local machine using the Cloud icon. Place the file in the path and subdirectory specified in the Merge Receiver (as shown in the above image).