node-red-contrib-airship-mapping

Node-RED node for Airship Mapping

Install

From your Node-RED directory: npm install node-red-contrib-airship-mapping

Usage

Select the mapping method from the dropdown, current options:

UDF - Append to contact UDF - Return array only Units - Append to contact Units - Return array only

The UDF options will map only UDFs and Units option will map units. The Append to contact options will append the filtered data on the contact passed (mantory) on msg.payload.contact The Return array only options will return only the array of the filtered data on msg.payload

Send the data as follows:

###UDF mapping

msg.payload.data_map = [
    {
        "name_reference": "My first UDF",
        "id": 1
    },
    {
        "name_reference": "My second UDF",
        "id": 2
    }
]

msg.payload.data_value = [
    {
        "name_reference" : "My first UDF",
        "value" : "Data 1"
    },
    {
        "name_reference": "My second UDF",
        "value": "Data 2"
    }
]

###Unit mapping

msg.payload.data_map = [
    {
        "name_reference": "Test Unit A",
        "id": 1
    },
    {
        "name_reference": "Test Unit B",
        "id": 2
    }
]

msg.payload.data_value = [
    {
        "name_reference" : "Test Unit A"
    },
    {
        "name_reference": "Test Unit B"
    }
]

The unit methods allows to pass a groups object to be added with the unit such as below

msg.payload.data_value = [
    {
        "name_reference" : "Test Unit A",
        "groups" : [
            {
                "name" : "Default"
            }
        ]
    },
    {
        "name_reference": "Test Unit B",
        "groups" : [
            {
                "name" : "Default"
            },
            {
                "name" : "Another group name"
            }
        ]
    }
]

The node will throw an error when the filtered results are empty, if you don't want that to happen just check the: Don't throw error if results are empty option

Outputs

1. Success
2. Error

Examples

Basic examples: (airship_mapping_example.json)