fledge-filter-rename

It is a filter plugin for Fledge which can be used to modify the name of an asset, datapoint or both.

Configuration options

• config item: 'operation', type: 'enumeration', default: 'asset'

  Search and replace operation be performed on asset name, datapoint name or both

• config item: 'find', type: 'string', default: 'assetName'

  A regular expression to match for the given operation

• config item: 'replaceWith', type: 'string', default: 'newAssetName'

  A substitution string to replace the matched text with

• config item: 'enable', type: 'boolean', default: 'false'

  Enable/Disable filter plugin

Examples

• An input of reading object

{
    "readings": {
        "sinusoid": -0.978147601,
        "a": {
            "sinusoid": "2.0"
        }
    },
    "asset": "sinusoid",
    "id": "a1bedea3-8d80-47e8-b256-63370ccfce5b",
    "ts": "2021-06-28 14:03:22.106562+00:00",
    "user_ts": "2021-06-28 14:03:22.106435+00:00"
}

Apply the configuration:

1. Case1

• 'Operation' : 'asset'
• 'Find' : 'sinusoid'
• 'Replace With' : 'sin'
• 'Enabled' : 'True'

Output

{
    "readings": {
        "sinusoid": -0.978147601,
        "a": {
            "sinusoid": 2.0
        }
    },
    "asset": "sin",
    "id": "a1bedea3-8d80-47e8-b256-63370ccfce5b",
    "ts": "2021-06-28 14:03:22.106562+00:00",
    "user_ts": "2021-06-28 14:03:22.106435+00:00"
}

See the asset 'sinusoid' is replaced with 'sin'

2. Case2

• 'Operation' : 'datapoint'
• 'Find' : 'sinusoid'
• 'Replace With' : 'sin'
• 'Enabled' : 'True'

Output

{
    "readings": {
        "sin": -0.978147601,
        "a": {
            "sin": 2.0
        }
    },
    "asset": "sinusoid",
    "id": "a1bedea3-8d80-47e8-b256-63370ccfce5b",
    "ts": "2021-06-28 14:03:22.106562+00:00",
    "user_ts": "2021-06-28 14:03:22.106435+00:00"
}

See the readings datapoint 'sinusoid' is replaced with 'sin' even for the nested elements as well

3. Case3

• 'Operation' : 'both'
• 'Find' : 'sinusoid'
• 'Replace With' : 'sin'
• 'Enabled' : 'True'

Output

{
    "readings": {
        "sin": -0.978147601,
        "a": {
            "sin": 2.0
        }
    },
    "asset": "sin",
    "id": "a1bedea3-8d80-47e8-b256-63370ccfce5b",
    "ts": "2021-06-28 14:03:22.106562+00:00",
    "user_ts": "2021-06-28 14:03:22.106435+00:00"
}

See the asset & readings datapoint 'sinusoid' is replaced with 'sin'

4. Case4 - With regular expression, note that escaping do it by your own

• 'Operation' : 'both'
• 'Find' : '^(.+)$'
• 'Replace With' : 'NEW.\1'
• 'Enabled' : 'True'

Output

{
    "readings": {
        "NEW.sinusoid": -0.978147601,
        "a": {
            "NEW.sinusoid": 2.0
        }
    },
    "asset": "NEW.sinusoid",
    "id": "a1bedea3-8d80-47e8-b256-63370ccfce5b",
    "ts": "2021-06-28 14:03:22.106562+00:00",
    "user_ts": "2021-06-28 14:03:22.106435+00:00"
}

See the asset & readings datapoint 'sinusoid' is replaced with 'New.sinusoid'

5. Case5

• 'Operation' : 'asset'
• 'Find' : '^sin.*'
• 'Replace With' : 'sine'
• 'Ignore Case' : 'False'
• 'Enabled' : 'True'

{
    "readings": {
        "sinusoid": -0.978147601,
        "a": {
            "sinusoid": "2.0"
        }
    },
    "asset": "sine",
    "id": "a1bedea3-8d80-47e8-b256-63370ccfce5b",
    "ts": "2021-06-28 14:03:22.106562+00:00",
    "user_ts": "2021-06-28 14:03:22.106435+00:00"
}

With case insensitive search, see the asset 'sinusoid' is replaced with 'sine'

6. Case6

• 'Operation' : 'both'
• 'Find' : '^Sin.*'
• 'Replace With' : 'sine'
• 'Ignore Case' : 'True'
• 'Enabled' : 'True'

{
    "readings": {
        "sinusoid": -0.978147601,
        "a": {
            "sinusoid": "2.0"
        }
    },
    "asset": "sinusoid",
    "id": "a1bedea3-8d80-47e8-b256-63370ccfce5b",
    "ts": "2021-06-28 14:03:22.106562+00:00",
    "user_ts": "2021-06-28 14:03:22.106435+00:00"
}

With case sensitive search, Nothing to get replaced