Skip to content

Creating and Using Custom Generators and Converters in DATAMIMIC

DATAMIMIC allows you to create custom generators and converters to meet specific data generation needs. This guide explains how to implement a custom generator, use it in your XML configuration, and integrate it with DATAMIMIC. Additionally, we will cover how to use the DATAMIMIC UI to create a Python script file for the custom generator.

Creating a Custom Generator

To create a custom generator, you need to define a Python class that inherits from the Generator parent class. Below is an example of a custom string generator that appends a prefix to a counter value:

1
2
3
4
5
6
7
8
class CustomStringGenerator(Generator):
    def __init__(self, prefix: str = ""):
        self.prefix = prefix
        self.counter = 0

    def generate(self) -> str:
        self.counter += 1
        return f"{self.prefix}{self.counter}"

Creating a Custom Converter

To create a custom converter, you need to define a Python class that inherits from the Converter parent class. Below is an example of a custom converter that converts a string to uppercase:

1
2
3
class CustomConverter(Converter):
    def convert(self, value: str) -> str:
        return value.upper()

Using the Custom Generator and Converter in XML

Once you have defined your custom generator, you can use it in your XML configuration file. Here’s how you can do that:

1
2
3
4
    <generate name="script5" count="50" target="ConsoleExporter">
        <variable name="count" type="integer" generator="IncrementGenerator"/>
        <key name="generatorTest" generator="CustomStringGenerator(prefix=f'nr {count}-')" converter="CustomConverter"/>
    </generate>

Steps to Integrate the Custom Generator and Converter with DATAMIMIC

1. Create the Python Script File

  • Create a Python script file (e.g., custom.py) with the custom generator and\or converter class defined in it.

2. Use the DATAMIMIC UI to Create the Python Script File

  1. Open DATAMIMIC UI:

  2. Navigate to the Scripts section.

  3. Create a New Script:

  4. Click on "Create New Python Script".

  5. Enter the script name (e.g., lib).

  6. Add the Custom Generator Code:

  7. Copy and paste the custom code into the script editor.
  8. Save the script.

3. Update the Start File (datamimic.xml)

Ensure that your custom Python script file is executed in the start file (datamimic.xml) to make the custom generator available in the context. Here is an example of how to include this in the start file:

1
2
3
4
5
6
7
8
9
<setup>
    <include uri="conf/base.properties"/>
    <memstore id="mem"/>

    <!-- Execute the custom script file to make it available in the DATAMIMIC context -->
    <execute uri="script/lib.scr.py"/>

    <include uri="1_generate.xml"/>
</setup>

4. Use the Custom Generator in Your XML Configuration

You can now use the custom generator in your XML configuration file as shown in the previous section.

1
<key name="generatorTest" generator="CustomStringGenerator(prefix=f'nr {count}-')" converter="CustomConverter"/>